Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

REST Resource: customers.ads

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.

CustomParameter

A mapping that can be used by custom parameter tags in a trackingUrlTemplate, finalUrls, or mobile_final_urls.

JSON representation 
{
  "key": string,
  "value": string
}
Fields
key

string

The key matching the parameter tag name.
value

string

The value to be substituted.

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_OUTSTREAM_AD Video outstream 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.
DISCOVERY_MULTI_ASSET_AD Discovery multi asset ad.

Device

Enumerates Google Ads devices available for targeting.

Enums
UNSPECIFIED Not specified.
UNKNOWN The value is unknown in this version.
MOBILE Mobile devices with full browsers.
TABLET Tablets with full browsers.
DESKTOP Computers.
CONNECTED_TV Smart TVs and game consoles.
OTHER Other device types.

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.

CallConversionReportingState

Possible data types for a call conversion action state.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
DISABLED Call conversion action is disabled.
USE_ACCOUNT_LEVEL_CALL_CONVERSION_ACTION Call conversion action will use call conversion type set at the account level.
USE_RESOURCE_LEVEL_CALL_CONVERSION_ACTION Call conversion action will use call conversion type set at the resource (call only ads/call extensions) level.

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

A hotel ad.

ShoppingSmartAdInfo

A Smart Shopping ad.

ShoppingProductAdInfo

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:
  "mediaFile": string,
  "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:
mediaFile

string

The MediaFile resource to use for the image.
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.

MimeType

The mime type

Enums
UNSPECIFIED The mime type has not been specified.
UNKNOWN

The received value is not known in this version.

This is a response-only value.
IMAGE_JPEG MIME type of image/jpeg.
IMAGE_GIF MIME type of image/gif.
IMAGE_PNG MIME type of image/png.
FLASH MIME type of application/x-shockwave-flash.
TEXT_HTML MIME type of text/html.
PDF MIME type of application/pdf.
MSWORD MIME type of application/msword.
MSEXCEL MIME type of application/vnd.ms-excel.
RTF MIME type of application/rtf.
AUDIO_WAV MIME type of audio/wav.
AUDIO_MP3 MIME type of audio/mp3.
HTML5_AD_ZIP MIME type of application/x-html5-ad-zip.

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
}
Fields
asset

string

The Asset resource name of this video.

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.

AdImageAsset

An image asset used inside an ad.

JSON representation 
{
  "asset": string
}
Fields
asset

string

The Asset resource name of this image.

VideoBumperInStreamAdInfo

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

JSON representation 
{
  "companionBanner": {
    object (AdImageAsset)
  }
}
Fields
companionBanner

object (AdImageAsset)

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

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, for example, the "Call To Action" banner. 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.

AdTextAsset

A text asset used inside an ad.

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

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

enum (AssetPerformanceLabel)

The performance label of this text asset.
policySummaryInfo

object (AdAssetPolicySummary)

The policy summary of this text asset.
text

string

Asset text.

ServedAssetFieldType

The possible asset field types.

Enums
UNSPECIFIED No value has been specified.
UNKNOWN

The received value is not known in this version.

This is a response-only value.
HEADLINE_1 The asset is used in headline 1.
HEADLINE_2 The asset is used in headline 2.
HEADLINE_3 The asset is used in headline 3.
DESCRIPTION_1 The asset is used in description 1.
DESCRIPTION_2 The asset is used in description 2.

AssetPerformanceLabel

Enum describing the possible performance labels of an asset, usually computed in the context of a linkage.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
PENDING This asset does not yet have any performance informantion. This may be because it is still under review.
LEARNING The asset has started getting impressions but the stats are not statistically significant enough to get an asset performance label.
LOW Worst performing assets.
GOOD Good performing assets.
BEST Best performing assets.

AdAssetPolicySummary

Contains policy information for an asset inside an ad.

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

object (PolicyTopicEntry)

The list of policy findings for this asset.
reviewStatus

enum (PolicyReviewStatus)

Where in the review process this asset.
approvalStatus

enum (PolicyApprovalStatus)

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

PolicyTopicEntry

Policy finding attached to a resource (for example, alcohol policy associated with a site that sells alcohol).

Each PolicyTopicEntry has a topic that indicates the specific ads policy the entry is about and a type to indicate the effect that the entry will have on serving. It may optionally have one or more evidences that indicate the reason for the finding. It may also optionally have one or more constraints that provide details about how serving may be restricted.

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

enum (PolicyTopicEntryType)

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

object (PolicyTopicEvidence)

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

object (PolicyTopicConstraint)

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

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.

PolicyTopicEntryType

The possible policy topic entry types.

Enums
UNSPECIFIED No value has been specified.
UNKNOWN

The received value is not known in this version.

This is a response-only value.
PROHIBITED The resource will not be served.
LIMITED The resource will not be served under some circumstances.
FULLY_LIMITED The resource cannot serve at all because of the current targeting criteria.
DESCRIPTIVE May be of interest, but does not limit how the resource is served.
BROADENING Could increase coverage beyond normal.
AREA_OF_INTEREST_ONLY Constrained for all targeted countries, but may serve in other countries through area of interest.

PolicyTopicEvidence

Additional information that explains a policy finding.

JSON representation 
{

  // 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.
}
Fields
Union field value. Specific evidence information depending on the evidence type. value can be only one of the following:
websiteList

object (WebsiteList)

List of websites linked with this resource.
textList

object (TextList)

List of evidence found in the text of a resource.
languageCode

string

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

object (DestinationTextList)

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

object (DestinationMismatch)

Mismatch between the destinations of a resource's URLs.
destinationNotWorking

object (DestinationNotWorking)

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

WebsiteList

A list of websites that caused a policy finding. Used for ONE_WEBSITE_PER_AD_GROUP policy topic, for example. In case there are more than five websites, only the top five (those that appear in resources the most) will be listed here.

JSON representation 
{
  "websites": [
    string
  ]
}
Fields
websites[]

string

Websites that caused the policy finding.

TextList

A list of fragments of text that violated a policy.

JSON representation 
{
  "texts": [
    string
  ]
}
Fields
texts[]

string

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

DestinationTextList

A list of strings found in a destination page that caused a policy finding.

JSON representation 
{
  "destinationTexts": [
    string
  ]
}
Fields
destinationTexts[]

string

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

DestinationMismatch

Evidence of mismatches between the URLs of a resource.

JSON representation 
{
  "urlTypes": [
    enum (PolicyTopicEvidenceDestinationMismatchUrlType)
  ]
}
Fields
urlTypes[]

enum (PolicyTopicEvidenceDestinationMismatchUrlType)

The set of URLs that did not match each other.

PolicyTopicEvidenceDestinationMismatchUrlType

The possible policy topic evidence destination mismatch url types.

Enums
UNSPECIFIED No value has been specified.
UNKNOWN

The received value is not known in this version.

This is a response-only value.
DISPLAY_URL The display url.
FINAL_URL The final url.
FINAL_MOBILE_URL The final mobile url.
TRACKING_URL The tracking url template, with substituted desktop url.
MOBILE_TRACKING_URL The tracking url template, with substituted mobile url.

DestinationNotWorking

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

JSON representation 
{
  "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.
}
Fields
device

enum (PolicyTopicEvidenceDestinationNotWorkingDevice)

The type of device that failed to load the URL.
expandedUrl

string

The full URL that didn't work.
lastCheckedDateTime

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"
Union field reason. Indicates the reason of the DESTINATION_NOT_WORKING policy finding. reason can be only one of the following:
dnsErrorType

enum (PolicyTopicEvidenceDestinationNotWorkingDnsErrorType)

The type of DNS error.
httpErrorCode

string (int64 format)

The HTTP error code.

PolicyTopicEvidenceDestinationNotWorkingDevice

The possible policy topic evidence destination not working devices.

Enums
UNSPECIFIED No value has been specified.
UNKNOWN

The received value is not known in this version.

This is a response-only value.
DESKTOP Landing page doesn't work on desktop device.
ANDROID Landing page doesn't work on Android device.
IOS Landing page doesn't work on iOS device.

PolicyTopicEvidenceDestinationNotWorkingDnsErrorType

The possible policy topic evidence destination not working DNS error types.

Enums
UNSPECIFIED No value has been specified.
UNKNOWN

The received value is not known in this version.

This is a response-only value.
HOSTNAME_NOT_FOUND Host name not found in DNS when fetching landing page.
GOOGLE_CRAWLER_DNS_ISSUE Google internal crawler issue when communicating with DNS. This error doesn't mean the landing page doesn't work. Google will recrawl the landing page.

PolicyTopicConstraint

Describes the effect on serving that a policy topic entry will have.

JSON representation 
{

  // 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.
}
Fields
Union field value. Specific information about the constraint. value can be only one of the following:
countryConstraintList

object (CountryConstraintList)

Countries where the resource cannot serve.
resellerConstraint

object (ResellerConstraint)

Reseller constraint.
certificateMissingInCountryList

object (CountryConstraintList)

Countries where a certificate is required for serving.
certificateDomainMismatchInCountryList

object (CountryConstraintList)

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

CountryConstraintList

A list of countries where a resource's serving is constrained.

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

object (CountryConstraint)

Countries in which serving is restricted.
totalTargetedCountries

integer

Total number of countries targeted by the resource.

CountryConstraint

Indicates that a resource's ability to serve in a particular country is constrained.

JSON representation 
{
  "countryCriterion": string
}
Fields
countryCriterion

string

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

ResellerConstraint

Indicates that a policy topic was constrained due to disapproval of the website for reseller purposes.

PolicyReviewStatus

The possible policy review statuses.

Enums
UNSPECIFIED No value has been specified.
UNKNOWN

The received value is not known in this version.

This is a response-only value.
REVIEW_IN_PROGRESS Currently under review.
REVIEWED Primary review complete. Other reviews may be continuing.
UNDER_APPEAL The resource has been resubmitted for approval or its policy decision has been appealed.
ELIGIBLE_MAY_SERVE The resource is eligible and may be serving but could still undergo further review.

PolicyApprovalStatus

The possible policy approval statuses. When there are several approval statuses available the most severe one will be used. The order of severity is DISAPPROVED, AREA_OF_INTEREST_ONLY, APPROVED_LIMITED and APPROVED.

Enums
UNSPECIFIED No value has been specified.
UNKNOWN

The received value is not known in this version.

This is a response-only value.
DISAPPROVED Will not serve.
APPROVED_LIMITED Serves with restrictions.
APPROVED Serves without restrictions.
AREA_OF_INTEREST_ONLY Will not serve in targeted countries, but may serve for users who are searching for information about the targeted countries.

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)
    }
  ]
}
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.

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 select