The Creatives resource provides a way to submit new creatives to Google's creative verification pipeline.
For a list of methods for this resource, see the end of this page.
Resource representations
A creative and its classification data.
{ "kind": "adexchangebuyer#creative", "accountId": integer, "buyerCreativeId": string, "creativeStatusIdentityType": string, "agencyId": long, "version": integer, "apiUploadTimestamp": datetime, "HTMLSnippet": string, "nativeAd": { "headline": string, "body": string, "callToAction": string, "advertiser": string, "image": { "url": string, "width": integer, "height": integer }, "logo": { "url": string, "width": integer, "height": integer }, "appIcon": { "url": string, "width": integer, "height": integer }, "starRating": double, "impressionTrackingUrl": [ string ], "clickLinkUrl": string, "clickTrackingUrl": string, "price": string, "store": string, "videoURL": string }, "videoURL": string, "videoVastXML": string, "clickThroughUrl": [ string ], "adChoicesDestinationUrl": string, "impressionTrackingUrl": [ string ], "vendorType": [ integer ], "attribute": [ integer ], "width": integer, "height": integer, "advertiserName": string, "dealsStatus": string, "openAuctionStatus": string, "servingRestrictions": [ { "reason": string, "contexts": [ { "contextType": string, "geoCriteriaId": [ integer ], "platform": [ string ], "auctionType": [ string ] } ], "disapprovalReasons": [ { "reason": string, "details": [ string ] } ] } ], "advertiserId": [ long ], "sensitiveCategories": [ integer ], "restrictedCategories": [ integer ], "productCategories": [ integer ], "languages": [ string ], "detectedDomains": [ string ], "corrections": [ { "reason": string, "details": [ string ], "contexts": [ { "contextType": string, "geoCriteriaId": [ integer ], "platform": [ string ], "auctionType": [ string ] } ] } ], "filteringReasons": { "date": string, "reasons": [ { "filteringStatus": integer, "filteringCount": long } ] } }
Property name | Value | Description | Notes |
---|---|---|---|
HTMLSnippet |
string |
The HTML snippet that displays the ad when inserted in the web page. If set,
videoURL , videoVastXML , and
nativeAd should not be set. |
writable |
accountId |
integer |
Account ID. | |
adChoicesDestinationUrl |
string |
The link to the Ad Preferences page. This is only supported for native ads. | writable |
advertiserId[] |
list |
Detected advertiser ID, if any. Read-only. This field should not be set in requests. | |
advertiserName |
string |
The name of the company being advertised in the creative. The value provided must exist in the advertisers.txt file. | |
agencyId |
long |
The agency id for this creative. | writable |
apiUploadTimestamp |
datetime |
The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp). | |
attribute[] |
list |
List of buyer selectable attributes for the ads that may be shown from this snippet. Each attribute is represented by an integer as defined in buyer-declarable-creative-attributes.txt. | writable |
buyerCreativeId |
string |
A buyer-specific ID identifying the creative in this ad. | |
clickThroughUrl[] |
list |
The set of destination URLs for the snippet. | |
corrections[] |
list |
Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests. | |
corrections[].contexts[] |
list |
All known serving contexts containing serving status information. | |
corrections[].contexts[].auctionType[] |
list |
Only set when contextType=AUCTION_TYPE. Represents the auction types this correction applies to. | |
corrections[].contexts[].contextType |
string |
The type of context (e.g., location, platform, auction type, SSL-ness).
Acceptable values are:
|
|
corrections[].contexts[].geoCriteriaId[] |
list |
Only set when contextType=LOCATION. Represents the geo criterias this correction applies to. | |
corrections[].contexts[].platform[] |
list |
Only set when contextType=PLATFORM. Represents the platforms this correction applies to. | |
corrections[].details[] |
list |
Additional details about the correction. | |
corrections[].reason |
string |
The type of correction that was applied to the creative.
Acceptable values are:
|
|
creativeStatusIdentityType |
string |
Creative status identity type that the creative item applies to. Ad Exchange real-time bidding is migrating to the sizeless creative verification. Originally, Ad Exchange assigned creative verification status to a unique combination of a buyer creative ID and creative dimensions. Post-migration, a single verification status will be assigned at the buyer creative ID level. This field allows to distinguish whether a given creative status applies to a unique combination of a buyer creative ID and creative dimensions, or to a buyer creative ID as a whole.
Acceptable values are:
|
|
dealsStatus |
string |
Top-level deals status. Read-only. This field should not be set in requests. If disapproved, an entry for auctionType=DIRECT_DEALS (or ALL) in servingRestrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case it may be preferable to read from servingRestrictions directly.
Acceptable values are:
|
|
detectedDomains[] |
list |
Detected domains for this creative. Read-only. This field should not be set in requests. | |
filteringReasons |
object |
The filtering reasons for the creative. Read-only. This field should not be set in requests. | |
filteringReasons.date |
string |
The date in ISO 8601 format for the data. The data is collected from 00:00:00 to 23:59:59 in PST. | |
filteringReasons.reasons[] |
list |
The filtering reasons. | |
filteringReasons.reasons[].filteringCount |
long |
The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange. | |
filteringReasons.reasons[].filteringStatus |
integer |
The filtering status code as defined in creative-status-codes.txt. | |
height |
integer |
Ad height in pixels. | |
impressionTrackingUrl[] |
list |
The set of urls to be called to record an impression. | writable |
kind |
string |
Resource type. This is always "adexchangebuyer#creative ". |
|
languages[] |
list |
Detected languages for this creative. Read-only. This field should not be set in requests. | |
nativeAd |
object |
If nativeAd is set, HTMLSnippet, videoVastXML, and the videoURL outside of nativeAd should not be set. (The videoURL inside nativeAd can be set.) | writable |
nativeAd.advertiser |
string |
||
nativeAd.appIcon |
object |
The app icon, for app download ads. | |
nativeAd.appIcon.height |
integer |
||
nativeAd.appIcon.url |
string |
||
nativeAd.appIcon.width |
integer |
||
nativeAd.body |
string |
A long description of the ad. | |
nativeAd.callToAction |
string |
A label for the button that the user is supposed to click. | |
nativeAd.clickLinkUrl |
string |
The URL that the browser/SDK will load when the user clicks the ad. | |
nativeAd.clickTrackingUrl |
string |
The URL to use for click tracking. | |
nativeAd.headline |
string |
A short title for the ad. | |
nativeAd.image |
object |
A large image. | |
nativeAd.image.height |
integer |
||
nativeAd.image.url |
string |
||
nativeAd.image.width |
integer |
||
nativeAd.impressionTrackingUrl[] |
list |
The URLs are called when the impression is rendered. | |
nativeAd.logo |
object |
A smaller image, for the advertiser logo. | |
nativeAd.logo.height |
integer |
||
nativeAd.logo.url |
string |
||
nativeAd.logo.width |
integer |
||
nativeAd.price |
string |
The price of the promoted app including the currency info. | |
nativeAd.starRating |
double |
The app rating in the app store. Must be in the range [0-5]. | |
nativeAd.store |
string |
The URL to the app store to purchase/download the promoted app. | |
nativeAd.videoURL |
string |
The URL of the XML VAST for a native ad. Note this is a separate field from resource.video_url. | |
openAuctionStatus |
string |
Top-level open auction status. Read-only. This field should not be set in requests. If disapproved, an entry for auctionType=OPEN_AUCTION (or ALL) in servingRestrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case it may be preferable to read from ServingRestrictions directly.
Acceptable values are:
|
|
productCategories[] |
list |
Detected product categories, if any. Each category is represented by an integer as defined in ad-product-categories.txt. Read-only. This field should not be set in requests. | |
restrictedCategories[] |
list |
All restricted categories for the ads that may be shown from this snippet. Each category is represented by an integer as defined in the ad-restricted-categories.txt. | writable |
sensitiveCategories[] |
list |
Detected sensitive categories, if any. Each category is represented by an integer as defined in ad-sensitive-categories.txt. Read-only. This field should not be set in requests. | |
servingRestrictions[] |
list |
The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS vs HTTP request, or the type of auction). Read-only. This field should not be set in requests. See the examples in the Creatives guide for more details. | |
servingRestrictions[].contexts[] |
list |
All known contexts/restrictions. | |
servingRestrictions[].contexts[].auctionType[] |
list |
Only set when contextType=AUCTION_TYPE. Represents the auction types this restriction applies to. | |
servingRestrictions[].contexts[].contextType |
string |
The type of context (e.g., location, platform, auction type, SSL-ness).
Acceptable values are:
|
|
servingRestrictions[].contexts[].geoCriteriaId[] |
list |
Only set when contextType=LOCATION. Represents the geo criterias this restriction applies to. Impressions are considered to match a context if either the user location or publisher location matches a given geoCriteriaId. | |
servingRestrictions[].contexts[].platform[] |
list |
Only set when contextType=PLATFORM. Represents the platforms this restriction applies to. | |
servingRestrictions[].disapprovalReasons[] |
list |
The reasons for disapproval within this restriction, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED or CONDITIONALLY_APPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. | |
servingRestrictions[].disapprovalReasons[].details[] |
list |
Additional details about the reason for disapproval. | |
servingRestrictions[].disapprovalReasons[].reason |
string |
The categorized reason for disapproval.
Acceptable values are:
|
|
servingRestrictions[].reason |
string |
Why the creative is ineligible to serve in this context (e.g., it has been explicitly disapproved or is pending review).
Acceptable values are:
|
|
vendorType[] |
list |
List of vendor types for the ads that may be shown from this snippet. Each vendor type is represented by an integer as defined in vendors.txt. | writable |
version |
integer |
The version for this creative. Read-only. This field may not be set in requests, and is incremented automatically on every API upload. This field has a maximum limit of 20; subsequent attempts to update will result in an API error response. | |
videoURL |
string |
The URL to fetch a video ad. If set, HTMLSnippet, videoVastXML, and nativeAd should not be set. Note, this is different from resource.native_ad.video_url above. | writable |
videoVastXML |
string |
The contents of a VAST document for a video ad. This document should conform to the VAST 2.0 or 3.0 standard. If set, HTMLSnippet, videoURL, and nativeAd and should not be set. | writable |
width |
integer |
Ad width in pixels. |
Methods
- addDeal
- Add a deal id association for the creative.
- get
- Gets the status for a single creative. A creative will be available 30-40 minutes after submission.
- insert
- Inserts a new creative into Google's creative verification pipeline.
- list
- Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.
- listDeals
- Lists the external deal ids associated with the creative.
- removeDeal
- Remove a deal id associated with the creative.