REST Resource: buyers.creatives

  • The Creative resource represents an ad creative and its classification data.

  • Key fields include name, accountId, creativeId, creativeFormat, and various declared attributes.

  • Creative content can be in HTML, video, native, or a render URL format.

  • Methods are available to create, get, list, and update creatives.

Resource: Creative

A creative and its classification data.

JSON representation 
{
  "name": string,
  "accountId": string,
  "creativeId": string,
  "creativeFormat": enum (CreativeFormat),
  "agencyId": string,
  "declaredClickThroughUrls": [
    string
  ],
  "impressionTrackingUrls": [
    string
  ],
  "adChoicesDestinationUrl": string,
  "restrictedCategories": [
    enum (RestrictedCategory)
  ],
  "declaredAttributes": [
    enum (CreativeAttribute)
  ],
  "declaredVendorIds": [
    integer
  ],
  "declaredRestrictedCategories": [
    enum (RestrictedCategory)
  ],
  "advertiserName": string,
  "version": integer,
  "apiUpdateTime": string,
  "dealIds": [
    string
  ],
  "creativeServingDecision": {
    object (CreativeServingDecision)
  },

  // Union field content can be only one of the following:
  "html": {
    object (HtmlContent)
  },
  "video": {
    object (VideoContent)
  },
  "native": {
    object (NativeContent)
  },
  "renderUrl": string
  // End of list of possible types for union field content.
}
Fields
name

string

Output only. Name of the creative. Follows the pattern buyers/{buyer}/creatives/{creative}, where {buyer} represents the account ID of the buyer who owns the creative, and {creative} is the buyer-specific creative ID that references this creative in the bid response.
accountId

string (int64 format)

Output only. ID of the buyer account that this creative is owned by. Can be used to filter the response of the creatives.list method with equality and inequality check.
creativeId

string

Buyer-specific creative ID that references this creative in bid responses. This field is Ignored in update operations. Can be used to filter the response of the creatives.list method. The maximum length of the creative ID is 128 bytes.
creativeFormat

enum (CreativeFormat)

Output only. The format of this creative. Can be used to filter the response of the creatives.list method.
agencyId

string (int64 format)

The agency ID for this creative.
declaredClickThroughUrls[]

string

The set of declared destination URLs for the creative. Can be used to filter the response of the creatives.list method.
impressionTrackingUrls[]

string

The set of URLs to be called to record an impression.
adChoicesDestinationUrl

string

The link to AdChoices destination page. This is only supported for native ads.
restrictedCategories[]
(deprecated)

enum (RestrictedCategory)

All restricted categories for the ads that may be shown from this creative.
declaredAttributes[]

enum (CreativeAttribute)

All declared attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method.

If the excluded_attribute field of a bid request contains one of the attributes that were declared or detected for a given creative, and a bid is submitted with that creative, the bid will be filtered before the auction.
declaredVendorIds[]

integer

IDs for the declared ad technology vendors that may be used by this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values. Can be used to filter the response of the creatives.list method.
declaredRestrictedCategories[]
(deprecated)

enum (RestrictedCategory)

All declared restricted categories for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method.
advertiserName

string

The name of the company being advertised in the creative. Can be used to filter the response of the creatives.list method.
version
(deprecated)

integer

Output only. The version of the creative. Version for a new creative is 1 and it increments during subsequent creative updates.
apiUpdateTime

string (Timestamp format)

Output only. The last update timestamp of the creative through the API.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
dealIds[]

string

Output only. IDs of all of the deals with which this creative has been used in bidding. Can be used to filter the response of the creatives.list method.
creativeServingDecision

object (CreativeServingDecision)

Output only. Top level status and detected attributes of a creative (for example domain, language, advertiser, product category, etc.) that affect whether (status) and where (context) a creative will be allowed to serve.
Union field content. Creative content in different formats. content can be only one of the following:
html

object (HtmlContent)

An HTML creative.
video

object (VideoContent)

A video creative.
native

object (NativeContent)

A native creative.
renderUrl

string

Experimental field that can be used during the FLEDGE Origin Trial. The URL to fetch an interest group ad used in TURTLEDOVE on-device auction. This should be unique among all creatives for a given accountId. This URL should be the same as the URL returned by generateBid().

Methods

create

 Creates a creative.

get

 Gets a creative.

list

 Lists creatives as they are at the time of the initial request.

patch

 Updates a creative.