AdWords API

AdWords API
Feedback on this document

Template Ads

This appendix lists the Display Ad Builder templates you can use to create ads using AdGroupAdService and the TemplateAd data type. Each of the listings below provides the template's ID, available dimensions, required template elements, and each element's required fields. Color fields must use #rrggbb format, and font fields are restricted to the list of supported fonts.

  1. name
    1. App promotion ad
    2. Click to Play Video
    3. Expandable Video V1
    4. In-Stream Video ad
    5. InVideo static image
    6. TrueView in-display
    7. TrueView in-search ad
    8. YouTube Promoted Videos Template
  1. category
    1. expandable (1)
      1. Expandable Video V1
    2. specialized (1)
      1. Expandable Video V1
    3. video (7)
      1. Click to Play Video
      2. Expandable Video V1
      3. In-Stream Video ad
      4. InVideo static image
      5. TrueView in-display
      6. TrueView in-search ad
      7. YouTube Promoted Videos Template
  2. format
    1. flash (3)
      1. Click to Play Video
      2. Expandable Video V1
      3. InVideo static image
    2. text (4)
      1. App promotion ad
      2. TrueView in-display
      3. TrueView in-search ad
      4. YouTube Promoted Videos Template
    3. video (1)
      1. In-Stream Video ad
  3. interaction
    1. mouseover (2)
      1. Click to Play Video
      2. Expandable Video V1
    2. percentPlayed (4)
      1. Click to Play Video
      2. Expandable Video V1
      3. In-Stream Video ad
      4. InVideo static image
    3. play (1)
      1. Click to Play Video
    4. viewDetail (2)
      1. Click to Play Video
      2. Expandable Video V1
  4. size
    1. 120x600 (1)
      1. Expandable Video V1
    2. 160x600 (1)
      1. Expandable Video V1
    3. 300x250 (2)
      1. Click to Play Video
      2. Expandable Video V1
    4. 336x280 (2)
      1. Click to Play Video
      2. Expandable Video V1
    5. 468x60 (1)
      1. Expandable Video V1
    6. 480x70 (1)
      1. InVideo static image
    7. 728x90 (1)
      1. Expandable Video V1
  5. urlType
    1. COMPLETE_BEACON_URL (3)
      1. TrueView in-display
      2. TrueView in-search ad
      3. YouTube Promoted Videos Template
    2. ENGAGED_VIEW_BEACON_URL (3)
      1. TrueView in-display
      2. TrueView in-search ad
      3. YouTube Promoted Videos Template
    3. FIRST_QUARTILE_BEACON_URL (3)
      1. TrueView in-display
      2. TrueView in-search ad
      3. YouTube Promoted Videos Template
    4. IMPRESSION_BEACON_URL (3)
      1. TrueView in-display
      2. TrueView in-search ad
      3. YouTube Promoted Videos Template
    5. MIDPOINT_BEACON_URL (3)
      1. TrueView in-display
      2. TrueView in-search ad
      3. YouTube Promoted Videos Template
    6. THIRD_QUARTILE_BEACON_URL (3)
      1. TrueView in-display
      2. TrueView in-search ad
      3. YouTube Promoted Videos Template
    7. VAST2_TRACKING_XML_URL (1)
      1. In-Stream Video ad

App promotion ad

Show your app icon alongside ad text to encourage downloads.

templateId 353
templateElements
uniqueName adData
fields
name type Description
App platform
appStore ENUM
1, 2
  • : Select an app platform (default)
  • 1: iOS
  • 2: Android
App Id
appId TEXT
Headline and description
headline TEXT
description1 TEXT
description2 TEXT
App image icons
appIconStandard IMAGE
50KB max
jpg, png
 Standard app image icon from the Android Market or App Store or uploaded by app promoters
appIconHighRes IMAGE
500KB max
jpg, png
 High resolution app image icon from the Android Market or App Store or uploaded by app promoters
screenshots IMAGE
50KB max
jpg, png
 App screenshots from the Android Market or App Store or uploaded by app promoters
App name
appName TEXT
Promotion Text
creativeText TEXT
Price Information
price TEXT
currency TEXT
Star Rating
rating NUMBER
Review Snippet
reviewSnippet TEXT
Developer Information
devName TEXT
App Description
appDesc TEXT

Back to top

Click to Play Video

Use this template to create a click to play video creative.

templateId 9
dimensions
  • 300x250
  • 336x280
templateElements
uniqueName adData
fields
name type Description
Starting Image
startImage
Required
 IMAGE
336x255 max
50KB max
jpg, png, gif
 This image will be displayed before the video plays.
Ending Image
endImage IMAGE
336x255 max
50KB max
jpg, png, gif
 This image will be displayed after the video ends. If no image is provided, the starting image will be used.
Video
video
Required
 VIDEO This video will play when the starting image is clicked.

Back to top

Expandable Video V1

templateId 247
dimensions
  • 120x600
  • 160x600
  • 300x250
  • 336x280
  • 468x60
  • 728x90
templateElements
uniqueName adData
fields
name type Description
Poster Image
poster
Required
 BACKGROUND_IMAGE
200KB max
jpg, png, gif
Note: the Play Button will click to start the video after it is saved and deployed.
Play Button
playBtn IMAGE
140x112 max
50KB max
jpg, png, gif
Video
video
Required
 VIDEO

Back to top

In-Stream Video ad

Non-skippable 15 or 30 second video ad within video publisher content.

templateId 49
templateElements
uniqueName adData
fields
name type Description
Video
video
Required
 VIDEO This video ad will appear inside a video player, within video content on Display Network sites. Standard video ad slot play lengths are 15 and 30 seconds long, so your videos should be shorter in playing time than 15 or 30 seconds, respectively.
Companion Banner
companionBanner IMAGE
50KB max
jpg, png, gif, swf
 This is a banner image size of 300x60 (YouTube) and 300x250 (other video sites). It may appear with your video ad where publishers allow companion banner images.

Back to top

InVideo static image

Place an invideo image overlay with an image companion on YouTube and sites in the Google Video Network.

templateId 178
dimensions
  • 480x70
templateElements
uniqueName adData
fields
name type Description
InVideo Overlay
teaserImage
Required
 IMAGE
480x70 max
50KB max
jpg, png, gif
 This will render as a banner ad overlaid on the bottom of the video.
Optional Instream Video
video VIDEO This is an optional video that will play when the invideo overlay is clicked. The optional video will play inside the player where the video is showing.
Companion Banner
companionBanner250 IMAGE
300x250 max
50KB max
jpg, png, gif, swf
 This is a 300x250 banner image. It may accompany your video ad on sites that allow companion banner images of this size to appear with videos.

Back to top

TrueView in-display

Use this template to promote your YouTube videos on YouTube content pages (non-search) and the Google Display Network. Currently available in select countries.

templateId 232
templateElements
uniqueName adData
fields
name type Description
Deprecation callout
Availablity message
Call to action callout
YouTube Video
videoId
Required
 VIDEO Select the video you want to promote.
Video Thumbnail
videoThumbnail ENUM
0, 1, 2, 3
 Choose which video thumbnail you want to appear with the ad. This is an alternate means to select the image url.
  • 0: Default (default)
  • 1: Thumbnail 1
  • 2: Thumbnail 2
  • 3: Thumbnail 3
Destination Page
destinationPage ENUM
1, 2
 Your ad can take users either to a standard YouTube video watch page or to your YouTube channel page to view the selected video.
  • 1: Play on watch page (default)
  • 2: Play on channel page
Optimization callout
Advanced Fields

Back to top

Use this template to promote your YouTube videos on YouTube Search.

templateId 231
templateElements
uniqueName adData
fields
name type Description
Deprecation callout
Availablity message
Call to action callout
YouTube Video
videoId
Required
 VIDEO Select the video you want to promote.
Video Thumbnail
videoThumbnail ENUM
0, 1, 2, 3
 Choose which video thumbnail you want to appear with the ad. This is an alternate means to select the image url.
  • 0: Default (default)
  • 1: Thumbnail 1
  • 2: Thumbnail 2
  • 3: Thumbnail 3
Destination Page
destinationPage ENUM
1, 2
 Your ad can take users either to a standard YouTube video watch page or to your YouTube channel page to view the selected video.
  • 1: Play on watch page (default)
  • 2: Play on channel page
Optimization callout
Advanced Fields

Back to top

YouTube Promoted Videos Template

Note: This template is going away soon and will be replaced by TrueView in-search and in-display. Click for more information.

templateId 13
templateElements
uniqueName adData
fields
name type Description
Deprecation callout
Availablity message
Call to action callout
YouTube Video
videoId
Required
 VIDEO Select the video you want to promote.
Video Thumbnail
videoThumbnail ENUM
0, 1, 2, 3
 Choose which video thumbnail you want to appear with the ad. This is an alternate means to select the image url.
  • 0: Default (default)
  • 1: Thumbnail 1
  • 2: Thumbnail 2
  • 3: Thumbnail 3
Destination Page
destinationPage ENUM
1, 2
 Your ad can take users either to a standard YouTube video watch page or to your YouTube channel page to view the selected video.
  • 1: Play on watch page (default)
  • 2: Play on channel page
Optimization callout
Advanced Fields

Back to top

Supported Fonts

  • amasisblack
  • arial
  • arialblack
  • arialn
  • arialuni
  • arialuni_t
  • ascenderserif
  • baskerville
  • batang_Batang
  • batang_BatangChe
  • bod_r
  • comic
  • corps_l
  • courier
  • eurostyle_m
  • felttiproman_b
  • franklingothic_h
  • franklingothic_m
  • futura_b
  • futura_m
  • futurabc
  • futurabooc
  • gautami
  • georgia
  • gill
  • gill_b
  • gulim_Dotum
  • gulim_DotumChe
  • gulim_Gulim
  • gulim_GulimChe
  • impact
  • kartika
  • latha
  • mangal
  • mingliu_MingLiU
  • mingliu_PMingLiU
  • msgothic_MS_Gothic
  • msgothic_MS_PGothic
  • msmincho_MS_Mincho
  • msmincho_MS_PMincho
  • newsgothic
  • nimbus_b
  • nimbus_l
  • raavi
  • shruti
  • simhei
  • simsun
  • simsunb
  • tahoma
  • times
  • trebuc
  • tunga
  • verdana
  • vrinda

Back to top

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 3.0 License, and code samples are licensed under the Apache 2.0 License. For details, see our Site Policies.

Authentication required

You need to be signed in with Google+ to do that.

Signing you in...

Google Developers needs your permission to do that.