- Resource: Ad
- FinalAppUrl
- AppUrlOperatingSystemType
- CustomParameter
- AdType
- Device
- UrlCollection
- SystemManagedResourceSource
- TextAdInfo
- ExpandedTextAdInfo
- CallAdInfo
- CallConversionReportingState
- ExpandedDynamicSearchAdInfo
- HotelAdInfo
- ShoppingSmartAdInfo
- ShoppingProductAdInfo
- ImageAdInfo
- MimeType
- AdImageAsset
- VideoAdInfo
- AdVideoAsset
- VideoTrueViewInStreamAdInfo
- VideoBumperInStreamAdInfo
- VideoOutstreamAdInfo
- VideoNonSkippableInStreamAdInfo
- InFeedVideoAdInfo
- VideoThumbnail
- VideoResponsiveAdInfo
- AdTextAsset
- ServedAssetFieldType
- AssetPerformanceLabel
- AdAssetPolicySummary
- PolicyTopicEntry
- PolicyTopicEntryType
- PolicyTopicEvidence
- WebsiteList
- TextList
- DestinationTextList
- DestinationMismatch
- PolicyTopicEvidenceDestinationMismatchUrlType
- DestinationNotWorking
- PolicyTopicEvidenceDestinationNotWorkingDevice
- PolicyTopicEvidenceDestinationNotWorkingDnsErrorType
- PolicyTopicConstraint
- CountryConstraintList
- CountryConstraint
- ResellerConstraint
- PolicyReviewStatus
- PolicyApprovalStatus
- ResponsiveSearchAdInfo
- LegacyResponsiveDisplayAdInfo
- DisplayAdFormatSetting
- AppAdInfo
- AdMediaBundleAsset
- LegacyAppInstallAdInfo
- LegacyAppInstallAdAppStore
- ResponsiveDisplayAdInfo
- ResponsiveDisplayAdControlSpec
- LocalAdInfo
- DisplayUploadAdInfo
- DisplayUploadProductType
- AppEngagementAdInfo
- ShoppingComparisonListingAdInfo
- SmartCampaignAdInfo
- AppPreRegistrationAdInfo
- DiscoveryMultiAssetAdInfo
- DiscoveryCarouselAdInfo
- AdDiscoveryCarouselCardAsset
- DiscoveryVideoResponsiveAdInfo
- AdCallToActionAsset
- DemandGenProductAdInfo
- TravelAdInfo
- Methods
Resource: Ad
An ad.
JSON representation |
---|
{ "resourceName": string, "finalUrls": [ string ], "finalAppUrls": [ { object ( |
Fields | |
---|---|
resourceName |
Immutable. The resource name of the ad. Ad resource names have the form:
|
finalUrls[] |
The list of possible final URLs after all cross-domain redirects for the ad. |
finalAppUrls[] |
A list of final app URLs that will be used on mobile if the user has the specific app installed. |
finalMobileUrls[] |
The list of possible final mobile URLs after all cross-domain redirects for the ad. |
urlCustomParameters[] |
The list of mappings that can be used to substitute custom parameter tags in a |
type |
Output only. The type of ad. |
devicePreference |
The device preference for the ad. You can only specify a preference for mobile devices. When this preference is set the ad will be preferred over other ads when being displayed on a mobile device. The ad can still be displayed on other device types, for example, if no other ads are available. If unspecified (no device preference), all devices are targeted. This is only supported by some ad types. |
urlCollections[] |
Additional URLs for the ad that are tagged with a unique identifier that can be referenced from other fields in the ad. |
systemManagedResourceSource |
Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. |
id |
Output only. The ID of the ad. |
trackingUrlTemplate |
The URL template for constructing a tracking URL. |
finalUrlSuffix |
The suffix to use when constructing a final URL. |
displayUrl |
The URL that appears in the ad description for some ad formats. |
addedByGoogleAds |
Output only. Indicates if this ad was automatically added by Google Ads and not by a user. For example, this could happen when ads are automatically created as suggestions for new ads based on knowledge of how existing ads are performing. |
name |
Immutable. The name of the ad. This is only used to be able to identify the ad. It does not need to be unique and does not affect the served ad. The name field is currently only supported for DisplayUploadAd, ImageAd, ShoppingComparisonListingAd and VideoAd. |
Union field ad_data . Details pertinent to the ad type. Exactly one value must be set. ad_data can be only one of the following: |
|
textAd |
Immutable. Details pertaining to a text ad. |
expandedTextAd |
Details pertaining to an expanded text ad. |
callAd |
Details pertaining to a call ad. |
expandedDynamicSearchAd |
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 |
hotelAd |
Details pertaining to a hotel ad. |
shoppingSmartAd |
Details pertaining to a Smart Shopping ad. |
shoppingProductAd |
Details pertaining to a Shopping product ad. |
imageAd |
Immutable. Details pertaining to an Image ad. |
videoAd |
Details pertaining to a Video ad. |
videoResponsiveAd |
Details pertaining to a Video responsive ad. |
responsiveSearchAd |
Details pertaining to a responsive search ad. |
legacyResponsiveDisplayAd |
Details pertaining to a legacy responsive display ad. |
appAd |
Details pertaining to an app ad. |
legacyAppInstallAd |
Immutable. Details pertaining to a legacy app install ad. |
responsiveDisplayAd |
Details pertaining to a responsive display ad. |
localAd |
Details pertaining to a local ad. |
displayUploadAd |
Details pertaining to a display upload ad. |
appEngagementAd |
Details pertaining to an app engagement ad. |
shoppingComparisonListingAd |
Details pertaining to a Shopping Comparison Listing ad. |
smartCampaignAd |
Details pertaining to a Smart campaign ad. |
appPreRegistrationAd |
Details pertaining to an app pre-registration ad. |
discoveryMultiAssetAd |
Details pertaining to a discovery multi asset ad. |
discoveryCarouselAd |
Details pertaining to a discovery carousel ad. |
discoveryVideoResponsiveAd |
Details pertaining to a discovery video responsive ad. |
demandGenProductAd |
Details pertaining to a Demand Gen product ad. |
travelAd |
Details pertaining to a travel ad. |
FinalAppUrl
A URL for deep linking into an app for the given operating system.
JSON representation |
---|
{
"osType": enum ( |
Fields | |
---|---|
osType |
The operating system targeted by this URL. Required. |
url |
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 |
The key matching the parameter tag name. |
value |
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. |
DISCOVERY_CAROUSEL_AD |
Discovery carousel ad. |
TRAVEL_AD |
Travel ad. |
DISCOVERY_VIDEO_RESPONSIVE_AD |
Discovery video responsive ad. |
DEMAND_GEN_PRODUCT_AD |
Demand Gen product 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[] |
A list of possible final URLs. |
finalMobileUrls[] |
A list of possible final mobile URLs. |
urlCollectionId |
Unique identifier for this UrlCollection instance. |
trackingUrlTemplate |
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 |
The headline of the ad. |
description1 |
The first line of the ad's description. |
description2 |
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 |
The first part of the ad's headline. |
headlinePart2 |
The second part of the ad's headline. |
headlinePart3 |
The third part of the ad's headline. |
description |
The description of the ad. |
description2 |
The second description of the ad. |
path1 |
The text that can appear alongside the ad's displayed URL. |
path2 |
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 ( |
Fields | |
---|---|
countryCode |
The country code in the ad. |
phoneNumber |
The phone number in the ad. |
businessName |
The business name in the ad. |
headline1 |
First headline in the ad. |
headline2 |
Second headline in the ad. |
description1 |
The first line of the ad's description. |
description2 |
The second line of the ad's description. |
callTracked |
Whether to enable call tracking for the creative. Enabling call tracking also enables call conversions. |
disableCallConversion |
Whether to disable call conversion for the creative. If set to |
phoneNumberVerificationUrl |
The URL to be used for phone number verification. |
conversionAction |
The conversion action to attribute a call conversion to. If not set a default conversion action is used. This field only has effect if |
conversionReportingState |
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 |
First part of text that can be appended to the URL in the ad. Optional. |
path2 |
Second part of text that can be appended to the URL in the ad. This field can only be set when |
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 |
The description of the ad. |
description2 |
The second description of the ad. |
HotelAdInfo
This type has no fields.
A hotel ad.
ShoppingSmartAdInfo
This type has no fields.
A Smart Shopping ad.
ShoppingProductAdInfo
This type has no fields.
A standard Shopping ad.
ImageAdInfo
An image ad.
JSON representation |
---|
{ "mimeType": enum ( |
Fields | |
---|---|
mimeType |
The mime type of the image. |
pixelWidth |
Width in pixels of the full size image. |
pixelHeight |
Height in pixels of the full size image. |
imageUrl |
URL of the full size image. |
previewPixelWidth |
Width in pixels of the preview size image. |
previewPixelHeight |
Height in pixels of the preview size image. |
previewImageUrl |
URL of the preview size image. |
name |
The name of the image. If the image was created from a MediaFile, this is the MediaFile's name. If the image was created from bytes, this is empty. |
Union field image . The image to create the ImageAd from. This can be specified in one of two ways. 1. An existing MediaFile resource. 2. The raw image data as bytes. image can be only one of the following: |
|
imageAsset |
The image assets used for the ad. |
data |
Raw image data as bytes. A base64-encoded string. |
adIdToCopyImageFrom |
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. |
AdImageAsset
An image asset used inside an ad.
JSON representation |
---|
{ "asset": string } |
Fields | |
---|---|
asset |
The Asset resource name of this image. |
VideoAdInfo
A video ad.
JSON representation |
---|
{ "video": { object ( |
Fields | |
---|---|
video |
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 |
Video TrueView in-stream ad format. |
bumper |
Video bumper in-stream ad format. |
outStream |
Video out-stream ad format. |
nonSkippable |
Video non-skippable in-stream ad format. |
inFeed |
In-feed video ad format. |
AdVideoAsset
A video asset used inside an ad.
JSON representation |
---|
{ "asset": string } |
Fields | |
---|---|
asset |
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 ( |
Fields | |
---|---|
actionButtonLabel |
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 |
Additional text displayed with the CTA (call-to-action) button to give context and encourage clicking on the button. |
companionBanner |
The image assets of the companion banner used with the ad. |
VideoBumperInStreamAdInfo
Representation of video bumper in-stream ad format (very short in-stream non-skippable video ad).
JSON representation |
---|
{
"companionBanner": {
object ( |
Fields | |
---|---|
companionBanner |
The image assets of the companion banner used with the ad. |
actionButtonLabel |
Label on the "Call To Action" button taking the user to the video ad's final URL. |
actionHeadline |
Additional text displayed with the CTA (call-to-action) button to give context and encourage clicking on the button. |
VideoOutstreamAdInfo
Representation of video out-stream ad format (ad shown alongside a feed with automatic playback, without sound).
JSON representation |
---|
{ "headline": string, "description": string } |
Fields | |
---|---|
headline |
The headline of the ad. |
description |
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 ( |
Fields | |
---|---|
companionBanner |
The image assets of the companion banner used with the ad. |
actionButtonLabel |
Label on the "Call To Action" button taking the user to the video ad's final URL. |
actionHeadline |
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 ( |
Fields | |
---|---|
headline |
The headline of the ad. |
description1 |
First text line for the ad. |
description2 |
Second text line for the ad. |
thumbnail |
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 ( |
Fields | |
---|---|
headlines[] |
List of text assets used for the short headline. Currently, only a single value for the short headline is supported. |
longHeadlines[] |
List of text assets used for the long headline. Currently, only a single value for the long headline is supported. |
descriptions[] |
List of text assets used for the description. Currently, only a single value for the description is supported. |
callToActions[] |
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[] |
List of YouTube video assets used for the ad. Currently, only a single value for the YouTube video asset is supported. |
companionBanners[] |
List of image assets used for the companion banner. Currently, only a single value for the companion banner asset is supported. |
breadcrumb1 |
First part of text that appears in the ad with the displayed URL. |
breadcrumb2 |
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 ( |
Fields | |
---|---|
pinnedField |
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 |
The performance label of this text asset. |
policySummaryInfo |
The policy summary of this text asset. |
text |
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. |
HEADLINE |
The asset was used in a headline. Use this only if there is only one headline in the ad. Otherwise, use the HEADLINE_1, HEADLINE_2 or HEADLINE_3 enums |
HEADLINE_IN_PORTRAIT |
The asset was used as a headline in portrait image. |
LONG_HEADLINE |
The asset was used in a long headline (used in MultiAssetResponsiveAd). |
DESCRIPTION |
The asset was used in a description. Use this only if there is only one description in the ad. Otherwise, use the DESCRIPTION_1 or DESCRIPTION_@ enums |
DESCRIPTION_IN_PORTRAIT |
The asset was used as description in portrait image. |
BUSINESS_NAME_IN_PORTRAIT |
The asset was used as business name in portrait image. |
BUSINESS_NAME |
The asset was used as business name. |
MARKETING_IMAGE |
The asset was used as a marketing image. |
MARKETING_IMAGE_IN_PORTRAIT |
The asset was used as a marketing image in portrait image. |
SQUARE_MARKETING_IMAGE |
The asset was used as a square marketing image. |
PORTRAIT_MARKETING_IMAGE |
The asset was used as a portrait marketing image. |
LOGO |
The asset was used as a logo. |
LANDSCAPE_LOGO |
The asset was used as a landscape logo. |
CALL_TO_ACTION |
The asset was used as a call-to-action. |
YOU_TUBE_VIDEO |
The asset was used as a YouTube video. |
SITELINK |
This asset is used as a sitelink. |
CALL |
This asset is used as a call. |
MOBILE_APP |
This asset is used as a mobile app. |
CALLOUT |
This asset is used as a callout. |
STRUCTURED_SNIPPET |
This asset is used as a structured snippet. |
PRICE |
This asset is used as a price. |
PROMOTION |
This asset is used as a promotion. |
AD_IMAGE |
This asset is used as an image. |
LEAD_FORM |
The asset is used as a lead form. |
BUSINESS_LOGO |
The asset is used as a business logo. |
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 ( |
Fields | |
---|---|
policyTopicEntries[] |
The list of policy findings for this asset. |
reviewStatus |
Where in the review process this asset. |
approvalStatus |
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 ( |
Fields | |
---|---|
type |
Describes the negative or positive effect this policy will have on serving. |
evidences[] |
Additional information that explains policy finding (for example, the brand name for a trademark finding). |
constraints[] |
Indicates how serving of this resource may be affected (for example, not serving in a country). |
topic |
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 |
Fields | |
---|---|
Union field value . Specific evidence information depending on the evidence type. value can be only one of the following: |
|
websiteList |
List of websites linked with this resource. |
textList |
List of evidence found in the text of a resource. |
languageCode |
The language the resource was detected to be written in. This is an IETF language tag such as "en-US". |
destinationTextList |
The text in the destination of the resource that is causing a policy finding. |
destinationMismatch |
Mismatch between the destinations of a resource's URLs. |
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[] |
Websites that caused the policy finding. |
TextList
A list of fragments of text that violated a policy.
JSON representation |
---|
{ "texts": [ string ] } |
Fields | |
---|---|
texts[] |
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[] |
List of text found in the resource's destination page. |
DestinationMismatch
Evidence of mismatches between the URLs of a resource.
JSON representation |
---|
{
"urlTypes": [
enum ( |
Fields | |
---|---|
urlTypes[] |
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 ( |
Fields | |
---|---|
device |
The type of device that failed to load the URL. |
expandedUrl |
The full URL that didn't work. |
lastCheckedDateTime |
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 |
The type of DNS error. |
httpErrorCode |
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 |
Fields | |
---|---|
Union field value . Specific information about the constraint. value can be only one of the following: |
|
countryConstraintList |
Countries where the resource cannot serve. |
resellerConstraint |
Reseller constraint. |
certificateMissingInCountryList |
Countries where a certificate is required for serving. |
certificateDomainMismatchInCountryList |
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 ( |
Fields | |
---|---|
countries[] |
Countries in which serving is restricted. |
totalTargetedCountries |
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 |
Geo target constant resource name of the country in which serving is constrained. |
ResellerConstraint
This type has no fields.
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 ( |
Fields | |
---|---|
headlines[] |
List of text assets for headlines. When the ad serves the headlines will be selected from this list. |
descriptions[] |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list. |
path1 |
First part of text that can be appended to the URL in the ad. |
path2 |
Second part of text that can be appended to the URL in the ad. This field can only be set when |
LegacyResponsiveDisplayAdInfo
A legacy responsive display ad. Ads of this type are labeled 'Responsive ads' in the Google Ads UI.
JSON representation |
---|
{
"formatSetting": enum ( |
Fields | |
---|---|
formatSetting |
Specifies which format the ad will be served in. Default is ALL_FORMATS. |
shortHeadline |
The short version of the ad's headline. |
longHeadline |
The long version of the ad's headline. |
description |
The description of the ad. |
businessName |
The business name in the ad. |
allowFlexibleColor |
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 |
accentColor |
The accent color of the ad in hexadecimal, for example, #ffffff for white. If one of |
mainColor |
The main color of the ad in hexadecimal, for example, #ffffff for white. If one of |
callToActionText |
The call-to-action text for the ad. |
logoImage |
The MediaFile resource name of the logo image used in the ad. |
squareLogoImage |
The MediaFile resource name of the square logo image used in the ad. |
marketingImage |
The MediaFile resource name of the marketing image used in the ad. |
squareMarketingImage |
The MediaFile resource name of the square marketing image used in the ad. |
pricePrefix |
Prefix before price. For example, 'as low as'. |
promoText |
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 ( |
Fields | |
---|---|
mandatoryAdText |
Mandatory ad text. |
headlines[] |
List of text assets for headlines. When the ad serves the headlines will be selected from this list. |
descriptions[] |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list. |
images[] |
List of image assets that may be displayed with the ad. |
youtubeVideos[] |
List of YouTube video assets that may be displayed with the ad. |
html5MediaBundles[] |
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 |
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 ( |
Fields | |
---|---|
appStore |
The app store the mobile app is available in. |
appId |
The ID of the mobile app. |
headline |
The headline of the ad. |
description1 |
The first description line of the ad. |
description2 |
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 ( |
Fields | |
---|---|
marketingImages[] |
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 |
squareMarketingImages[] |
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 |
logoImages[] |
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[] |
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 |
headlines[] |
Short format headlines for the ad. The maximum length is 30 characters. At least 1 and max 5 headlines can be specified. |
longHeadline |
A required long format headline. The maximum length is 90 characters. |
descriptions[] |
Descriptive texts for the ad. The maximum length is 90 characters. At least 1 and max 5 headlines can be specified. |
youtubeVideos[] |
Optional YouTube videos for the ad. A maximum of 5 videos can be specified. |
formatSetting |
Specifies which format the ad will be served in. Default is ALL_FORMATS. |
controlSpec |
Specification for various creative controls. |
businessName |
The advertiser/brand name. Maximum display width is 25. |
mainColor |
The main color of the ad in hexadecimal, for example, #ffffff for white. If one of |
accentColor |
The accent color of the ad in hexadecimal, for example, #ffffff for white. If one of |
allowFlexibleColor |
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 |
callToActionText |
The call-to-action text for the ad. Maximum display width is 30. |
pricePrefix |
Prefix before price. For example, 'as low as'. |
promoText |
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 |
Whether the advertiser has opted into the asset enhancements feature. |
enableAutogenVideo |
Whether the advertiser has opted into auto-gen video feature. |
LocalAdInfo
A local ad.
JSON representation |
---|
{ "headlines": [ { object ( |
Fields | |
---|---|
headlines[] |
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[] |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list. At least 1 and at most 5 descriptions must be specified. |
callToActions[] |
List of text assets for call-to-actions. When the ad serves the call-to-actions will be selected from this list. At least 1 and at most 5 call-to-actions must be specified. |
marketingImages[] |
List of marketing image assets that may be displayed with the ad. The images must be 314x600 pixels or 320x320 pixels. At least 1 and at most 20 image assets must be specified. |
logoImages[] |
List of logo image assets that may be displayed with the ad. The images must be 128x128 pixels and not larger than 120KB. At least 1 and at most 5 image assets must be specified. |
videos[] |
List of YouTube video assets that may be displayed with the ad. At least 1 and at most 20 video assets must be specified. |
path1 |
First part of optional text that can be appended to the URL in the ad. |
path2 |
Second part of optional text that can be appended to the URL in the ad. This field can only be set when |
DisplayUploadAdInfo
A generic type of display ad. The exact ad format is controlled by the displayUploadProductType
field, which determines what kinds of data need to be included with the ad.
JSON representation |
---|
{ "displayUploadProductType": enum ( |
Fields | |
---|---|
displayUploadProductType |
The product type of this ad. See comments on the enum for details. |
Union field media_asset . The asset data that makes up the ad. media_asset can be only one of the following: |
|
mediaBundle |
A media bundle asset to be used in the ad. For information about the media bundle for HTML5_UPLOAD_AD, see https://support.google.com/google-ads/answer/1722096 Media bundles that are part of dynamic product types use a special format that needs to be created through the Google Web Designer. See https://support.google.com/webdesigner/answer/7543898 for more information. |
DisplayUploadProductType
Enumerates display upload product types.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
The value is unknown in this version. |
HTML5_UPLOAD_AD |
HTML5 upload ad. This product type requires the upload_media_bundle field in DisplayUploadAdInfo to be set. |
DYNAMIC_HTML5_EDUCATION_AD |
Dynamic HTML5 education ad. This product type requires the upload_media_bundle field in DisplayUploadAdInfo to be set. Can only be used in an education campaign. |
DYNAMIC_HTML5_FLIGHT_AD |
Dynamic HTML5 flight ad. This product type requires the upload_media_bundle field in DisplayUploadAdInfo to be set. Can only be used in a flight campaign. |
DYNAMIC_HTML5_HOTEL_RENTAL_AD |
Dynamic HTML5 hotel and rental ad. This product type requires the upload_media_bundle field in DisplayUploadAdInfo to be set. Can only be used in a hotel campaign. |
DYNAMIC_HTML5_JOB_AD |
Dynamic HTML5 job ad. This product type requires the upload_media_bundle field in DisplayUploadAdInfo to be set. Can only be used in a job campaign. |
DYNAMIC_HTML5_LOCAL_AD |
Dynamic HTML5 local ad. This product type requires the upload_media_bundle field in DisplayUploadAdInfo to be set. Can only be used in a local campaign. |
DYNAMIC_HTML5_REAL_ESTATE_AD |
Dynamic HTML5 real estate ad. This product type requires the upload_media_bundle field in DisplayUploadAdInfo to be set. Can only be used in a real estate campaign. |
DYNAMIC_HTML5_CUSTOM_AD |
Dynamic HTML5 custom ad. This product type requires the upload_media_bundle field in DisplayUploadAdInfo to be set. Can only be used in a custom campaign. |
DYNAMIC_HTML5_TRAVEL_AD |
Dynamic HTML5 travel ad. This product type requires the upload_media_bundle field in DisplayUploadAdInfo to be set. Can only be used in a travel campaign. |
DYNAMIC_HTML5_HOTEL_AD |
Dynamic HTML5 hotel ad. This product type requires the upload_media_bundle field in DisplayUploadAdInfo to be set. Can only be used in a hotel campaign. |
AppEngagementAdInfo
App engagement ads allow you to write text encouraging a specific action in the app, like checking in, making a purchase, or booking a flight. They allow you to send users to a specific part of your app where they can find what they're looking for easier and faster.
JSON representation |
---|
{ "headlines": [ { object ( |
Fields | |
---|---|
headlines[] |
List of text assets for headlines. When the ad serves the headlines will be selected from this list. |
descriptions[] |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list. |
images[] |
List of image assets that may be displayed with the ad. |
videos[] |
List of video assets that may be displayed with the ad. |
ShoppingComparisonListingAdInfo
A Shopping Comparison Listing ad.
JSON representation |
---|
{ "headline": string } |
Fields | |
---|---|
headline |
Headline of the ad. This field is required. Allowed length is between 25 and 45 characters. |
SmartCampaignAdInfo
A Smart campaign ad.
JSON representation |
---|
{ "headlines": [ { object ( |
Fields | |
---|---|
headlines[] |
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. |
descriptions[] |
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. |
AppPreRegistrationAdInfo
App pre-registration ads link to your app or game listing on Google Play, and can run on Google Play, on YouTube (in-stream only), and within other apps and mobile websites on the Display Network. It will help capture people's interest in your app or game and generate an early install base for your app or game before a launch.
JSON representation |
---|
{ "headlines": [ { object ( |
Fields | |
---|---|
headlines[] |
List of text assets for headlines. When the ad serves the headlines will be selected from this list. |
descriptions[] |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list. |
images[] |
List of image asset IDs whose images may be displayed with the ad. |
youtubeVideos[] |
List of YouTube video asset IDs whose videos may be displayed with the ad. |
DiscoveryMultiAssetAdInfo
A discovery multi asset ad.
JSON representation |
---|
{ "marketingImages": [ { object ( |
Fields | |
---|---|
marketingImages[] |
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[] |
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 |
portraitMarketingImages[] |
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 |
logoImages[] |
Logo image assets to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 128x128 and the aspect ratio must be 1:1 ( -1%). At least 1 and max 5 logo images can be specified. |
headlines[] |
Headline text asset of the ad. Maximum display width is 30. At least 1 and max 5 headlines can be specified. |
descriptions[] |
The descriptive text of the ad. Maximum display width is 90. At least 1 and max 5 descriptions can be specified. |
businessName |
The Advertiser/brand name. Maximum display width is 25. Required. |
callToActionText |
Call to action text. |
leadFormOnly |
Boolean option that indicates if this ad must be served with lead form. |
DiscoveryCarouselAdInfo
A discovery carousel ad.
JSON representation |
---|
{ "businessName": string, "logoImage": { object ( |
Fields | |
---|---|
businessName |
Required. The Advertiser/brand name. |
logoImage |
Required. Logo image to be used in the ad. The minimum size is 128x128 and the aspect ratio must be 1:1 ( -1%). |
headline |
Required. Headline of the ad. |
description |
Required. The descriptive text of the ad. |
callToActionText |
Call to action text. |
carouselCards[] |
Required. Carousel cards that will display with the ad. Min 2 max 10. |
AdDiscoveryCarouselCardAsset
A discovery carousel card asset used inside an ad.
JSON representation |
---|
{ "asset": string } |
Fields | |
---|---|
asset |
The Asset resource name of this discovery carousel card. |
DiscoveryVideoResponsiveAdInfo
A discovery video responsive ad.
JSON representation |
---|
{ "headlines": [ { object ( |
Fields | |
---|---|
headlines[] |
List of text assets used for the short headline. |
longHeadlines[] |
List of text assets used for the long headline. |
descriptions[] |
List of text assets used for the description. |
videos[] |
List of YouTube video assets used for the ad. |
logoImages[] |
Logo image to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 128x128 and the aspect ratio must be 1:1 ( -1%). |
breadcrumb1 |
First part of text that appears in the ad with the displayed URL. |
breadcrumb2 |
Second part of text that appears in the ad with the displayed URL. |
businessName |
Required. The advertiser/brand name. |
callToActions[] |
Assets of type CallToActionAsset used for the "Call To Action" button. |
AdCallToActionAsset
A call to action asset used inside an ad.
JSON representation |
---|
{ "asset": string } |
Fields | |
---|---|
asset |
The Asset resource name of this call to action asset. |
DemandGenProductAdInfo
A Demand Gen product ad.
JSON representation |
---|
{ "breadcrumb1": string, "breadcrumb2": string, "businessName": { object ( |
Fields | |
---|---|
breadcrumb1 |
First part of text that appears in the ad with the displayed URL. |
breadcrumb2 |
Second part of text that appears in the ad with the displayed URL. |
businessName |
Required. The advertiser/brand name. |
headline |
Required. Text asset used for the short headline. |
description |
Required. Text asset used for the description. |
logoImage |
Required. Logo image to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 128x128 and the aspect ratio must be 1:1 ( -1%). |
callToAction |
Asset of type CallToActionAsset used for the "Call To Action" button. |
TravelAdInfo
This type has no fields.
A travel ad.
Methods |
|
---|---|
|
Returns the requested ad in full detail. |
|
Updates ads. |