type ResponsiveDisplayAd (v201806)

Enhanced display ad format.

Caution: Responsive display ads do not use url, displayUrl, finalAppUrls, or devicePreference; setting these fields on a responsive display ad will cause an error.


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

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.

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

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.

ResponsiveDisplayAd

marketingImage

Image

Marketing image to be used in the ad. This ad format does not allow the creation of an image using the Image.data field. An image must first be created using the MediaService, and Image.mediaId must be populated when creating a ResponsiveDisplayAd. Valid image types are GIF, JPEG, and PNG. The minimum size is 600x314 and the aspect ratio must be 600:314 (+-1%).

This field can be selected using the value "MarketingImage".
This field is required and should not be null when it is contained within Operators : ADD.

logoImage

Image

Logo image to be used in the ad. This ad format does not allow the creation of an image using the Image.data field. An image must first be created using the MediaService, and Image.mediaId must be populated when creating a ResponsiveDisplayAd. Valid image types are GIF, JPEG, and PNG. The minimum size is 128x128 and the aspect ratio must be 1:1 (+-1%).

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

squareMarketingImage

Image

Square marketing image to be used in the ad. This image may be used when a square aspect ratio is more appropriate than the aspect ratio of the marketingImage image. This ad format does not allow the creation of an image using the Image.data field. An image must first be created using the MediaService, and Image.mediaId must be populated when creating a ResponsiveDisplayAd. Valid image types are GIF, JPEG, and PNG. The minimum size is 300x300 the aspect ratio must be 1:1 (+-1%).

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

shortHeadline

xsd:string

Short format of the headline of the ad. Maximum display width is 25.

This field can be selected using the value "ShortHeadline".
This field can be filtered on.
This field is required and should not be null when it is contained within Operators : ADD.

longHeadline

xsd:string

Long format of the headline of the ad. Maximum display width is 90.

This field can be selected using the value "LongHeadline".
This field can be filtered on.
This field is required and should not be null when it is contained within Operators : ADD.

description

xsd:string

The descriptive text of the ad. Maximum display width is 90.

This field can be selected using the value "Description".
This field can be filtered on.
This field is required and should not be null when it is contained within Operators : ADD.

businessName

xsd:string

The business name. Maximum display width is 25.

This field is required and should not be null when it is contained within Operators : ADD.
This field can be selected using the value "BusinessName".
This field can be filtered on.

mainColor

xsd:string

Main color. In hexadecimal, e.g. #ffffff for white. If one of mainColor and accentColor is set, the other is required as well.

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

accentColor

xsd:string

Accent color. In hexadecimal, e.g. #ffffff for white. If one of mainColor and accentColor is set, the other is required as well.

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

allowFlexibleColor

xsd:boolean

Advertiser’s consent to allow flexible color. When true, we may serve the ad with different color when necessary. When false, we will serve the ad with advertiser color or neutral color. Must be true if mainColor and accentColor are not set. The default value is true.

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

callToActionText

xsd:string

Call to action text. Valid texts: https://support.google.com/adwords/answer/7005917

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

dynamicDisplayAdSettings

DynamicSettings

Settings for serving dynamic ResponsiveDisplayAd.

formatSetting

DisplayAdFormatSetting

Specifies which format the ad will be served in. The default value is ALL_FORMATS.


Enumerations
UNKNOWN
ALL_FORMATS
Text, image and native formats
NON_NATIVE
Text and image formats
NATIVE
Native format

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

Send feedback about...

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