abstract type RichMediaAd (v201802)

Data associated with a rich media ad.


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

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 is supported only in test accounts.

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.

This field can be selected using the value "UrlData".

automated

xsd:boolean

Indicates if this ad was added by AdWords.

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

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
UNIVERSAL_SHOPPING_AD
EXPANDED_DYNAMIC_SEARCH_AD
GMAIL_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.

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

systemManagedEntitySource

SystemManagedEntitySource

The source of this system-managed ad.


Enumerations
UNKNOWN
AD_VARIATIONS
Generated ad variations experiment 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.

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.

RichMediaAd

name

xsd:string

Name of the rich media ad.

This field is required and should not be null.
This field can be selected using the value "RichMediaAdName".

dimensions

Dimensions

Dimensions (height and width) of the ad. This field is optional for ThirdPartyRedirectAd. Ad Exchange traditional yield management creatives do not specify the dimension on the ThirdPartyRedirectAd; instead, the size is specified in the publisher front end when creating a mediation chain.

snippet

xsd:string

Snippet for this ad. Required for standard third-party ads.

The length of the string should be between 1 and 3072, inclusive.

This field can be selected using the value "RichMediaAdSnippet".

impressionBeaconUrl

xsd:string

Impression beacon URL for the ad.

This field can be selected using the value "RichMediaAdImpressionBeaconUrl".

adDuration

xsd:int

Duration for the ad (in milliseconds). Default is 0.

This field can be selected using the value "RichMediaAdDuration".
This field must be greater than or equal to 0.

certifiedVendorFormatId

xsd:long

Certified Vendor Format ID.

This field can be selected using the value "RichMediaAdCertifiedVendorFormatId".
This field is required and should not be null.

sourceUrl

xsd:string

SourceUrl pointing to the third party snippet. For third party in-stream video ads, this stores the VAST URL. For DFA ads, it stores the InRed URL.

This field can be selected using the value "RichMediaAdSourceUrl".

richMediaAdType

RichMediaAd.RichMediaAdType

Type of this rich media ad, the default is Standard.


Enumerations
STANDARD
Standard.
IN_STREAM_VIDEO
In stream video ad.

This field can be selected using the value "RichMediaAdType".

adAttributes

RichMediaAd.AdAttribute[]

A list of attributes that describe the rich media ad capabilities.


Enumerations
UNKNOWN
ROLL_OVER_TO_EXPAND
Indicates that the ad supports mouse roll over to expand.
SSL
Indicates that the ad supports SSL.

Send feedback about...

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