Ad

An ad.

JSON representation 
{
  "resourceName": string,
  "finalUrls": [
    string
  ],
  "finalAppUrls": [
    {
      object (FinalAppUrl)
    }
  ],
  "finalMobileUrls": [
    string
  ],
  "urlCustomParameters": [
    {
      object (CustomParameter)
    }
  ],
  "type": enum (AdType),
  "devicePreference": enum (Device),
  "urlCollections": [
    {
      object (UrlCollection)
    }
  ],
  "systemManagedResourceSource": enum (SystemManagedResourceSource),
  "id": string,
  "trackingUrlTemplate": string,
  "finalUrlSuffix": string,
  "displayUrl": string,
  "addedByGoogleAds": boolean,
  "name": string,

  // Union field ad_data can be only one of the following:
  "textAd": {
    object (TextAdInfo)
  },
  "expandedTextAd": {
    object (ExpandedTextAdInfo)
  },
  "callAd": {
    object (CallAdInfo)
  },
  "expandedDynamicSearchAd": {
    object (ExpandedDynamicSearchAdInfo)
  },
  "hotelAd": {
    object (HotelAdInfo)
  },
  "shoppingSmartAd": {
    object (ShoppingSmartAdInfo)
  },
  "shoppingProductAd": {
    object (ShoppingProductAdInfo)
  },
  "imageAd": {
    object (ImageAdInfo)
  },
  "videoAd": {
    object (VideoAdInfo)
  },
  "videoResponsiveAd": {
    object (VideoResponsiveAdInfo)
  },
  "responsiveSearchAd": {
    object (ResponsiveSearchAdInfo)
  },
  "legacyResponsiveDisplayAd": {
    object (LegacyResponsiveDisplayAdInfo)
  },
  "appAd": {
    object (AppAdInfo)
  },
  "legacyAppInstallAd": {
    object (LegacyAppInstallAdInfo)
  },
  "responsiveDisplayAd": {
    object (ResponsiveDisplayAdInfo)
  },
  "localAd": {
    object (LocalAdInfo)
  },
  "displayUploadAd": {
    object (DisplayUploadAdInfo)
  },
  "appEngagementAd": {
    object (AppEngagementAdInfo)
  },
  "shoppingComparisonListingAd": {
    object (ShoppingComparisonListingAdInfo)
  },
  "smartCampaignAd": {
    object (SmartCampaignAdInfo)
  },
  "appPreRegistrationAd": {
    object (AppPreRegistrationAdInfo)
  },
  "demandGenMultiAssetAd": {
    object (DemandGenMultiAssetAdInfo)
  },
  "demandGenCarouselAd": {
    object (DemandGenCarouselAdInfo)
  },
  "demandGenVideoResponsiveAd": {
    object (DemandGenVideoResponsiveAdInfo)
  },
  "demandGenProductAd": {
    object (DemandGenProductAdInfo)
  },
  "travelAd": {
    object (TravelAdInfo)
  }
  // End of list of possible types for union field ad_data.
}
Fields
resourceName

string

Immutable. The resource name of the ad. Ad resource names have the form:

customers/{customerId}/ads/{ad_id}
finalUrls[]

string

The list of possible final URLs after all cross-domain redirects for the ad.
finalAppUrls[]

object (FinalAppUrl)

A list of final app URLs that will be used on mobile if the user has the specific app installed.
finalMobileUrls[]

string

The list of possible final mobile URLs after all cross-domain redirects for the ad.
urlCustomParameters[]

object (CustomParameter)

The list of mappings that can be used to substitute custom parameter tags in a trackingUrlTemplate, finalUrls, or mobile_final_urls. For mutates, use url custom parameter operations.
type

enum (AdType)

Output only. The type of ad.
devicePreference

enum (Device)

The device preference for the ad. You can only specify a preference for mobile devices. When this preference is set the ad will be preferred over other ads when being displayed on a mobile device. The ad can still be displayed on other device types, for example, if no other ads are available. If unspecified (no device preference), all devices are targeted. This is only supported by some ad types.
urlCollections[]

object (UrlCollection)

Additional URLs for the ad that are tagged with a unique identifier that can be referenced from other fields in the ad.
systemManagedResourceSource

enum (SystemManagedResourceSource)

Output only. If this ad is system managed, then this field will indicate the source. This field is read-only.
id

string (int64 format)

Output only. The ID of the ad.
trackingUrlTemplate

string

The URL template for constructing a tracking URL.
finalUrlSuffix

string

The suffix to use when constructing a final URL.
displayUrl

string

The URL that appears in the ad description for some ad formats.
addedByGoogleAds

boolean

Output only. Indicates if this ad was automatically added by Google Ads and not by a user. For example, this could happen when ads are automatically created as suggestions for new ads based on knowledge of how existing ads are performing.
name

string

Immutable. The name of the ad. This is only used to be able to identify the ad. It does not need to be unique and does not affect the served ad. The name field is currently only supported for DisplayUploadAd, ImageAd, ShoppingComparisonListingAd and VideoAd.
Union field ad_data. Details pertinent to the ad type. Exactly one value must be set. ad_data can be only one of the following:
textAd

object (TextAdInfo)

Immutable. Details pertaining to a text ad.
expandedTextAd

object (ExpandedTextAdInfo)

Details pertaining to an expanded text ad.
callAd

object (CallAdInfo)

Details pertaining to a call ad.
expandedDynamicSearchAd

object (ExpandedDynamicSearchAdInfo)

Immutable. Details pertaining to an Expanded Dynamic Search Ad. This type of ad has its headline, final URLs, and display URL auto-generated at serving time according to domain name specific information provided by dynamicSearchAdsSetting linked at the campaign level.
hotelAd

object (HotelAdInfo)

Details pertaining to a hotel ad.
shoppingSmartAd

object (ShoppingSmartAdInfo)

Details pertaining to a Smart Shopping ad.
shoppingProductAd

object (ShoppingProductAdInfo)

Details pertaining to a Shopping product ad.
imageAd

object (ImageAdInfo)

Immutable. Details pertaining to an Image ad.
videoAd

object (VideoAdInfo)

Details pertaining to a Video ad.
videoResponsiveAd

object (VideoResponsiveAdInfo)

Details pertaining to a Video responsive ad.
responsiveSearchAd

object (ResponsiveSearchAdInfo)

Details pertaining to a responsive search ad.
legacyResponsiveDisplayAd

object (LegacyResponsiveDisplayAdInfo)

Details pertaining to a legacy responsive display ad.
appAd

object (AppAdInfo)

Details pertaining to an app ad.
legacyAppInstallAd

object (LegacyAppInstallAdInfo)

Immutable. Details pertaining to a legacy app install ad.
responsiveDisplayAd

object (ResponsiveDisplayAdInfo)

Details pertaining to a responsive display ad.
localAd

object (LocalAdInfo)

Details pertaining to a local ad.
displayUploadAd

object (DisplayUploadAdInfo)

Details pertaining to a display upload ad.
appEngagementAd

object (AppEngagementAdInfo)

Details pertaining to an app engagement ad.
shoppingComparisonListingAd

object (ShoppingComparisonListingAdInfo)

Details pertaining to a Shopping Comparison Listing ad.
smartCampaignAd

object (SmartCampaignAdInfo)

Details pertaining to a Smart campaign ad.
appPreRegistrationAd

object (AppPreRegistrationAdInfo)

Details pertaining to an app pre-registration ad.
demandGenMultiAssetAd

object (DemandGenMultiAssetAdInfo)

Details pertaining to a Demand Gen multi asset ad.
demandGenVideoResponsiveAd

object (DemandGenVideoResponsiveAdInfo)

Details pertaining to a Demand Gen video responsive ad.
demandGenProductAd

object (DemandGenProductAdInfo)

Details pertaining to a Demand Gen product ad.
travelAd

object (TravelAdInfo)

Details pertaining to a travel ad.

FinalAppUrl

A URL for deep linking into an app for the given operating system.

JSON representation 
{
  "osType": enum (AppUrlOperatingSystemType),
  "url": string
}
Fields
osType

enum (AppUrlOperatingSystemType)

The operating system targeted by this URL. Required.
url

string

The app deep link URL. Deep links specify a location in an app that corresponds to the content you'd like to show, and should be of the form {scheme}://{host_path} The scheme identifies which app to open. For your app, you can use a custom scheme that starts with the app's name. The host and path specify the unique location in the app where your content exists. Example: "exampleapp://productid_1234". Required.

AppUrlOperatingSystemType

Operating System

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
IOS The Apple IOS operating system.
ANDROID The Android operating system.

AdType

The possible types of an ad.

Enums
UNSPECIFIED No value has been specified.
UNKNOWN

The received value is not known in this version.

This is a response-only value.
TEXT_AD The ad is a text ad.
EXPANDED_TEXT_AD The ad is an expanded text ad.
EXPANDED_DYNAMIC_SEARCH_AD The ad is an expanded dynamic search ad.
HOTEL_AD The ad is a hotel ad.
SHOPPING_SMART_AD The ad is a Smart Shopping ad.
SHOPPING_PRODUCT_AD The ad is a standard Shopping ad.
VIDEO_AD The ad is a video ad.
IMAGE_AD This ad is an Image ad.
RESPONSIVE_SEARCH_AD The ad is a responsive search ad.
LEGACY_RESPONSIVE_DISPLAY_AD The ad is a legacy responsive display ad.
APP_AD The ad is an app ad.
LEGACY_APP_INSTALL_AD The ad is a legacy app install ad.
RESPONSIVE_DISPLAY_AD The ad is a responsive display ad.
LOCAL_AD The ad is a local ad.
HTML5_UPLOAD_AD The ad is a display upload ad with the HTML5_UPLOAD_AD product type.
DYNAMIC_HTML5_AD The ad is a display upload ad with one of the DYNAMIC_HTML5_* product types.
APP_ENGAGEMENT_AD The ad is an app engagement ad.
SHOPPING_COMPARISON_LISTING_AD The ad is a Shopping Comparison Listing ad.
VIDEO_BUMPER_AD Video bumper ad.
VIDEO_NON_SKIPPABLE_IN_STREAM_AD Video non-skippable in-stream ad.
VIDEO_TRUEVIEW_IN_STREAM_AD Video TrueView in-stream ad.
VIDEO_RESPONSIVE_AD Video responsive ad.
SMART_CAMPAIGN_AD Smart campaign ad.
CALL_AD Call ad.
APP_PRE_REGISTRATION_AD Universal app pre-registration ad.
IN_FEED_VIDEO_AD In-feed video ad.
DEMAND_GEN_MULTI_ASSET_AD Demand Gen multi asset ad.
TRAVEL_AD Travel ad.
DEMAND_GEN_VIDEO_RESPONSIVE_AD Demand Gen video responsive ad.
DEMAND_GEN_PRODUCT_AD Demand Gen product ad.

UrlCollection

Collection of urls that is tagged with a unique identifier.

JSON representation 
{
  "finalUrls": [
    string
  ],
  "finalMobileUrls": [
    string
  ],
  "urlCollectionId": string,
  "trackingUrlTemplate": string
}
Fields
finalUrls[]

string

A list of possible final URLs.
finalMobileUrls[]

string

A list of possible final mobile URLs.
urlCollectionId

string

Unique identifier for this UrlCollection instance.
trackingUrlTemplate

string

URL template for constructing a tracking URL.

SystemManagedResourceSource

Enum listing the possible system managed entity sources.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
AD_VARIATIONS Generated ad variations experiment ad.

TextAdInfo

A text ad.

JSON representation 
{
  "headline": string,
  "description1": string,
  "description2": string
}
Fields
headline

string

The headline of the ad.
description1

string

The first line of the ad's description.
description2

string

The second line of the ad's description.

ExpandedTextAdInfo

An expanded text ad.

JSON representation 
{
  "headlinePart1": string,
  "headlinePart2": string,
  "headlinePart3": string,
  "description": string,
  "description2": string,
  "path1": string,
  "path2": string
}
Fields
headlinePart1

string

The first part of the ad's headline.
headlinePart2

string

The second part of the ad's headline.
headlinePart3

string

The third part of the ad's headline.
description

string

The description of the ad.
description2

string

The second description of the ad.
path1

string

The text that can appear alongside the ad's displayed URL.
path2

string

Additional text that can appear alongside the ad's displayed URL.

CallAdInfo

A call ad.

JSON representation 
{
  "countryCode": string,
  "phoneNumber": string,
  "businessName": string,
  "headline1": string,
  "headline2": string,
  "description1": string,
  "description2": string,
  "callTracked": boolean,
  "disableCallConversion": boolean,
  "phoneNumberVerificationUrl": string,
  "conversionAction": string,
  "conversionReportingState": enum (CallConversionReportingState),
  "path1": string,
  "path2": string
}
Fields
countryCode

string

The country code in the ad.
phoneNumber

string

The phone number in the ad.
businessName

string

The business name in the ad.
headline1

string

First headline in the ad.
headline2

string

Second headline in the ad.
description1

string

The first line of the ad's description.
description2

string

The second line of the ad's description.
callTracked

boolean

Whether to enable call tracking for the creative. Enabling call tracking also enables call conversions.
disableCallConversion

boolean

Whether to disable call conversion for the creative. If set to true, disables call conversions even when callTracked is true. If callTracked is false, this field is ignored.
phoneNumberVerificationUrl

string

The URL to be used for phone number verification.
conversionAction

string

The conversion action to attribute a call conversion to. If not set a default conversion action is used. This field only has effect if callTracked is set to true. Otherwise this field is ignored.
conversionReportingState

enum (CallConversionReportingState)

The call conversion behavior of this call ad. It can use its own call conversion setting, inherit the account level setting, or be disabled.
path1

string

First part of text that can be appended to the URL in the ad. Optional.
path2

string

Second part of text that can be appended to the URL in the ad. This field can only be set when path1 is also set. Optional.

ExpandedDynamicSearchAdInfo

An expanded dynamic search ad.

JSON representation 
{
  "description": string,
  "description2": string
}
Fields
description

string

The description of the ad.
description2

string

The second description of the ad.

HotelAdInfo

This type has no fields.

A hotel ad.

ShoppingSmartAdInfo

This type has no fields.

A Smart Shopping ad.

ShoppingProductAdInfo

This type has no fields.

A standard Shopping ad.

ImageAdInfo

An image ad.

JSON representation 
{
  "mimeType": enum (MimeType),
  "pixelWidth": string,
  "pixelHeight": string,
  "imageUrl": string,
  "previewPixelWidth": string,
  "previewPixelHeight": string,
  "previewImageUrl": string,
  "name": string,

  // Union field image can be only one of the following:
  "imageAsset": {
    object (AdImageAsset)
  },
  "data": string,
  "adIdToCopyImageFrom": string
  // End of list of possible types for union field image.
}
Fields
mimeType

enum (MimeType)

The mime type of the image.
pixelWidth

string (int64 format)

Width in pixels of the full size image.
pixelHeight

string (int64 format)

Height in pixels of the full size image.
imageUrl

string

URL of the full size image.
previewPixelWidth

string (int64 format)

Width in pixels of the preview size image.
previewPixelHeight

string (int64 format)

Height in pixels of the preview size image.
previewImageUrl

string

URL of the preview size image.
name

string

The name of the image. If the image was created from a MediaFile, this is the MediaFile's name. If the image was created from bytes, this is empty.
Union field image. The image to create the ImageAd from. This can be specified in one of two ways. 1. An existing MediaFile resource. 2. The raw image data as bytes. image can be only one of the following:
imageAsset

object (AdImageAsset)

The image assets used for the ad.
data

string (bytes format)

Raw image data as bytes.

A base64-encoded string.
adIdToCopyImageFrom

string (int64 format)

An ad ID to copy the image from.

AdImageAsset

An image asset used inside an ad.

JSON representation 
{
  "asset": string
}
Fields
asset

string

The Asset resource name of this image.

VideoAdInfo

A video ad.

JSON representation 
{
  "video": {
    object (AdVideoAsset)
  },

  // Union field format can be only one of the following:
  "inStream": {
    object (VideoTrueViewInStreamAdInfo)
  },
  "bumper": {
    object (VideoBumperInStreamAdInfo)
  },
  "outStream": {
    object (VideoOutstreamAdInfo)
  },
  "nonSkippable": {
    object (VideoNonSkippableInStreamAdInfo)
  },
  "inFeed": {
    object (InFeedVideoAdInfo)
  }
  // End of list of possible types for union field format.
}
Fields
video

object (AdVideoAsset)

The YouTube video assets used for the ad.
Union field format. Format-specific schema for the different video formats. format can be only one of the following:
inStream

object (VideoTrueViewInStreamAdInfo)

Video TrueView in-stream ad format.
bumper

object (VideoBumperInStreamAdInfo)

Video bumper in-stream ad format.
outStream

object (VideoOutstreamAdInfo)

Video out-stream ad format.
nonSkippable

object (VideoNonSkippableInStreamAdInfo)

Video non-skippable in-stream ad format.
inFeed

object (InFeedVideoAdInfo)

In-feed video ad format.

AdVideoAsset

A video asset used inside an ad.

JSON representation 
{
  "asset": string,
  "adVideoAssetInfo": {
    object (AdVideoAssetInfo)
  }
}
Fields
asset

string

The Asset resource name of this video.
adVideoAssetInfo

object (AdVideoAssetInfo)

Contains info fields for this AdVideoAsset.

AdVideoAssetInfo

Contains info fields for AdVideoAssets.

JSON representation 
{
  "adVideoAssetInventoryPreferences": {
    object (AdVideoAssetInventoryPreferences)
  }
}
Fields
adVideoAssetInventoryPreferences

object (AdVideoAssetInventoryPreferences)

List of inventory preferences for this AdVideoAsset. This field can only be set for DiscoveryVideoResponsiveAd. The video assets with an inventory asset preference set will be preferred over other videos from the same ad during serving time. For example, consider this ad being served for a specific inventory. The server will first try to match an eligible video with a matching preference for that inventory. Videos with no preferences are chosen only when a video with matching preference and eligible for a given ad slot can be found.

AdVideoAssetInventoryPreferences

YouTube Video Asset inventory preferences.

JSON representation 
{
  "inFeedPreference": boolean,
  "inStreamPreference": boolean,
  "shortsPreference": boolean
}
Fields
inFeedPreference

boolean

When true, YouTube Video Asset with this inventory preference will be preferred when choosing a video to serve In Feed.
inStreamPreference

boolean

When true, YouTube Video Asset with this inventory preference will be preferred when choosing a video to serve In Stream.
shortsPreference

boolean

When true, YouTube Video Asset with this inventory preference will be preferred when choosing a video to serve on YouTube Shorts.

VideoTrueViewInStreamAdInfo

Representation of video TrueView in-stream ad format (ad shown during video playback, often at beginning, which displays a skip button a few seconds into the video).

JSON representation 
{
  "actionButtonLabel": string,
  "actionHeadline": string,
  "companionBanner": {
    object (AdImageAsset)
  }
}
Fields
actionButtonLabel

string

Label on the CTA (call-to-action) button taking the user to the video ad's final URL. Required for TrueView for action campaigns, optional otherwise.
actionHeadline

string

Additional text displayed with the CTA (call-to-action) button to give context and encourage clicking on the button.
companionBanner

object (AdImageAsset)

The image assets of the companion banner used with the ad.

VideoBumperInStreamAdInfo

Representation of video bumper in-stream ad format (very short in-stream non-skippable video ad).

JSON representation 
{
  "companionBanner": {
    object (AdImageAsset)
  },
  "actionButtonLabel": string,
  "actionHeadline": string
}
Fields
companionBanner

object (AdImageAsset)

The image assets of the companion banner used with the ad.
actionButtonLabel

string

Label on the "Call To Action" button taking the user to the video ad's final URL.
actionHeadline

string

Additional text displayed with the CTA (call-to-action) button to give context and encourage clicking on the button.

VideoOutstreamAdInfo

Representation of video out-stream ad format (ad shown alongside a feed with automatic playback, without sound).

JSON representation 
{
  "headline": string,
  "description": string
}
Fields
headline

string

The headline of the ad.
description

string

The description line.

VideoNonSkippableInStreamAdInfo

Representation of video non-skippable in-stream ad format (15 second in-stream non-skippable video ad).

JSON representation 
{
  "companionBanner": {
    object (AdImageAsset)
  },
  "actionButtonLabel": string,
  "actionHeadline": string
}
Fields
companionBanner

object (AdImageAsset)

The image assets of the companion banner used with the ad.
actionButtonLabel

string

Label on the "Call To Action" button taking the user to the video ad's final URL.
actionHeadline

string

Additional text displayed with the "Call To Action" button to give context and encourage clicking on the button.

InFeedVideoAdInfo

Representation of In-feed video ad format.

JSON representation 
{
  "headline": string,
  "description1": string,
  "description2": string,
  "thumbnail": enum (VideoThumbnail)
}
Fields
headline

string

The headline of the ad.
description1

string

First text line for the ad.
description2

string

Second text line for the ad.
thumbnail

enum (VideoThumbnail)

Video thumbnail image to use.

VideoThumbnail

Enum listing the possible types of a video thumbnail.

Enums
UNSPECIFIED The type has not been specified.
UNKNOWN The received value is not known in this version. This is a response-only value.
DEFAULT_THUMBNAIL The default thumbnail. Can be auto-generated or user-uploaded.
THUMBNAIL_1 Thumbnail 1, generated from the video.
THUMBNAIL_2 Thumbnail 2, generated from the video.
THUMBNAIL_3 Thumbnail 3, generated from the video.

VideoResponsiveAdInfo

A video responsive ad.

JSON representation 
{
  "headlines": [
    {
      object (AdTextAsset)
    }
  ],
  "longHeadlines": [
    {
      object (AdTextAsset)
    }
  ],
  "descriptions": [
    {
      object (AdTextAsset)
    }
  ],
  "callToActions": [
    {
      object (AdTextAsset)
    }
  ],
  "videos": [
    {
      object (AdVideoAsset)
    }
  ],
  "companionBanners": [
    {
      object (AdImageAsset)
    }
  ],
  "breadcrumb1": string,
  "breadcrumb2": string
}
Fields
headlines[]

object (AdTextAsset)

List of text assets used for the short headline. Currently, only a single value for the short headline is supported.
longHeadlines[]

object (AdTextAsset)

List of text assets used for the long headline. Currently, only a single value for the long headline is supported.
descriptions[]

object (AdTextAsset)

List of text assets used for the description. Currently, only a single value for the description is supported.
callToActions[]

object (AdTextAsset)

List of text assets used for the button, for example, the "Call To Action" button. Currently, only a single value for the button is supported.
videos[]

object (AdVideoAsset)

List of YouTube video assets used for the ad. Currently, only a single value for the YouTube video asset is supported.
companionBanners[]

object (AdImageAsset)

List of image assets used for the companion banner. Currently, only a single value for the companion banner asset is supported.
breadcrumb1

string

First part of text that appears in the ad with the displayed URL.
breadcrumb2

string

Second part of text that appears in the ad with the displayed URL.

ResponsiveSearchAdInfo

A responsive search ad.

Responsive search ads let you create an ad that adapts to show more text, and more relevant messages, to your customers. Enter multiple headlines and descriptions when creating a responsive search ad, and over time, Google Ads will automatically test different combinations and learn which combinations perform best. By adapting your ad's content to more closely match potential customers' search terms, responsive search ads may improve your campaign's performance.

More information at https://support.google.com/google-ads/answer/7684791

JSON representation 
{
  "headlines": [
    {
      object (AdTextAsset)
    }
  ],
  "descriptions": [
    {
      object (AdTextAsset)
    }
  ],
  "path1": string,
  "path2": string
}
Fields
headlines[]

object (AdTextAsset)

List of text assets for headlines. When the ad serves the headlines will be selected from this list.
descriptions[]

object (AdTextAsset)

List of text assets for descriptions. When the ad serves the descriptions will be selected from this list.
path1

string

First part of text that can be appended to the URL in the ad.
path2

string

Second part of text that can be appended to the URL in the ad. This field can only be set when path1 is also set.

LegacyResponsiveDisplayAdInfo

A legacy responsive display ad. Ads of this type are labeled 'Responsive ads' in the Google Ads UI.

JSON representation 
{
  "formatSetting": enum (DisplayAdFormatSetting),
  "shortHeadline": string,
  "longHeadline": string,
  "description": string,
  "businessName": string,
  "allowFlexibleColor": boolean,
  "accentColor": string,
  "mainColor": string,
  "callToActionText": string,
  "logoImage": string,
  "squareLogoImage": string,
  "marketingImage": string,
  "squareMarketingImage": string,
  "pricePrefix": string,
  "promoText": string
}
Fields
formatSetting

enum (DisplayAdFormatSetting)

Specifies which format the ad will be served in. Default is ALL_FORMATS.
shortHeadline

string

The short version of the ad's headline.
longHeadline

string

The long version of the ad's headline.
description

string

The description of the ad.
businessName

string

The business name in the ad.
allowFlexibleColor

boolean

Advertiser's consent to allow flexible color. When true, the ad may be served with different color if necessary. When false, the ad will be served with the specified colors or a neutral color. The default value is true. Must be true if mainColor and accentColor are not set.
accentColor

string

The accent color of the ad in hexadecimal, for example, #ffffff for white. If one of mainColor and accentColor is set, the other is required as well.
mainColor

string

The main color of the ad in hexadecimal, for example, #ffffff for white. If one of mainColor and accentColor is set, the other is required as well.
callToActionText

string

The call-to-action text for the ad.
logoImage

string

The MediaFile resource name of the logo image used in the ad.
squareLogoImage

string

The MediaFile resource name of the square logo image used in the ad.
marketingImage

string

The MediaFile resource name of the marketing image used in the ad.
squareMarketingImage

string

The MediaFile resource name of the square marketing image used in the ad.
pricePrefix

string

Prefix before price. For example, 'as low as'.
promoText

string

Promotion text used for dynamic formats of responsive ads. For example 'Free two-day shipping'.

DisplayAdFormatSetting

Enumerates display ad format settings.

Enums
UNSPECIFIED Not specified.
UNKNOWN The value is unknown in this version.
ALL_FORMATS Text, image and native formats.
NON_NATIVE Text and image formats.
NATIVE Native format, for example, the format rendering is controlled by the publisher and not by Google.

AppAdInfo

An app ad.

JSON representation 
{
  "mandatoryAdText": {
    object (AdTextAsset)
  },
  "headlines": [
    {
      object (AdTextAsset)
    }
  ],
  "descriptions": [
    {
      object (AdTextAsset)
    }
  ],
  "images": [
    {
      object (AdImageAsset)
    }
  ],
  "youtubeVideos": [
    {
      object (AdVideoAsset)
    }
  ],
  "html5MediaBundles": [
    {
      object (AdMediaBundleAsset)
    }
  ],
  "appDeepLink": {
    object (AdAppDeepLinkAsset)
  }
}
Fields
mandatoryAdText

object (AdTextAsset)

Mandatory ad text.
headlines[]

object (AdTextAsset)

List of text assets for headlines. When the ad serves the headlines will be selected from this list.
descriptions[]

object (AdTextAsset)

List of text assets for descriptions. When the ad serves the descriptions will be selected from this list.
images[]

object (AdImageAsset)

List of image assets that may be displayed with the ad.
youtubeVideos[]

object (AdVideoAsset)

List of YouTube video assets that may be displayed with the ad.
html5MediaBundles[]

object (AdMediaBundleAsset)

List of media bundle assets that may be used with the ad.

AdMediaBundleAsset

A media bundle asset used inside an ad.

JSON representation 
{
  "asset": string
}
Fields
asset

string

The Asset resource name of this media bundle.

AdAppDeepLinkAsset

An app deep link used inside an ad.

JSON representation 
{
  "asset": string
}
Fields
asset

string

The Asset resource name of this app deep link asset.

LegacyAppInstallAdInfo

A legacy app install ad that only can be used by a few select customers.

JSON representation 
{
  "appStore": enum (LegacyAppInstallAdAppStore),
  "appId": string,
  "headline": string,
  "description1": string,
  "description2": string
}
Fields
appStore

enum (LegacyAppInstallAdAppStore)

The app store the mobile app is available in.
appId

string

The ID of the mobile app.
headline

string

The headline of the ad.
description1

string

The first description line of the ad.
description2

string

The second description line of the ad.

LegacyAppInstallAdAppStore

App store type in a legacy app install ad.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
APPLE_APP_STORE Apple iTunes.
GOOGLE_PLAY Google Play.
WINDOWS_STORE Windows Store.
WINDOWS_PHONE_STORE Windows Phone Store.
CN_APP_STORE The app is hosted in a Chinese app store.

ResponsiveDisplayAdInfo

A responsive display ad.

JSON representation 
{
  "marketingImages": [
    {
      object (AdImageAsset)
    }
  ],
  "squareMarketingImages": [
    {
      object (AdImageAsset)
    }
  ],
  "logoImages": [
    {
      object (AdImageAsset)
    }
  ],
  "squareLogoImages": [
    {
      object (AdImageAsset)
    }
  ],
  "headlines": [
    {
      object (AdTextAsset)
    }
  ],
  "longHeadline": {
    object (AdTextAsset)
  },
  "descriptions": [
    {
      object (AdTextAsset)
    }
  ],
  "youtubeVideos": [
    {
      object (AdVideoAsset)
    }
  ],
  "formatSetting": enum (DisplayAdFormatSetting),
  "controlSpec": {
    object (ResponsiveDisplayAdControlSpec)
  },
  "businessName": string,
  "mainColor": string,
  "accentColor": string,
  "allowFlexibleColor": boolean,
  "callToActionText": string,
  "pricePrefix": string,
  "promoText": string
}
Fields
marketingImages[]

object (AdImageAsset)

Marketing images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 600x314 and the aspect ratio must be 1.91:1 (+-1%). At least one marketingImage is required. Combined with squareMarketingImages, the maximum is 15.
squareMarketingImages[]

object (AdImageAsset)

Square marketing images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 300x300 and the aspect ratio must be 1:1 (+-1%). At least one square marketingImage is required. Combined with marketingImages, the maximum is 15.
logoImages[]

object (AdImageAsset)

Logo images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 512x128 and the aspect ratio must be 4:1 (+-1%). Combined with squareLogoImages, the maximum is 5.
squareLogoImages[]

object (AdImageAsset)

Square logo images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 128x128 and the aspect ratio must be 1:1 (+-1%). Combined with logoImages, the maximum is 5.
headlines[]

object (AdTextAsset)

Short format headlines for the ad. The maximum length is 30 characters. At least 1 and max 5 headlines can be specified.
longHeadline

object (AdTextAsset)

A required long format headline. The maximum length is 90 characters.
descriptions[]

object (AdTextAsset)

Descriptive texts for the ad. The maximum length is 90 characters. At least 1 and max 5 headlines can be specified.
youtubeVideos[]

object (AdVideoAsset)

Optional YouTube videos for the ad. A maximum of 5 videos can be specified.
formatSetting

enum (DisplayAdFormatSetting)

Specifies which format the ad will be served in. Default is ALL_FORMATS.
controlSpec

object (ResponsiveDisplayAdControlSpec)

Specification for various creative controls.
businessName

string

The advertiser/brand name. Maximum display width is 25.
mainColor

string

The main color of the ad in hexadecimal, for example, #ffffff for white. If one of mainColor and accentColor is set, the other is required as well.
accentColor

string

The accent color of the ad in hexadecimal, for example, #ffffff for white. If one of mainColor and accentColor is set, the other is required as well.
allowFlexibleColor

boolean

Advertiser's consent to allow flexible color. When true, the ad may be served with different color if necessary. When false, the ad will be served with the specified colors or a neutral color. The default value is true. Must be true if mainColor and accentColor are not set.
callToActionText

string

The call-to-action text for the ad. Maximum display width is 30.
pricePrefix

string

Prefix before price. For example, 'as low as'.
promoText

string

Promotion text used for dynamic formats of responsive ads. For example 'Free two-day shipping'.

ResponsiveDisplayAdControlSpec

Specification for various creative controls for a responsive display ad.

JSON representation 
{
  "enableAssetEnhancements": boolean,
  "enableAutogenVideo": boolean
}
Fields
enableAssetEnhancements

boolean

Whether the advertiser has opted into the asset enhancements feature.
enableAutogenVideo

boolean

Whether the advertiser has opted into auto-gen video feature.

LocalAdInfo

A local ad.

JSON representation 
{
  "headlines": [
    {
      object (AdTextAsset)
    }
  ],
  "descriptions": [
    {
      object (AdTextAsset)
    }
  ],
  "callToActions": [
    {
      object (AdTextAsset)
    }
  ],
  "marketingImages": [
    {
      object (AdImageAsset)
    }
  ],
  "logoImages": [
    {
      object (AdImageAsset)
    }
  ],
  "videos": [
    {
      object (AdVideoAsset)
    }
  ],
  "path1": string,
  "path2": string
}
Fields
headlines[]

object (AdTextAsset)

List of text assets for headlines. When the ad serves the headlines will be selected from this list. At least 1 and at most 5 headlines must be specified.
descriptions[]

object (AdTextAsset)

List of text assets for descriptions. When the ad serves the descriptions will be selected from this list. At least 1 and at most 5 descriptions must be specified.
callToActions[]

object (AdTextAsset)

List of text assets for call-to-actions. When the ad serves the call-to-actions will be selected from this list. At least 1 and at most 5 call-to-actions must be specified.
marketingImages[]

object (AdImageAsset)

List of marketing image assets that may be displayed with the ad. The images must be 314x600 pixels or 320x320 pixels. At least 1 and at most 20 image assets must be specified.
logoImages[]

object (AdImageAsset)

List of logo image assets that may be displayed with the ad. The images must be 128x128 pixels and not larger than 120KB. At least 1 and at most 5 image assets must be specified.
videos[]

object (AdVideoAsset)

List of YouTube video assets that may be displayed with the ad. At least 1 and at most 20 video assets must be specified.
path1

string

First part of optional text that can be appended to the URL in the ad.
path2

string

Second part of optional text that can be appended to the URL in the ad. This field can only be set when path1 is also set.

DisplayUploadAdInfo

A generic type of display ad. The exact ad format is controlled by the displayUploadProductType field, which determines what kinds of data need to be included with the ad.

JSON representation 
{
  "displayUploadProductType": enum (DisplayUploadProductType),

  // Union field media_asset can be only one of the following:
  "mediaBundle": {
    object (AdMediaBundleAsset)
  }
  // End of list of possible types for union field media_asset.
}
Fields
displayUploadProductType

enum (DisplayUploadProductType)

The product type of this ad. See comments on the enum for details.
Union field media_asset. The asset data that makes up the ad. media_asset can be only one of the following:
mediaBundle

object (AdMediaBundleAsset)

A media bundle asset to be used in the ad. For information about the media bundle for HTML5_UPLOAD_AD, see https://support.google.com/google-ads/answer/1722096 Media bundles that are part of dynamic product types use a special format that needs to be created through the Google Web Designer. See https://support.google.com/webdesigner/answer/7543898 for more information.

DisplayUploadProductType

Enumerates display upload product types.

Enums
UNSPECIFIED Not specified.
UNKNOWN The value is unknown in this version.
HTML5_UPLOAD_AD HTML5 upload ad. This product type requires the upload_media_bundle field in DisplayUploadAdInfo to be set.
DYNAMIC_HTML5_EDUCATION_AD Dynamic HTML5 education ad. This product type requires the upload_media_bundle field in DisplayUploadAdInfo to be set. Can only be used in an education campaign.
DYNAMIC_HTML5_FLIGHT_AD Dynamic HTML5 flight ad. This product type requires the upload_media_bundle field in DisplayUploadAdInfo to be set. Can only be used in a flight campaign.
DYNAMIC_HTML5_HOTEL_RENTAL_AD Dynamic HTML5 hotel and rental ad. This product type requires the upload_media_bundle field in DisplayUploadAdInfo to be set. Can only be used in a hotel campaign.
DYNAMIC_HTML5_JOB_AD Dynamic HTML5 job ad. This product type requires the upload_media_bundle field in DisplayUploadAdInfo to be set. Can only be used in a job campaign.
DYNAMIC_HTML5_LOCAL_AD Dynamic HTML5 local ad. This product type requires the upload_media_bundle field in DisplayUploadAdInfo to be set. Can only be used in a local campaign.
DYNAMIC_HTML5_REAL_ESTATE_AD Dynamic HTML5 real estate ad. This product type requires the upload_media_bundle field in DisplayUploadAdInfo to be set. Can only be used in a real estate campaign.
DYNAMIC_HTML5_CUSTOM_AD Dynamic HTML5 custom ad. This product type requires the upload_media_bundle field in DisplayUploadAdInfo to be set. Can only be used in a custom campaign.
DYNAMIC_HTML5_TRAVEL_AD Dynamic HTML5 travel ad. This product type requires the upload_media_bundle field in DisplayUploadAdInfo to be set. Can only be used in a travel campaign.
DYNAMIC_HTML5_HOTEL_AD Dynamic HTML5 hotel ad. This product type requires the upload_media_bundle field in DisplayUploadAdInfo to be set. Can only be used in a hotel campaign.

AppEngagementAdInfo

App engagement ads allow you to write text encouraging a specific action in the app, like checking in, making a purchase, or booking a flight. They allow you to send users to a specific part of your app where they can find what they're looking for easier and faster.

JSON representation 
{
  "headlines": [
    {
      object (AdTextAsset)
    }
  ],
  "descriptions": [
    {
      object (AdTextAsset)
    }
  ],
  "images": [
    {
      object (AdImageAsset)
    }
  ],
  "videos": [
    {
      object (AdVideoAsset)
    }
  ]
}
Fields
headlines[]

object (AdTextAsset)

List of text assets for headlines. When the ad serves the headlines will be selected from this list.
descriptions[]

object (AdTextAsset)

List of text assets for descriptions. When the ad serves the descriptions will be selected from this list.
images[]

object (AdImageAsset)

List of image assets that may be displayed with the ad.
videos[]

object (AdVideoAsset)

List of video assets that may be displayed with the ad.

ShoppingComparisonListingAdInfo

A Shopping Comparison Listing ad.

JSON representation 
{
  "headline": string
}
Fields
headline

string

Headline of the ad. This field is required. Allowed length is between 25 and 45 characters.

AppPreRegistrationAdInfo

App pre-registration ads link to your app or game listing on Google Play, and can run on Google Play, on YouTube (in-stream only), and within other apps and mobile websites on the Display Network. It will help capture people's interest in your app or game and generate an early install base for your app or game before a launch.

JSON representation 
{
  "headlines": [
    {
      object (AdTextAsset)
    }
  ],
  "descriptions": [
    {
      object (AdTextAsset)
    }
  ],
  "images": [
    {
      object (AdImageAsset)
    }
  ],
  "youtubeVideos": [
    {
      object (AdVideoAsset)
    }
  ]
}
Fields
headlines[]

object (AdTextAsset)

List of text assets for headlines. When the ad serves the headlines will be selected from this list.
descriptions[]

object (AdTextAsset)

List of text assets for descriptions. When the ad serves the descriptions will be selected from this list.
images[]

object (AdImageAsset)

List of image asset IDs whose images may be displayed with the ad.
youtubeVideos[]

object (AdVideoAsset)

List of YouTube video asset IDs whose videos may be displayed with the ad.

DemandGenMultiAssetAdInfo

A Demand Gen multi asset ad.

JSON representation 
{
  "marketingImages": [
    {
      object (AdImageAsset)
    }
  ],
  "squareMarketingImages": [
    {
      object (AdImageAsset)
    }
  ],
  "portraitMarketingImages": [
    {
      object (AdImageAsset)
    }
  ],
  "tallPortraitMarketingImages": [
    {
      object (AdImageAsset)
    }
  ],
  "logoImages": [
    {
      object (AdImageAsset)
    }
  ],
  "headlines": [
    {
      object (AdTextAsset)
    }
  ],
  "descriptions": [
    {
      object (AdTextAsset)
    }
  ],
  "businessName": string,
  "callToActionText": string,
  "leadFormOnly": boolean
}
Fields
marketingImages[]

object (AdImageAsset)

Marketing image assets to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 600x314 and the aspect ratio must be 1.91:1 (+-1%). Required if squareMarketingImages is not present. Combined with squareMarketingImages, portraitMarketingImages, and tallPortraitMarketingImages the maximum is 20.
squareMarketingImages[]

object (AdImageAsset)

Square marketing image assets to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 300x300 and the aspect ratio must be 1:1 (+-1%). Required if marketingImages is not present. Combined with marketingImages, portraitMarketingImages, and tallPortraitMarketingImages the maximum is 20.
portraitMarketingImages[]

object (AdImageAsset)

Portrait marketing image assets to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 480x600 and the aspect ratio must be 4:5 (+-1%). Combined with marketingImages, squareMarketingImages, and tallPortraitMarketingImages the maximum is 20.
tallPortraitMarketingImages[]

object (AdImageAsset)

Tall portrait marketing image assets to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 600x1067 and the aspect ratio must be 9:16 (+-1%). Combined with marketingImages, squareMarketingImages, and portraitMarketingImages, the maximum is 20.
logoImages[]

object (AdImageAsset)

Logo image assets to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 128x128 and the aspect ratio must be 1:1 (+-1%). At least 1 and max 5 logo images can be specified.
headlines[]

object (AdTextAsset)

Headline text asset of the ad. Maximum display width is 30. At least 1 and max 5 headlines can be specified.
descriptions[]

object (AdTextAsset)

The descriptive text of the ad. Maximum display width is 90. At least 1 and max 5 descriptions can be specified.
businessName

string

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

string

Call to action text.
leadFormOnly

boolean

Boolean option that indicates if this ad must be served with lead form.

DemandGenCarouselAdInfo

A Demand Gen carousel ad.

JSON representation 
{
  "businessName": string,
  "logoImage": {
    object (AdImageAsset)
  },
  "headline": {
    object (AdTextAsset)
  },
  "description": {
    object (AdTextAsset)
  },
  "callToActionText": string,
  "carouselCards": [
    {
      object (AdDemandGenCarouselCardAsset)
    }
  ]
}
Fields
businessName

string

Required. The Advertiser/brand name.
logoImage

object (AdImageAsset)

Required. Logo image to be used in the ad. The minimum size is 128x128 and the aspect ratio must be 1:1 (+-1%).
headline

object (AdTextAsset)

Required. Headline of the ad.
description

object (AdTextAsset)

Required. The descriptive text of the ad.
callToActionText

string

Call to action text.
carouselCards[]

object (AdDemandGenCarouselCardAsset)

Required. Carousel cards that will display with the ad. Min 2 max 10.

AdDemandGenCarouselCardAsset

A Demand Gen carousel card asset used inside an ad.

JSON representation 
{
  "asset": string
}
Fields
asset

string

The Asset resource name of this discovery carousel card.

DemandGenVideoResponsiveAdInfo

A Demand Gen video responsive ad.

JSON representation 
{
  "headlines": [
    {
      object (AdTextAsset)
    }
  ],
  "longHeadlines": [
    {
      object (AdTextAsset)
    }
  ],
  "descriptions": [
    {
      object (AdTextAsset)
    }
  ],
  "videos": [
    {
      object (AdVideoAsset)
    }
  ],
  "logoImages": [
    {
      object (AdImageAsset)
    }
  ],
  "breadcrumb1": string,
  "breadcrumb2": string,
  "businessName": {
    object (AdTextAsset)
  },
  "callToActions": [
    {
      object (AdCallToActionAsset)
    }
  ]
}
Fields
headlines[]

object (AdTextAsset)

List of text assets used for the short headline.
longHeadlines[]

object (AdTextAsset)

List of text assets used for the long headline.
descriptions[]

object (AdTextAsset)

List of text assets used for the description.
videos[]

object (AdVideoAsset)

List of YouTube video assets used for the ad.
logoImages[]

object (AdImageAsset)

Logo image to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 128x128 and the aspect ratio must be 1:1 (+-1%).
breadcrumb1

string

First part of text that appears in the ad with the displayed URL.
breadcrumb2

string

Second part of text that appears in the ad with the displayed URL.
businessName

object (AdTextAsset)

Required. The advertiser/brand name.
callToActions[]

object (AdCallToActionAsset)

Assets of type CallToActionAsset used for the "Call To Action" button.

AdCallToActionAsset

A call to action asset used inside an ad.

JSON representation 
{
  "asset": string
}
Fields
asset

string

The Asset resource name of this call to action asset.

DemandGenProductAdInfo

A Demand Gen product ad.

JSON representation 
{
  "breadcrumb1": string,
  "breadcrumb2": string,
  "businessName": {
    object (AdTextAsset)
  },
  "headline": {
    object (AdTextAsset)
  },
  "description": {
    object (AdTextAsset)
  },
  "logoImage": {
    object (AdImageAsset)
  },
  "callToAction": {
    object (AdCallToActionAsset)
  }
}
Fields
breadcrumb1

string

First part of text that appears in the ad with the displayed URL.
breadcrumb2

string

Second part of text that appears in the ad with the displayed URL.
businessName

object (AdTextAsset)

Required. The advertiser/brand name.
headline

object (AdTextAsset)

Required. Text asset used for the short headline.
description

object (AdTextAsset)

Required. Text asset used for the description.
logoImage

object (AdImageAsset)

Required. Logo image to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 128x128 and the aspect ratio must be 1:1 (+-1%).
callToAction

object (AdCallToActionAsset)

Asset of type CallToActionAsset used for the "Call To Action" button.

TravelAdInfo

This type has no fields.

A travel ad.