REST Resource: customers.ads

{
  "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)
  },
  "discoveryMultiAssetAd": {
    object (DiscoveryMultiAssetAdInfo)
  },
  "discoveryCarouselAd": {
    object (DiscoveryCarouselAdInfo)
  },
  "discoveryVideoResponsiveAd": {
    object (DiscoveryVideoResponsiveAdInfo)
  },
  "travelAd": {
    object (TravelAdInfo)
  }
  // End of list of possible types for union field ad_data.
}

string

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

customers/{customerId}/ads/{ad_id}

string

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

object (FinalAppUrl)

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

string

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

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.

enum (AdType)

Output only. The type of ad.

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.

object (UrlCollection)

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

enum (SystemManagedResourceSource)

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

string (int64 format)

Output only. The ID of the ad.

string

The URL template for constructing a tracking URL.

string

The suffix to use when constructing a final URL.

string

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

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.

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.

object (TextAdInfo)

Immutable. Details pertaining to a text ad.

object (ExpandedTextAdInfo)

Details pertaining to an expanded text ad.

object (CallAdInfo)

Details pertaining to a call ad.

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.

object (HotelAdInfo)

Details pertaining to a hotel ad.

object (ShoppingSmartAdInfo)

Details pertaining to a Smart Shopping ad.

object (ShoppingProductAdInfo)

Details pertaining to a Shopping product ad.

object (ImageAdInfo)

Immutable. Details pertaining to an Image ad.

object (VideoAdInfo)

Details pertaining to a Video ad.

object (VideoResponsiveAdInfo)

Details pertaining to a Video responsive ad.

object (ResponsiveSearchAdInfo)

Details pertaining to a responsive search ad.

object (LegacyResponsiveDisplayAdInfo)

Details pertaining to a legacy responsive display ad.

object (AppAdInfo)

Details pertaining to an app ad.

object (LegacyAppInstallAdInfo)

Immutable. Details pertaining to a legacy app install ad.

object (ResponsiveDisplayAdInfo)

Details pertaining to a responsive display ad.

object (LocalAdInfo)

Details pertaining to a local ad.

object (DisplayUploadAdInfo)

Details pertaining to a display upload ad.

object (AppEngagementAdInfo)

Details pertaining to an app engagement ad.

object (ShoppingComparisonListingAdInfo)

Details pertaining to a Shopping Comparison Listing ad.

object (SmartCampaignAdInfo)

Details pertaining to a Smart campaign ad.

object (AppPreRegistrationAdInfo)

Details pertaining to an app pre-registration ad.

object (DiscoveryMultiAssetAdInfo)

Details pertaining to a discovery multi asset ad.

object (DiscoveryCarouselAdInfo)

Details pertaining to a discovery carousel ad.

object (DiscoveryVideoResponsiveAdInfo)

Details pertaining to a discovery video responsive ad.

object (TravelAdInfo)

Details pertaining to a travel ad.

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

enum (AppUrlOperatingSystemType)

The operating system targeted by this URL. Required.

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.

{
  "key": string,
  "value": string
}

string

The key matching the parameter tag name.

string

The value to be substituted.

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

string

A list of possible final URLs.

string

A list of possible final mobile URLs.

string

Unique identifier for this UrlCollection instance.

string

URL template for constructing a tracking URL.

{
  "headline": string,
  "description1": string,
  "description2": string
}

string

The headline of the ad.

string

The first line of the ad's description.

string

The second line of the ad's description.

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

string

The first part of the ad's headline.

string

The second part of the ad's headline.

string

The third part of the ad's headline.

string

The description of the ad.

string

The second description of the ad.

string

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

string

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

{
  "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
}

string

The country code in the ad.

string

The phone number in the ad.

string

The business name in the ad.

string

First headline in the ad.

string

Second headline in the ad.

string

The first line of the ad's description.

string

The second line of the ad's description.

boolean

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

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.

string

The URL to be used for phone number verification.

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.

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.

string

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

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.

{
  "description": string,
  "description2": string
}

string

The description of the ad.

string

The second description of the ad.

{
  "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:
  "mediaFile": string,
  "data": string,
  "adIdToCopyImageFrom": string
  // End of list of possible types for union field image.
}

enum (MimeType)

The mime type of the image.

string (int64 format)

Width in pixels of the full size image.

string (int64 format)

Height in pixels of the full size image.

string

URL of the full size image.

string (int64 format)

Width in pixels of the preview size image.

string (int64 format)

Height in pixels of the preview size image.

string

URL of the preview size image.

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.

string

The MediaFile resource to use for the image.

string (bytes format)

Raw image data as bytes.

A base64-encoded string.

string (int64 format)

An ad ID to copy the image from.

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

object (AdVideoAsset)

The YouTube video assets used for the ad.

object (VideoTrueViewInStreamAdInfo)

Video TrueView in-stream ad format.

object (VideoBumperInStreamAdInfo)

Video bumper in-stream ad format.

object (VideoOutstreamAdInfo)

Video out-stream ad format.

object (VideoNonSkippableInStreamAdInfo)

Video non-skippable in-stream ad format.

object (InFeedVideoAdInfo)

In-feed video ad format.

{
  "asset": string
}

string

The Asset resource name of this video.

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

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.

string

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

object (AdImageAsset)

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

{
  "asset": string
}

string

The Asset resource name of this image.

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

object (AdImageAsset)

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

string

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

string

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

{
  "headline": string,
  "description": string
}

string

The headline of the ad.

string

The description line.

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

object (AdImageAsset)

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

string

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

string

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

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

string

The headline of the ad.

string

First text line for the ad.

string

Second text line for the ad.

enum (VideoThumbnail)

Video thumbnail image to use.

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

object (AdTextAsset)

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

object (AdTextAsset)

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

object (AdTextAsset)

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

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.

object (AdVideoAsset)

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

object (AdImageAsset)

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

string

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

string

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

{
  "pinnedField": enum (ServedAssetFieldType),
  "assetPerformanceLabel": enum (AssetPerformanceLabel),
  "policySummaryInfo": {
    object (AdAssetPolicySummary)
  },
  "text": string
}

enum (ServedAssetFieldType)

The pinned field of the asset. This restricts the asset to only serve within this field. Multiple assets can be pinned to the same field. An asset that is unpinned or pinned to a different field will not serve in a field where some other asset has been pinned.

enum (AssetPerformanceLabel)

The performance label of this text asset.

object (AdAssetPolicySummary)

The policy summary of this text asset.

string

Asset text.

{
  "policyTopicEntries": [
    {
      object (PolicyTopicEntry)
    }
  ],
  "reviewStatus": enum (PolicyReviewStatus),
  "approvalStatus": enum (PolicyApprovalStatus)
}

object (PolicyTopicEntry)

The list of policy findings for this asset.

enum (PolicyReviewStatus)

Where in the review process this asset.

enum (PolicyApprovalStatus)

The overall approval status of this asset, which is calculated based on the status of its individual policy topic entries.

{
  "type": enum (PolicyTopicEntryType),
  "evidences": [
    {
      object (PolicyTopicEvidence)
    }
  ],
  "constraints": [
    {
      object (PolicyTopicConstraint)
    }
  ],
  "topic": string
}

enum (PolicyTopicEntryType)

Describes the negative or positive effect this policy will have on serving.

object (PolicyTopicEvidence)

Additional information that explains policy finding (for example, the brand name for a trademark finding).

object (PolicyTopicConstraint)

Indicates how serving of this resource may be affected (for example, not serving in a country).

string

Policy topic this finding refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time.

{

  // Union field value can be only one of the following:
  "websiteList": {
    object (WebsiteList)
  },
  "textList": {
    object (TextList)
  },
  "languageCode": string,
  "destinationTextList": {
    object (DestinationTextList)
  },
  "destinationMismatch": {
    object (DestinationMismatch)
  },
  "destinationNotWorking": {
    object (DestinationNotWorking)
  }
  // End of list of possible types for union field value.
}

object (WebsiteList)

List of websites linked with this resource.

object (TextList)

List of evidence found in the text of a resource.

string

The language the resource was detected to be written in. This is an IETF language tag such as "en-US".

object (DestinationTextList)

The text in the destination of the resource that is causing a policy finding.

object (DestinationMismatch)

Mismatch between the destinations of a resource's URLs.

object (DestinationNotWorking)

Details when the destination is returning an HTTP error code or isn't functional in all locations for commonly used devices.

{
  "websites": [
    string
  ]
}

string

Websites that caused the policy finding.

{
  "texts": [
    string
  ]
}

string

The fragments of text from the resource that caused the policy finding.

{
  "destinationTexts": [
    string
  ]
}

string

List of text found in the resource's destination page.

{
  "urlTypes": [
    enum (PolicyTopicEvidenceDestinationMismatchUrlType)
  ]
}

enum (PolicyTopicEvidenceDestinationMismatchUrlType)

The set of URLs that did not match each other.

{
  "device": enum (PolicyTopicEvidenceDestinationNotWorkingDevice),
  "expandedUrl": string,
  "lastCheckedDateTime": string,

  // Union field reason can be only one of the following:
  "dnsErrorType": enum (PolicyTopicEvidenceDestinationNotWorkingDnsErrorType),
  "httpErrorCode": string
  // End of list of possible types for union field reason.
}

enum (PolicyTopicEvidenceDestinationNotWorkingDevice)

The type of device that failed to load the URL.

string

The full URL that didn't work.

string

The time the URL was last checked. The format is "YYYY-MM-DD HH:MM:SS". Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"

enum (PolicyTopicEvidenceDestinationNotWorkingDnsErrorType)

The type of DNS error.

string (int64 format)

The HTTP error code.

{

  // Union field value can be only one of the following:
  "countryConstraintList": {
    object (CountryConstraintList)
  },
  "resellerConstraint": {
    object (ResellerConstraint)
  },
  "certificateMissingInCountryList": {
    object (CountryConstraintList)
  },
  "certificateDomainMismatchInCountryList": {
    object (CountryConstraintList)
  }
  // End of list of possible types for union field value.
}

object (CountryConstraintList)

Countries where the resource cannot serve.

object (ResellerConstraint)

Reseller constraint.

object (CountryConstraintList)

Countries where a certificate is required for serving.

object (CountryConstraintList)

Countries where the resource's domain is not covered by the certificates associated with it.

{
  "countries": [
    {
      object (CountryConstraint)
    }
  ],
  "totalTargetedCountries": integer
}

object (CountryConstraint)

Countries in which serving is restricted.

integer

Total number of countries targeted by the resource.

{
  "countryCriterion": string
}

string

Geo target constant resource name of the country in which serving is constrained.

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

object (AdTextAsset)

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

object (AdTextAsset)

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

string

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

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.

{
  "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
}

enum (DisplayAdFormatSetting)

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

string

The short version of the ad's headline.

string

The long version of the ad's headline.

string

The description of the ad.

string

The business name in the ad.

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.

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.

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.

string

The call-to-action text for the ad.

string

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

string

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

string

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

string

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

string

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

string

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

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

object (AdTextAsset)

Mandatory ad text.

object (AdTextAsset)

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

object (AdTextAsset)

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

object (AdImageAsset)

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

object (AdVideoAsset)

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

object (AdMediaBundleAsset)

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

{
  "asset": string
}

string

The Asset resource name of this media bundle.

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

enum (LegacyAppInstallAdAppStore)

The app store the mobile app is available in.

string

The ID of the mobile app.

string

The headline of the ad.

string

The first description line of the ad.

string

The second description line of the ad.

{
  "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
}

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.

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.

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.

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.

object (AdTextAsset)

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

object (AdTextAsset)

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

object (AdTextAsset)

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

object (AdVideoAsset)

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

enum (DisplayAdFormatSetting)

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

object (ResponsiveDisplayAdControlSpec)

Specification for various creative controls.

string

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

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.

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.

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.

string

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

string

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

string

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

{
  "enableAssetEnhancements": boolean,
  "enableAutogenVideo": boolean
}

boolean

Whether the advertiser has opted into the asset enhancements feature.

boolean

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

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

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.

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.

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.

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.

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.

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.

string

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

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.

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

enum (DisplayUploadProductType)

The product type of this ad. See comments on the enum for details.

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.

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

object (AdTextAsset)

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

object (AdTextAsset)

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

object (AdImageAsset)

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

object (AdVideoAsset)

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

{
  "headline": string
}

string

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

{
  "headlines": [
    {
      object (AdTextAsset)
    }
  ],
  "descriptions": [
    {
      object (AdTextAsset)
    }
  ]
}

object (AdTextAsset)

List of text assets, each of which corresponds to a headline when the ad serves. This list consists of a minimum of 3 and up to 15 text assets.

object (AdTextAsset)

List of text assets, each of which corresponds to a description when the ad serves. This list consists of a minimum of 2 and up to 4 text assets.

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

object (AdTextAsset)

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

object (AdTextAsset)

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

object (AdImageAsset)

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

object (AdVideoAsset)

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

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

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 and portraitMarketingImages the maximum is 20.

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 and portraitMarketingImages the maximum is 20.

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 and squareMarketingImages the maximum is 20.

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.

object (AdTextAsset)

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

object (AdTextAsset)

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

string

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

string

Call to action text.

boolean

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

{
  "businessName": string,
  "logoImage": {
    object (AdImageAsset)
  },
  "headline": {
    object (AdTextAsset)
  },
  "description": {
    object (AdTextAsset)
  },
  "callToActionText": string,
  "carouselCards": [
    {
      object (AdDiscoveryCarouselCardAsset)
    }
  ]
}

string

Required. The Advertiser/brand name.

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

object (AdTextAsset)

Required. Headline of the ad.

object (AdTextAsset)

Required. The descriptive text of the ad.

string

Call to action text.

object (AdDiscoveryCarouselCardAsset)

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

{
  "asset": string
}

string

The Asset resource name of this discovery carousel card.

{
  "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)
    }
  ]
}

object (AdTextAsset)

List of text assets used for the short headline.

object (AdTextAsset)

List of text assets used for the long headline.

object (AdTextAsset)

List of text assets used for the description.

object (AdVideoAsset)

List of YouTube video assets used for the ad.

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

string

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

string

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

object (AdTextAsset)

Required. The advertiser/brand name.

object (AdCallToActionAsset)

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

{
  "asset": string
}

string

The Asset resource name of this call to action asset.