REST Resource: customers.ads

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

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

{
  "teaser": {
    object (GmailTeaser)
  },
  "marketingImageDisplayCallToAction": {
    object (DisplayCallToAction)
  },
  "productImages": [
    {
      object (ProductImage)
    }
  ],
  "productVideos": [
    {
      object (ProductVideo)
    }
  ],
  "headerImage": string,
  "marketingImage": string,
  "marketingImageHeadline": string,
  "marketingImageDescription": string
}

object (GmailTeaser)

The Gmail teaser.

object (DisplayCallToAction)

Display-call-to-action of the marketing image.

object (ProductImage)

Product images. Up to 15 images are supported.

object (ProductVideo)

Product videos. Up to 7 videos are supported. At least one product video or a marketing image must be specified.

string

The MediaFile resource name of the header image. Valid image types are GIF, JPEG and PNG. The minimum size is 300x100 pixels and the aspect ratio must be between 3:1 and 5:1 (+-1%).

string

The MediaFile resource name of the marketing image. Valid image types are GIF, JPEG and PNG. The image must either be landscape with a minimum size of 600x314 pixels and aspect ratio of 600:314 (+-1%) or square with a minimum size of 300x300 pixels and aspect ratio of 1:1 (+-1%)

string

Headline of the marketing image.

string

Description of the marketing image.

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

string

Headline of the teaser.

string

Description of the teaser.

string

Business name of the advertiser.

string

The MediaFile resource name of the logo image. Valid image types are GIF, JPEG and PNG. The minimum size is 144x144 pixels and the aspect ratio must be 1:1 (+-1%).

{
  "text": string,
  "textColor": string,
  "urlCollectionId": string
}

string

Text for the display-call-to-action.

string

Text color for the display-call-to-action in hexadecimal, e.g. #ffffff for white.

string

Identifies the URL collection in the ad.url_collections field. If not set, the URL defaults to finalUrl.

{
  "displayCallToAction": {
    object (DisplayCallToAction)
  },
  "productImage": string,
  "description": string
}

object (DisplayCallToAction)

Display-call-to-action of the product image.

string

The MediaFile resource name of the product image. Valid image types are GIF, JPEG and PNG. The minimum size is 300x300 pixels and the aspect ratio must be 1:1 (+-1%).

string

Description of the product.

{
  "productVideo": string
}

string

The MediaFile resource name of a video which must be hosted on YouTube.

{
  "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)
  },
  "discovery": {
    object (VideoTrueViewDiscoveryAdInfo)
  }
  // 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 (VideoTrueViewDiscoveryAdInfo)

Video TrueView discovery 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)
  }
}

object (AdImageAsset)

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

{
  "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 a TrueView video discovery ad.

string

Second text line for a TrueView video discovery 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)
    }
  ]
}

object (AdTextAsset)

List of text assets used for the short headline, e.g. the "Call To Action" banner. 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, e.g. 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.

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

{
  "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, e.g. #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, e.g. #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. E.g. '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 squareLogoImages, 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, e.g. #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, e.g. #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. E.g. '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. Call-to-actions are optional and at most 5 can 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. Videos are optional and at most 20 can 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),
  "mediaBundle": {
    object (AdMediaBundleAsset)
  }
}

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 for headlines. When the ad serves the headlines will be selected from this list. 3 headlines must be specified.

object (AdTextAsset)

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

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