Skip to main content

creatives

Overview

Namecreatives
TypeResource
Idgoogleads.realtimebidding.creatives

Fields

NameDatatypeDescription
namestringOutput 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.
dealIdsarrayOutput 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.
adChoicesDestinationUrlstringThe link to AdChoices destination page. This is only supported for native ads.
creativeIdstringBuyer-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.
renderUrlstringExperimental 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.
creativeServingDecisionobjectTop level status and detected attributes of a creative.
impressionTrackingUrlsarrayThe set of URLs to be called to record an impression.
videoobjectVideo content for a creative.
htmlobjectHTML content for a creative.
versionintegerOutput only. The version of the creative. Version for a new creative is 1 and it increments during subsequent creative updates.
declaredAttributesarrayAll 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.
declaredClickThroughUrlsarrayThe set of declared destination URLs for the creative. Can be used to filter the response of the creatives.list method.
creativeFormatstringOutput only. The format of this creative. Can be used to filter the response of the creatives.list method.
restrictedCategoriesarrayAll restricted categories for the ads that may be shown from this creative.
declaredVendorIdsarrayIDs 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.
apiUpdateTimestringOutput only. The last update timestamp of the creative through the API.
agencyIdstringThe agency ID for this creative.
declaredRestrictedCategoriesarrayAll 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.
accountIdstringOutput 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.
advertiserNamestringThe name of the company being advertised in the creative. Can be used to filter the response of the creatives.list method.
nativeobjectNative content for a creative.

Methods

NameAccessible byRequired ParamsDescription
bidders_creatives_listSELECTbiddersIdLists creatives as they are at the time of the initial request. This call may take multiple hours to complete. For large, paginated requests, this method returns a snapshot of creatives at the time of request for the first page. lastStatusUpdate and creativeServingDecision may be outdated for creatives on sequential pages. We recommend Google Cloud Pub/Sub to view the latest status.
buyers_creatives_getSELECTbuyersId, creativesIdGets a creative.
buyers_creatives_listSELECTbuyersIdLists creatives as they are at the time of the initial request. This call may take multiple hours to complete. For large, paginated requests, this method returns a snapshot of creatives at the time of request for the first page. lastStatusUpdate and creativeServingDecision may be outdated for creatives on sequential pages. We recommend Google Cloud Pub/Sub to view the latest status.
buyers_creatives_createINSERTbuyersIdCreates a creative.
bidders_creatives_watchEXECbiddersIdWatches all creatives pertaining to a bidder. It is sufficient to invoke this endpoint once per bidder. A Pub/Sub topic will be created and notifications will be pushed to the topic when any of the bidder's creatives change status. All of the bidder's service accounts will have access to read from the topic. Subsequent invocations of this method will return the existing Pub/Sub configuration.
buyers_creatives_patchEXECbuyersId, creativesIdUpdates a creative.