Ads API .NET library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Google.Api.Ads.AdWords.v201809.TemplateAd Class Reference

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. More...

Inheritance diagram for Google.Api.Ads.AdWords.v201809.TemplateAd:
Google.Api.Ads.AdWords.v201809.Ad

Classes

class  Fields
 List of all supported fields for the TemplateAd class. More...
 
class  FilterableFields
 List of all supported filterable fields for the TemplateAd class. More...
 
class  SelectableFields
 List of all supported selectable fields for the TemplateAd class. More...
 

Properties

long templateId [get, set]
 ID of the template to use. This field can be selected using the value "TemplateId".This field can be filtered on. More...
 
bool templateIdSpecified [get, set]
 
AdUnionId adUnionId [get, set]
 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". More...
 
TemplateElement[] templateElements [get, set]
 List of elements (each containing a set of fields) for the template referenced by More...
 
Image adAsImage [get, set]
 The template ad rendered as an image. More...
 
Dimensions dimensions [get, set]
 The dimensions for this ad. More...
 
string name [get, set]
 Name of this ad. This field is required and should not be More...
 
int duration [get, set]
 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. More...
 
bool durationSpecified [get, set]
 
long originAdId [get, set]
 For copies, the ad id of the ad this was or should be copied from. This field can be selected using the value "TemplateOriginAdId". More...
 
bool originAdIdSpecified [get, set]
 
- Properties inherited from Google.Api.Ads.AdWords.v201809.Ad
long id [get, set]
 ID of this ad. This field is ignored when creating ads using More...
 
bool idSpecified [get, set]
 
string url [get, set]
 Destination URL. More...
 
string displayUrl [get, set]
 Visible URL. This field can be selected using the value "DisplayUrl".This field can be filtered on. More...
 
string[] finalUrls [get, set]
 A list of possible final URLs after all cross domain redirects. More...
 
string[] finalMobileUrls [get, set]
 A list of possible final mobile URLs after all cross domain redirects. More...
 
AppUrl[] finalAppUrls [get, set]
 A list of final app URLs that will be used on mobile if the user has the specific app installed. More...
 
string trackingUrlTemplate [get, set]
 URL template for constructing a tracking URL. More...
 
string finalUrlSuffix [get, set]
 URL template for appending params to Final URL. More...
 
CustomParameters urlCustomParameters [get, set]
 A list of mappings to be used for substituting URL custom parameter tags in the trackingUrlTemplate, finalUrls, and/or finalMobileUrls. More...
 
UrlData[] urlData [get, set]
 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. This field can be selected using the value "UrlData". More...
 
bool automated [get, set]
 Indicates if this ad was added by AdWords. This field can be selected using the value "Automated".This field can be filtered on. More...
 
bool automatedSpecified [get, set]
 
AdType type [get, set]
 Type of ad. This field can be selected using the value "AdType".This field can be filtered on. More...
 
bool typeSpecified [get, set]
 
long devicePreference [get, set]
 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. This field can be selected using the value "DevicePreference".This field can be filtered on. More...
 
bool devicePreferenceSpecified [get, set]
 
SystemManagedEntitySource systemManagedEntitySource [get, set]
 The source of this system-managed ad. This field can be selected using the value "SystemManagedEntitySource".This field can be filtered on. This field is read only and will be ignored when sent to the API. More...
 
bool systemManagedEntitySourceSpecified [get, set]
 
string AdType [get, set]
 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. More...
 

Detailed Description

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.

Property Documentation

Image Google.Api.Ads.AdWords.v201809.TemplateAd.adAsImage
getset

The template ad rendered as an image.

AdUnionId Google.Api.Ads.AdWords.v201809.TemplateAd.adUnionId
getset

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".

Dimensions Google.Api.Ads.AdWords.v201809.TemplateAd.dimensions
getset

The dimensions for this ad.

int Google.Api.Ads.AdWords.v201809.TemplateAd.duration
getset

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.

bool Google.Api.Ads.AdWords.v201809.TemplateAd.durationSpecified
getset

true, if a value is specified for duration, false otherwise.

string Google.Api.Ads.AdWords.v201809.TemplateAd.name
getset

Name of this ad. This field is required and should not be

null. This field can be selected using the value "TemplateAdName".

long Google.Api.Ads.AdWords.v201809.TemplateAd.originAdId
getset

For copies, the ad id of the ad this was or should be copied from. This field can be selected using the value "TemplateOriginAdId".

bool Google.Api.Ads.AdWords.v201809.TemplateAd.originAdIdSpecified
getset

true, if a value is specified for originAdId, false otherwise.

TemplateElement [] Google.Api.Ads.AdWords.v201809.TemplateAd.templateElements
getset

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.

long Google.Api.Ads.AdWords.v201809.TemplateAd.templateId
getset

ID of the template to use. This field can be selected using the value "TemplateId".This field can be filtered on.

bool Google.Api.Ads.AdWords.v201809.TemplateAd.templateIdSpecified
getset

true, if a value is specified for templateId, false otherwise.


The documentation for this class was generated from the following file: