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. This is disabled for AdX when it is contained within Operators: ADD, SET.
- Namespace
-
https://adwords.google.com/api/adwords/cm/v201506 - Fields
| Field | Type | Description |
|---|---|---|
| Ad (inherited) | ||
| id Filterable
Selectable
|
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 Filterable
Selectable
|
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 Filterable
Selectable
|
xsd:string
|
Visible URL. This field can be selected using the value "DisplayUrl". This field can be filtered on. |
| finalUrls CollectionSize
Filterable
Selectable
|
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 CollectionSize
Filterable
Selectable
|
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 Filterable
Selectable
|
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 Filterable
Selectable
|
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. |
| urlCustomParameters Filterable
Selectable
|
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. |
| devicePreference Filterable
Selectable
|
xsd:long
|
The device preference for the ad. This field can be selected using the value "DevicePreference". This field can be filtered on. |
| 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 Filterable
Selectable
|
xsd:long
|
ID of the template to use. This field can be selected using the value "TemplateId". This field can be filtered on. |
| adUnionId Selectable
|
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. This field can be selected using the value "TemplateAdUnionId". | |
| 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 Required
Selectable
|
xsd:string
|
Name of this ad.
This field can be selected using the value "TemplateAdName".
This field is required and should not be null.
|
| duration ReadOnly
Selectable
|
xsd:int
|
Duration of this ad (if it contains playable media). This field can be selected using the value "TemplateAdDuration". This field is read only and will be ignored when sent to the API. |
| originAdId Selectable
|
xsd:long
|
For copies, the ad id of the ad this was or should be copied from. This field can be selected using the value "TemplateOriginAdId". |
