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

The base class of all ad types. More...

Inheritance diagram for Google.Api.Ads.AdWords.v201809.Ad:
Google.Api.Ads.AdWords.v201809.CallOnlyAd Google.Api.Ads.AdWords.v201809.DeprecatedAd Google.Api.Ads.AdWords.v201809.DynamicSearchAd Google.Api.Ads.AdWords.v201809.ExpandedDynamicSearchAd Google.Api.Ads.AdWords.v201809.ExpandedTextAd Google.Api.Ads.AdWords.v201809.GmailAd Google.Api.Ads.AdWords.v201809.GoalOptimizedShoppingAd Google.Api.Ads.AdWords.v201809.ImageAd Google.Api.Ads.AdWords.v201809.MultiAssetResponsiveDisplayAd Google.Api.Ads.AdWords.v201809.ProductAd Google.Api.Ads.AdWords.v201809.ResponsiveDisplayAd Google.Api.Ads.AdWords.v201809.ResponsiveSearchAd Google.Api.Ads.AdWords.v201809.RichMediaAd Google.Api.Ads.AdWords.v201809.ShowcaseAd Google.Api.Ads.AdWords.v201809.TemplateAd Google.Api.Ads.AdWords.v201809.TextAd Google.Api.Ads.AdWords.v201809.UniversalAppAd

Classes

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

Properties

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

The base class of all ad types.

Ads are created using the AdGroupAdService. Some ad types such as s may be modified using the AdService.

When calling AdGroupAdService to update the of an AdGroupAd, you can construct an Ad object (instead of the Ad's concrete type) with the #id field set. This is enabled for AdX.

Property Documentation

string Google.Api.Ads.AdWords.v201809.Ad.AdType
getset

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.

bool Google.Api.Ads.AdWords.v201809.Ad.automated
getset

Indicates if this ad was added by AdWords. This field can be selected using the value "Automated".This field can be filtered on.

bool Google.Api.Ads.AdWords.v201809.Ad.automatedSpecified
getset

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

long Google.Api.Ads.AdWords.v201809.Ad.devicePreference
getset

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.

bool Google.Api.Ads.AdWords.v201809.Ad.devicePreferenceSpecified
getset

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

string Google.Api.Ads.AdWords.v201809.Ad.displayUrl
getset

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

AppUrl [] Google.Api.Ads.AdWords.v201809.Ad.finalAppUrls
getset

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.

string [] Google.Api.Ads.AdWords.v201809.Ad.finalMobileUrls
getset

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.

string [] Google.Api.Ads.AdWords.v201809.Ad.finalUrls
getset

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.

string Google.Api.Ads.AdWords.v201809.Ad.finalUrlSuffix
getset

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.

long Google.Api.Ads.AdWords.v201809.Ad.id
getset

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

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

Referenced by Google.Api.Ads.AdWords.Examples.CSharp.v201809.GetExpandedTextAds.Run().

bool Google.Api.Ads.AdWords.v201809.Ad.idSpecified
getset

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

SystemManagedEntitySource Google.Api.Ads.AdWords.v201809.Ad.systemManagedEntitySource
getset

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.

bool Google.Api.Ads.AdWords.v201809.Ad.systemManagedEntitySourceSpecified
getset

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

string Google.Api.Ads.AdWords.v201809.Ad.trackingUrlTemplate
getset

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.

AdType Google.Api.Ads.AdWords.v201809.Ad.type
getset

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

bool Google.Api.Ads.AdWords.v201809.Ad.typeSpecified
getset

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

string Google.Api.Ads.AdWords.v201809.Ad.url
getset

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.

CustomParameters Google.Api.Ads.AdWords.v201809.Ad.urlCustomParameters
getset

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 [] Google.Api.Ads.AdWords.v201809.Ad.urlData
getset

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


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