type MultiAssetResponsiveDisplayAd (v201806)

Representation of multi-asset responsive display ad format.

Caution: multi-asset responsive display ads do not use url, displayUrl, finalAppUrls, or devicePreference; setting these fields on a multi-asset 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 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.

automated

xsd:boolean

Indicates if this ad was added by AdWords.

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.

systemManagedEntitySource

SystemManagedEntitySource

The source of this system-managed ad.


Enumerations
UNKNOWN
AD_VARIATIONS
Generated ad variations experiment ad.

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.

MultiAssetResponsiveDisplayAd

marketingImages

AssetLink[]

Marketing image to be used in the ad. This ad format does not allow the creation of an imageAsset using the ImageAsset.imageData field. An imageAsset must first be created using the AssetService, and ImageAsset.assetId must be populated in this field. Valid image types are GIF, JPEG, and PNG. The minimum size is 600x314 and the aspect ratio must be 1.91:1 (+-1%). One marketingImage is required. Support up to 15 with squareMarketingImages.

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

squareMarketingImages

AssetLink[]

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 imageAsset using the ImageAsset.imageData field. An imageAsset must first be created using the AssetService, and ImageAsset.assetId must be populated in this field. Valid image types are GIF, JPEG, and PNG. The minimum size is 300x300 the aspect ratio must be 1:1 (+-1%). One squareMarketingImage is required. Support up to 15 with marketingImages.

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

logoImages

AssetLink[]

Logo image to be used in the ad. This ad format does not allow the creation of an image using the ImageAsset.imageData field. An imageAsset must first be created using the AssetService, and ImageAsset.assetId must be populated in this field. Valid image types are GIF, JPEG, and PNG. The minimum size is 128x128 and the aspect ratio must be 1:1 (+-1%). Optional. Support up to 5 with landscapeLogoImages.

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

landscapeLogoImages

AssetLink[]

Landscape logo image which is used for serving dynamic MultiAssetResponsiveDisplayAd. This ad format does not allow the creation of an image using the ImageAsset.imageData field. An imageAsset must first be created using the AssetService, and ImageAsset.assetId must be populated in this field. Valid image types are GIF, JPEG, and PNG. The minimum size is 512x128 and the aspect ratio must be 4:1 (+-1%). Optional. Support up to 5 with logoImages.

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

headlines

AssetLink[]

Short format of the headline of the ad. Maximum display width is 30. One short headline is required. Support up to 5 short headlines.

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

longHeadline

AssetLink

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

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

descriptions

AssetLink[]

The descriptive text of the ad. Maximum display width is 90. One description is required. Support up to 5 descriptions.

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

businessName

xsd:string

The Advertiser/brand name. Maximum display width is 25.

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

mainColor

xsd:string

Main color, represented as a hexadecimal string (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 "MultiAssetResponsiveDisplayAdMainColor".
This field can be filtered on.

accentColor

xsd:string

Accent color, represented as a hexadecimal string (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 "MultiAssetResponsiveDisplayAdAccentColor".
This field can be filtered on.

allowFlexibleColor

xsd:boolean

Allow flexible color. If set to true, the ad will show on text and native ad placements even when publisher settings may override your custom color selections. This field must be set to true if both mainColor and accentColor are not set. The default value is true.

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

callToActionText

xsd:string

Call to action text.

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

dynamicSettingsPricePrefix

xsd:string

Prefix before price. Maximum display width is 10. For example, "as low as". For more details, check the help page https://developers.google.com/adwords/api/docs/guides/dynamic-remarketing

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

dynamicSettingsPromoText

xsd:string

Promotion text used for dynamic formats of multi-asset responsive display ads. Maximum display width is 25. For example, "Free two-day shipping". For more details, check the help page https://developers.google.com/adwords/api/docs/guides/dynamic-remarketing

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

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 "MultiAssetResponsiveDisplayAdFormatSetting".
This field can be filtered on.

Send feedback about...

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