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, "agencyId": long, "HTMLSnippet": string, "videoURL": string, "clickThroughUrl": [ string ], "vendorType": [ integer ], "attribute": [ integer ], "width": integer, "height": integer, "advertiserName": string, "status": string, "disapprovalReasons": [ { "reason": string, "details": [ string ] } ], "advertiserId": [ long ], "sensitiveCategories": [ integer ], "restrictedCategories": [ integer ], "productCategories": [ integer ], "corrections": [ { "reason": string, "details": [ 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 should not be set. |
writable |
accountId |
integer |
Account ID. | |
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. | |
agencyId |
long |
The agency id for this creative. | writable |
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 the buyer-declarable-creative-attributes.txt file. |
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[].details[] |
list |
Additional details about the correction. | |
corrections[].reason |
string |
The type of correction that was applied to the creative.
Acceptable values are:
|
|
disapprovalReasons[] |
list |
The reasons for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests. | |
disapprovalReasons[].details[] |
list |
Additional details about the reason for disapproval. | |
disapprovalReasons[].reason |
string |
The categorized reason for disapproval.
Acceptable values are:
|
|
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. Please refer to the creative-status-codes.txt file for different statuses. | |
height |
integer |
Ad height in pixels. | |
kind |
string |
Resource type. This is always "adexchangebuyer#creative ". |
|
productCategories[] |
list |
Detected product categories, if any. Read-only. Each category is represented by an integer as defined in the ad-product-categories.txt file. 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 file. | writable |
sensitiveCategories[] |
list |
Detected sensitive categories, if any. Read-only. Each category is represented by an integer as defined in the ad-sensitive-categories.txt file. This field should not be set in requests. | |
status |
string |
Creative serving status. Read-only. This field should not be set in requests.
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 the vendors.txt file. |
writable |
videoURL |
string |
The URL from which a video ad loads; that is, the URL to use to fetch that video ad. The resource at this URL is usually an XML document that contains a standard format for loading the video, plus tracking information. This is not the same as an HTML snippet, which is only for non-video ads. If set, HTMLSnippet should not be set. |
writable |
width |
integer |
Ad width in pixels. |
Methods
- 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.