Share your feedback about the AdWords API! Take our annual survey.

type TemplateAd (v201806)

Represents a Display Ad Builder template ad. A template ad is composed of a template (specified by its ID) and the data that populates the template's fields. For a list of available templates and their required fields, see Template Ads.


Namespace
https://adwords.google.com/api/adwords/cm/v201806

Field

Ad (inherited)

id

xsd:long

ID of this ad. This field is ignored when creating ads using AdGroupAdService.

This field can be selected using the value "Id".
This field can be filtered on.

url

xsd:string

Destination URL.

Do not set this field if you are using upgraded URLs, as described at: https://developers.google.com/adwords/api/docs/guides/upgraded-urls

This field can be selected using the value "Url".
This field can be filtered on.

displayUrl

xsd:string

Visible URL.

This field can be selected using the value "DisplayUrl".
This field can be filtered on.

finalUrls

xsd:string[]

A list of possible final URLs after all cross domain redirects.

This field is used for upgraded urls only, as described at: https://developers.google.com/adwords/api/docs/guides/upgraded-urls

This field can be selected using the value "CreativeFinalUrls".
This field can be filtered on.
The maximum size of this collection is 10.

finalMobileUrls

xsd:string[]

A list of possible final mobile URLs after all cross domain redirects.

This field is used for upgraded urls only, as described at: https://developers.google.com/adwords/api/docs/guides/upgraded-urls

This field can be selected using the value "CreativeFinalMobileUrls".
This field can be filtered on.
The maximum size of this collection is 10.

finalAppUrls

AppUrl[]

A list of final app URLs that will be used on mobile if the user has the specific app installed.

This field is used for upgraded urls only, as described at: https://developers.google.com/adwords/api/docs/guides/upgraded-urls

This field can be selected using the value "CreativeFinalAppUrls".
This field can be filtered on.

trackingUrlTemplate

xsd:string

URL template for constructing a tracking URL.

This field is used for upgraded urls only, as described at: https://developers.google.com/adwords/api/docs/guides/upgraded-urls

This field can be selected using the value "CreativeTrackingUrlTemplate".
This field can be filtered on.

finalUrlSuffix

xsd:string

URL template for appending params to Final URL.

On update, empty string ("") indicates to clear the field.

This field can be selected using the value "CreativeFinalUrlSuffix".
This field can be filtered on.

urlCustomParameters

CustomParameters

A list of mappings to be used for substituting URL custom parameter tags in the trackingUrlTemplate, finalUrls, and/or finalMobileUrls.

This field is used for upgraded urls only, as described at: https://developers.google.com/adwords/api/docs/guides/upgraded-urls

This field can be selected using the value "CreativeUrlCustomParameters".
This field can be filtered on.

urlData

UrlData[]

Additional urls for the ad that are tagged with a unique identifier. Currently only used for TemplateAds for specific template IDs. For all other ad types, use finalUrls, finalMobileUrls and finalAppUrls instead.

automated

xsd:boolean

Indicates if this ad was added by AdWords.

type

Ad.Type

Type of ad. Indicates that this instance is a subtype of Ad. Although this field is returned in the response, it is ignored on input and cannot be selected. Specify xsi:type instead.


Enumerations
DEPRECATED_AD
IMAGE_AD
PRODUCT_AD
TEMPLATE_AD
TEXT_AD
THIRD_PARTY_REDIRECT_AD
DYNAMIC_SEARCH_AD
CALL_ONLY_AD
EXPANDED_TEXT_AD
RESPONSIVE_DISPLAY_AD
SHOWCASE_AD
GOAL_OPTIMIZED_SHOPPING_AD
EXPANDED_DYNAMIC_SEARCH_AD
GMAIL_AD
RESPONSIVE_SEARCH_AD
MULTI_ASSET_RESPONSIVE_DISPLAY_AD
UNKNOWN

This field can be selected using the value "AdType".
This field can be filtered on.

devicePreference

xsd:long

The device preference for the ad. You can only specify a preference for mobile devices (CriterionId 30001). If unspecified (no device preference), all devices are targeted.

systemManagedEntitySource

SystemManagedEntitySource

The source of this system-managed ad.


Enumerations
UNKNOWN
AD_VARIATIONS
Generated ad variations experiment ad.

This field is read only and will be ignored when sent to the API.

Ad.Type

xsd:string

Indicates that this instance is a subtype of Ad. Although this field is returned in the response, it is ignored on input and cannot be selected. Specify xsi:type instead.

TemplateAd

templateId

xsd:long

ID of the template to use.

adUnionId

  1. AdUnionId
    1. TempAdUnionId

Group ID of all template ads, which should be created together. Template ads in the same union reference the same data but have different dimensions. Single ads do not have a union ID. If a template ad specifies an ad union with only one ad, no union will be created.

templateElements

TemplateElement[]

List of elements (each containing a set of fields) for the template referenced by templateId. See Template Ads for the elements and fields required for each template.

adAsImage

Image

The template ad rendered as an image.

dimensions

Dimensions

The dimensions for this ad.

name

xsd:string

Name of this ad.

This field is required and should not be null.

duration

xsd:int

Duration of this ad (if it contains playable media).

This field is read only and will be ignored when sent to the API.

originAdId

xsd:long

For copies, the ad id of the ad this was or should be copied from.

Send feedback about...

AdWords API
AdWords API
Need help? Visit our support page.