- [Resource: Creative](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative) - [JSON representation](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.SCHEMA_REPRESENTATION) - [HtmlContent](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.HtmlContent) - [JSON representation](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.HtmlContent.SCHEMA_REPRESENTATION) - [VideoContent](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.VideoContent) - [JSON representation](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.VideoContent.SCHEMA_REPRESENTATION) - [VideoMetadata](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.VideoMetadata) - [JSON representation](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.VideoMetadata.SCHEMA_REPRESENTATION) - [VastVersion](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.VastVersion) - [MediaFile](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.MediaFile) - [JSON representation](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.MediaFile.SCHEMA_REPRESENTATION) - [VideoMimeType](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.VideoMimeType) - [NativeContent](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.NativeContent) - [JSON representation](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.NativeContent.SCHEMA_REPRESENTATION) - [Image](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.Image) - [JSON representation](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.Image.SCHEMA_REPRESENTATION) - [CreativeFormat](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.CreativeFormat) - [RestrictedCategory](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.RestrictedCategory) - [CreativeAttribute](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.CreativeAttribute) - [CreativeServingDecision](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.CreativeServingDecision) - [JSON representation](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.CreativeServingDecision.SCHEMA_REPRESENTATION) - [AdvertiserAndBrand](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.AdvertiserAndBrand) - [JSON representation](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.AdvertiserAndBrand.SCHEMA_REPRESENTATION) - [AdTechnologyProviders](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.AdTechnologyProviders) - [JSON representation](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.AdTechnologyProviders.SCHEMA_REPRESENTATION) - [PolicyCompliance](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.PolicyCompliance) - [JSON representation](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.PolicyCompliance.SCHEMA_REPRESENTATION) - [Status](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.Status) - [PolicyTopicEntry](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.PolicyTopicEntry) - [JSON representation](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.PolicyTopicEntry.SCHEMA_REPRESENTATION) - [PolicyTopicEvidence](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.PolicyTopicEvidence) - [JSON representation](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.PolicyTopicEvidence.SCHEMA_REPRESENTATION) - [DestinationNotWorkingEvidence](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.DestinationNotWorkingEvidence) - [JSON representation](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.DestinationNotWorkingEvidence.SCHEMA_REPRESENTATION) - [DnsError](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.DnsError) - [InvalidPage](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.InvalidPage) - [RedirectionError](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.RedirectionError) - [UrlRejected](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.UrlRejected) - [Platform](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.Platform) - [DestinationNotCrawlableEvidence](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.DestinationNotCrawlableEvidence) - [JSON representation](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.DestinationNotCrawlableEvidence.SCHEMA_REPRESENTATION) - [Reason](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.Reason) - [HttpCallEvidence](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.HttpCallEvidence) - [JSON representation](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.HttpCallEvidence.SCHEMA_REPRESENTATION) - [DomainCallEvidence](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.DomainCallEvidence) - [JSON representation](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.DomainCallEvidence.SCHEMA_REPRESENTATION) - [DomainCalls](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.DomainCalls) - [JSON representation](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.DomainCalls.SCHEMA_REPRESENTATION) - [HttpCookieEvidence](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.HttpCookieEvidence) - [JSON representation](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.HttpCookieEvidence.SCHEMA_REPRESENTATION) - [DestinationUrlEvidence](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.DestinationUrlEvidence) - [JSON representation](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.DestinationUrlEvidence.SCHEMA_REPRESENTATION) - [DownloadSizeEvidence](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.DownloadSizeEvidence) - [JSON representation](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.DownloadSizeEvidence.SCHEMA_REPRESENTATION) - [UrlDownloadSize](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.UrlDownloadSize) - [JSON representation](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.UrlDownloadSize.SCHEMA_REPRESENTATION) - [AdCategoryTaxonomy](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#Creative.AdCategoryTaxonomy) - [Methods](https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.creatives.md.txt#METHODS_SUMMARY) ## 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`) }, // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "html": { object (`HtmlContent`) }, "video": { object (`VideoContent`) }, "native": { object (`NativeContent`) }, "renderUrl": string // End of mutually exclusive fields. } ``` | | 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`)`` > [!WARNING] > Prefer declared_restricted_categories field over this field. 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](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) 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 for possible values. Can be used to filter the response of the `creatives.list` method. | | `declaredRestrictedCategories[] (deprecated)` | ``enum (`RestrictedCategory`)`` > [!WARNING] > Restricted categories will be detected by Google. Buyers are no longer required to declare them. 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` > [!WARNING] > Output only. Deprecated: Don't rely on `version` in your integration. 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 use 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. | | Creative content in different formats. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response: || | `html` | ``object (`HtmlContent`)`` An HTML creative. | | `video` | ``object (`VideoContent`)`` A video creative. | | `native` | ``object (`NativeContent`)`` A native creative. | | `renderUrl (deprecated)` | `string` > [!WARNING] > This item is deprecated! Deprecated: FLEDGE is no longer supported. See: Experimental field that can be used during the [FLEDGE Origin Trial](https://developers.google.com/authorized-buyers/rtb/fledge-origin-trial). The URL to fetch an interest group ad used in [TURTLEDOVE on-device auction](https://github.com/WICG/turtledove/blob/main/FLEDGE.md#1-browsers-record-interest-groups). This should be unique among all creatives for a given `accountId`. This URL should be the same as the URL returned by [generateBid()](https://github.com/WICG/turtledove/blob/main/FLEDGE.md#32-on-device-bidding). | | End of mutually exclusive fields. || ### HtmlContent HTML content for a creative. | JSON representation | |---| | ``` { "snippet": string, "width": integer, "height": integer } ``` | | Fields || |---|---| | `snippet` | `string` The HTML snippet that displays the ad when inserted in the web page. | | `width` | `integer` The width of the HTML snippet in pixels. Can be used to filter the response of the `creatives.list` method. | | `height` | `integer` The height of the HTML snippet in pixels. Can be used to filter the response of the `creatives.list` method. | ### VideoContent Video content for a creative. | JSON representation | |---| | ``` { "videoMetadata": { object (`VideoMetadata`) }, // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "videoUrl": string, "videoVastXml": string // End of mutually exclusive fields. } ``` | | Fields || |---|---| | `videoMetadata` | ``object (`VideoMetadata`)`` Output only. Video metadata. | | Video content in different formats. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response: || | `videoUrl` | `string` The URL to fetch a video ad. The URL should return an XML response that conforms to the VAST 2.0, 3.0 or 4.x standard. | | `videoVastXml` | `string` The contents of a VAST document for a video ad. This document should conform to the VAST 2.0, 3.0, or 4.x standard. | | End of mutually exclusive fields. || ### VideoMetadata Video metadata for a creative. | JSON representation | |---| | ``` { "isValidVast": boolean, "isVpaid": boolean, "skipOffset": string, "duration": string, "vastVersion": enum (`VastVersion`), "mediaFiles": [ { object (`MediaFile`) } ] } ``` | | Fields || |---|---| | `isValidVast` | `boolean` Is this a valid VAST ad? Can be used to filter the response of the `creatives.list` method. | | `isVpaid` | `boolean` Is this a VPAID ad? Can be used to filter the response of the `creatives.list` method. | | `skipOffset` | ``string (`Duration` format)`` The minimum duration that the user has to watch before being able to skip this ad. If the field is not set, the ad is not skippable. If the field is set, the ad is skippable. Can be used to filter the response of the `creatives.list` method. A duration in seconds with up to nine fractional digits, ending with '`s`'. Example: `"3.5s"`. | | `duration` | ``string (`Duration` format)`` The duration of the ad. Can be used to filter the response of the `creatives.list` method. A duration in seconds with up to nine fractional digits, ending with '`s`'. Example: `"3.5s"`. | | `vastVersion` | ``enum (`VastVersion`)`` The maximum VAST version across all wrapped VAST documents. Can be used to filter the response of the `creatives.list` method. | | `mediaFiles[]` | ``object (`MediaFile`)`` The list of all media files declared in the VAST. If there are multiple VASTs in a wrapper chain, this includes the media files from the deepest one in the chain. | ### VastVersion VAST versions. | Enums || |---|---| | `VAST_VERSION_UNSPECIFIED` | Default value that should never be used. | | `VAST_VERSION_1_0` | VAST 1.0 | | `VAST_VERSION_2_0` | VAST 2.0 | | `VAST_VERSION_3_0` | VAST 3.0 | | `VAST_VERSION_4_0` | VAST 4.0 | ### MediaFile Information about each media file in the VAST. | JSON representation | |---| | ``` { "mimeType": enum (`VideoMimeType`), "bitrate": string } ``` | | Fields || |---|---| | `mimeType` | ``enum (`VideoMimeType`)`` The MIME type of this media file. Can be used to filter the response of the `creatives.list` method. | | `bitrate` | `string (int64 format)` Bitrate of the video file, in Kbps. Can be used to filter the response of the `creatives.list` method. | ### VideoMimeType Common MIME types of video assets in VAST video ads. | Enums || |---|---| | `VIDEO_MIME_TYPE_UNSPECIFIED` | Default value that should never be used. | | `MIME_VIDEO_XFLV` | Flash container. | | `MIME_VIDEO_WEBM` | WebM container assuming VP9 codec. | | `MIME_VIDEO_MP4` | MPEG-4 container typically with H.264 codec. | | `MIME_VIDEO_OGG` | Ogg container assuming Theora codec. | | `MIME_VIDEO_YT_HOSTED` | Video files hosted on YouTube. | | `MIME_VIDEO_X_MS_WMV` | Windows Media Video Codec. | | `MIME_VIDEO_3GPP` | 3GPP container format used on 3G phones. | | `MIME_VIDEO_MOV` | Quicktime container format. | | `MIME_APPLICATION_SWF` | Shockwave Flash (used for VPAID ads). | | `MIME_APPLICATION_SURVEY` | Properties of VAST served by consumer survey. | | `MIME_APPLICATION_JAVASCRIPT` | JavaScript (used for VPAID ads). | | `MIME_APPLICATION_SILVERLIGHT` | Silverlight (used for VPAID ads). | | `MIME_APPLICATION_MPEGURL` | HLS/M3U8. | | `MIME_APPLICATION_MPEGDASH` | DASH. | | `MIME_AUDIO_MP4A` | MPEG-4 audio format. | | `MIME_AUDIO_MP3` | MPEG-3 audio format. | | `MIME_AUDIO_OGG` | Ogg audio format | ### NativeContent Native content for a creative. | JSON representation | |---| | ``` { "headline": string, "body": string, "callToAction": string, "advertiserName": string, "image": { object (`Image`) }, "logo": { object (`Image`) }, "appIcon": { object (`Image`) }, "starRating": number, "clickLinkUrl": string, "clickTrackingUrl": string, "priceDisplayText": string, // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "videoUrl": string, "videoVastXml": string // End of mutually exclusive fields. } ``` | | Fields || |---|---| | `headline` | `string` A short title for the ad. | | `body` | `string` A long description of the ad. | | `callToAction` | `string` A label for the button that the user is supposed to click. | | `advertiserName` | `string` The name of the advertiser or sponsor, to be displayed in the ad creative. | | `image` | ``object (`Image`)`` A large image. | | `logo` | ``object (`Image`)`` A smaller image, for the advertiser's logo. | | `appIcon` | ``object (`Image`)`` The app icon, for app download ads. | | `starRating` | `number` The app rating in the app store. Must be in the range \[0-5\]. | | `clickLinkUrl` | `string` The URL that the browser/SDK will load when the user clicks the ad. | | `clickTrackingUrl` | `string` The URL to use for click tracking. | | `priceDisplayText` | `string` The price of the promoted app including currency info. | | The video file. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response: || | `videoUrl` | `string` The URL to fetch a native video ad. | | `videoVastXml` | `string` The contents of a VAST document for a native video ad. | | End of mutually exclusive fields. || ### Image An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. | JSON representation | |---| | ``` { "url": string, "width": integer, "height": integer } ``` | | Fields || |---|---| | `url` | `string` The URL of the image. | | `width` | `integer` Image width in pixels. | | `height` | `integer` Image height in pixels. | ### CreativeFormat Creative formats | Enums || |---|---| | `CREATIVE_FORMAT_UNSPECIFIED` | The format is unknown. | | `HTML` | HTML creative. | | `VIDEO` | Video creative. | | `NATIVE` | Native creative. | ### RestrictedCategory > [!WARNING] > RestrictedCategory is no longer used. Restricted Categories for ads that may be shown from the creative. | Enums || |---|---| | `RESTRICTED_CATEGORY_UNSPECIFIED` | Default value that should never be used. | | `ALCOHOL` | The alcohol restricted category. | ### CreativeAttribute This is the set of attributes that can be declared to describe a creative. | Enums || |---|---| | `ATTRIBUTE_UNSPECIFIED` | Do not use. This is a placeholder value only. | | `IMAGE_RICH_MEDIA` | The creative is of type image/rich media. For pretargeting. | | `ADOBE_FLASH_FLV` | The creative is of video type Adobe Flash FLV. For pretargeting. | | `IS_TAGGED` | The creative is tagged. | | `IS_COOKIE_TARGETED` | The creative is cookie targeted. | | `IS_USER_INTEREST_TARGETED` | The creative is user interest targeted. | | `EXPANDING_DIRECTION_NONE` | The creative does not expand. | | `EXPANDING_DIRECTION_UP` | The creative expands up. | | `EXPANDING_DIRECTION_DOWN` | The creative expands down. | | `EXPANDING_DIRECTION_LEFT` | The creative expands left. | | `EXPANDING_DIRECTION_RIGHT` | The creative expands right. | | `EXPANDING_DIRECTION_UP_LEFT` | The creative expands up and left. | | `EXPANDING_DIRECTION_UP_RIGHT` | The creative expands up and right. | | `EXPANDING_DIRECTION_DOWN_LEFT` | The creative expands down and left. | | `EXPANDING_DIRECTION_DOWN_RIGHT` | The creative expands down and right. | | `CREATIVE_TYPE_HTML` | The creative type is HTML. | | `CREATIVE_TYPE_VAST_VIDEO` | The creative type is VAST video. | | `EXPANDING_DIRECTION_UP_OR_DOWN` | The creative expands up or down. | | `EXPANDING_DIRECTION_LEFT_OR_RIGHT` | The creative expands left or right. | | `EXPANDING_DIRECTION_ANY_DIAGONAL` | The creative expands on any diagonal. | | `EXPANDING_ACTION_ROLLOVER_TO_EXPAND` | The creative expands when rolled over. | | `INSTREAM_VAST_VIDEO_TYPE_VPAID_FLASH` | The instream vast video type is vpaid flash. | | `RICH_MEDIA_CAPABILITY_TYPE_MRAID` | The creative is MRAID. | | `RICH_MEDIA_CAPABILITY_TYPE_FLASH` | The creative is Flash. | | `RICH_MEDIA_CAPABILITY_TYPE_HTML5` | The creative is HTML5. | | `SKIPPABLE_INSTREAM_VIDEO` | The creative has an instream VAST video type of skippable instream video. For pretargeting. | | `RICH_MEDIA_CAPABILITY_TYPE_SSL` | The creative is SSL. | | `RICH_MEDIA_CAPABILITY_TYPE_NON_SSL` | The creative is non-SSL. | | `RICH_MEDIA_CAPABILITY_TYPE_INTERSTITIAL` | The creative is an interstitial. | | `NON_SKIPPABLE_INSTREAM_VIDEO` | The creative has an instream VAST video type of non-skippable instream video. For pretargeting. | | `NATIVE_ELIGIBILITY_ELIGIBLE` | The creative is eligible for native. | | `NON_VPAID` | The creative has an instream VAST video type of non-VPAID. For pretargeting. | | `NATIVE_ELIGIBILITY_NOT_ELIGIBLE` | The creative is not eligible for native. | | `ANY_INTERSTITIAL` | The creative has an interstitial size of any interstitial. For pretargeting. | | `NON_INTERSTITIAL` | The creative has an interstitial size of non interstitial. For pretargeting. | | `IN_BANNER_VIDEO` | The video type is in-banner video. | | `RENDERING_SIZELESS_ADX` | The creative can dynamically resize to fill a variety of slot sizes. | | `OMSDK_1_0` | The open measurement SDK is supported. | | `RENDERING_PLAYABLE` | The creative is considered a playable display creative. | ### CreativeServingDecision Top level status and detected attributes of a creative. | JSON representation | |---| | ``` { "detectedClickThroughUrls": [ string ], "detectedAdvertisers": [ { object (`AdvertiserAndBrand`) } ], "detectedProductCategories": [ integer ], "detectedLanguages": [ string ], "detectedDomains": [ string ], "detectedSensitiveCategories": [ integer ], "detectedAttributes": [ enum (`CreativeAttribute`) ], "detectedVendorIds": [ integer ], "adTechnologyProviders": { object (`AdTechnologyProviders`) }, "lastStatusUpdate": string, "dealsPolicyCompliance": { object (`PolicyCompliance`) }, "networkPolicyCompliance": { object (`PolicyCompliance`) }, "platformPolicyCompliance": { object (`PolicyCompliance`) }, "chinaPolicyCompliance": { object (`PolicyCompliance`) }, "russiaPolicyCompliance": { object (`PolicyCompliance`) }, "detectedCategoriesTaxonomy": enum (`AdCategoryTaxonomy`), "detectedCategories": [ string ] } ``` | | Fields || |---|---| | `detectedClickThroughUrls[]` | `string` The set of detected destination URLs for the creative. Can be used to filter the response of the `creatives.list` method. | | `detectedAdvertisers[]` | ``object (`AdvertiserAndBrand`)`` Detected advertisers and brands. | | `detectedProductCategories[]` | `integer` Detected product categories, if any. See the ad-product-categories.txt file in the technical documentation for a list of IDs. Can be used to filter the response of the `creatives.list` method. | | `detectedLanguages[]` | `string` The detected languages for this creative. The order is arbitrary. The codes are 2 or 5 characters and are documented at . Can be used to filter the response of the `creatives.list` method. | | `detectedDomains[]` | `string` The detected domains for this creative. | | `detectedSensitiveCategories[]` | `integer` Detected sensitive categories, if any. Can be used to filter the response of the `creatives.list` method. See the ad-sensitive-categories.txt file in the technical documentation for a list of IDs. You should use these IDs along with the excluded-sensitive-category field in the bid request to filter your bids. | | `detectedAttributes[]` | ``enum (`CreativeAttribute`)`` Publisher-excludable attributes that were detected for this creative. Can be used to filter the response of the `creatives.list` method. If the `excluded_attribute` field of a [bid request](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) 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. | | `detectedVendorIds[]` | `integer` IDs of the ad technology vendors that were detected to be used by this creative. See for possible values. Can be used to filter the response of the `creatives.list` method. If the `allowed_vendor_type` field of a [bid request](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) does not contain one of the vendor type IDs 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. | | `adTechnologyProviders` | ``object (`AdTechnologyProviders`)`` The detected ad technology providers. | | `lastStatusUpdate` | ``string (`Timestamp` format)`` The last time the creative status was updated. Can be used to filter the response of the `creatives.list` method. Uses RFC 3339, where generated output will always be Z-normalized and use 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"`. | | `dealsPolicyCompliance` | ``object (`PolicyCompliance`)`` Policy compliance of this creative when bidding on Programmatic Guaranteed and Preferred Deals (outside of Russia and China). | | `networkPolicyCompliance` | ``object (`PolicyCompliance`)`` Policy compliance of this creative when bidding in open auction, private auction, or auction packages (outside of Russia and China). | | `platformPolicyCompliance` | ``object (`PolicyCompliance`)`` Policy compliance of this creative when bidding in Open Bidding (outside of Russia and China). For the list of platform policies, see: . | | `chinaPolicyCompliance` | ``object (`PolicyCompliance`)`` The policy compliance of this creative in China. When approved or disapproved, this applies to both deals and open auction in China. When pending review, this creative is allowed to serve for deals but not for open auction. | | `russiaPolicyCompliance` | ``object (`PolicyCompliance`)`` The policy compliance of this creative in Russia. When approved or disapproved, this applies to both deals and open auction in Russia. When pending review, this creative is allowed to serve for deals but not for open auction. | | `detectedCategoriesTaxonomy` | ``enum (`AdCategoryTaxonomy`)`` Output only. The taxonomy in which the detectedCategories field is expressed. | | `detectedCategories[]` | `string` Output only. IDs of the detected categories. The taxonomy in which the categories are expressed is specified by the `detectedCategoriesTaxonomy` field. Use this in conjunction with BidRequest.bcat to avoid bidding on impressions where a given ad category is blocked, or to troubleshoot filtered bids. Can be used to filter the response of the `creatives.list` method. | ### AdvertiserAndBrand Detected advertiser and brand information. | JSON representation | |---| | ``` { "advertiserId": string, "advertiserName": string, "brandId": string, "brandName": string } ``` | | Fields || |---|---| | `advertiserId` | `string (int64 format)` See for the list of possible values. Can be used to filter the response of the `creatives.list` method. | | `advertiserName` | `string` Advertiser name. Can be used to filter the response of the `creatives.list` method. | | `brandId` | `string (int64 format)` Detected brand ID or zero if no brand has been detected. See for the list of possible values. Can be used to filter the response of the `creatives.list` method. | | `brandName` | `string` Brand name. Can be used to filter the response of the `creatives.list` method. | ### AdTechnologyProviders The list of detected Ad Technology Providers for this creative. Bids placed for inventory that will serve to EEA or UK users are expected to comply with GDPR requirements. You must ensure that the creatives used in such bids should contain only user consented ad technology providers as indicated in the bid request. Google reserves the right to filter non-compliant bids. User consented ad technology providers can be found in the [Google Protocol](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) with the `BidRequest.adslot.consented_providers_settings` field, and can be found as an [OpenRTB extension](https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto.md.txt) with the `BidRequest.user.ext.consented_providers_settings` and `BidRequest.user.ext.consent` fields. See for additional information about the Google TCF v2 integration. | JSON representation | |---| | ``` { "detectedProviderIds": [ string ], "detectedGvlIds": [ string ], "unidentifiedProviderDomains": [ string ] } ``` | | Fields || |---|---| | `detectedProviderIds[]` | `string (int64 format)` The detected [Google Ad Tech Providers (ATP)](https://support.google.com/admanager/answer/9012903) for this creative. See for mapping of provider ID to provided name, a privacy policy URL, and a list of domains which can be attributed to the provider. | | `detectedGvlIds[]` | `string (int64 format)` The detected IAB Global Vendor List (GVL) IDs for this creative. See the IAB Global Vendor List at for details about the vendors. | | `unidentifiedProviderDomains[]` | `string` Domains of detected unidentified ad technology providers (if any). You must ensure that the creatives used in bids placed for inventory that will serve to EEA or UK users does not contain unidentified ad technology providers. Google reserves the right to filter non-compliant bids. | ### PolicyCompliance Policy compliance of the creative for a transaction type or a region. | JSON representation | |---| | ``` { "status": enum (`Status`), "topics": [ { object (`PolicyTopicEntry`) } ] } ``` | | Fields || |---|---| | `status` | ``enum (`Status`)`` Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the `creatives.list` method. | | `topics[]` | ``object (`PolicyTopicEntry`)`` Topics related to the policy compliance for this transaction type (for example, open auction, deals) or region (for example, China, Russia). Topics may be present only if status is DISAPPROVED. | ### Status Status type. | Enums || |---|---| | `STATUS_UNSPECIFIED` | Default value that should never be used. | | `PENDING_REVIEW` | Creative is pending review. | | `DISAPPROVED` | Creative cannot serve. | | `APPROVED` | Creative is approved. | | `CERTIFICATE_REQUIRED` | Certificates are required for the creative to be served in some regions. > [!WARNING] > Deprecated: This status value is no longer used. | ### PolicyTopicEntry Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation. | JSON representation | |---| | ``` { "policyTopic": string, "helpCenterUrl": string, "evidences": [ { object (`PolicyTopicEvidence`) } ], "missingCertificate": boolean } ``` | | Fields || |---|---| | `policyTopic` | `string` Policy topic this entry 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. Can be used to filter the response of the `creatives.list` method | | `helpCenterUrl` | `string` URL of the help center article describing this policy topic. | | `evidences[]` | ``object (`PolicyTopicEvidence`)`` Pieces of evidence associated with this policy topic entry. | | `missingCertificate (deprecated)` | `boolean` > [!WARNING] > Deprecated: This field is no longer used, and will always be set to `false`. Whether or not the policy topic is missing a certificate. | ### PolicyTopicEvidence Evidence associated with a policy topic entry. | JSON representation | |---| | ``` { // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "destinationNotWorking": { object (`DestinationNotWorkingEvidence`) }, "destinationNotCrawlable": { object (`DestinationNotCrawlableEvidence`) }, "httpCall": { object (`HttpCallEvidence`) }, "domainCall": { object (`DomainCallEvidence`) }, "httpCookie": { object (`HttpCookieEvidence`) }, "destinationUrl": { object (`DestinationUrlEvidence`) }, "downloadSize": { object (`DownloadSizeEvidence`) } // End of mutually exclusive fields. } ``` | | Fields || |---|---| | Evidence associated with the policy topic entry. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response: || | `destinationNotWorking` | ``object (`DestinationNotWorkingEvidence`)`` The creative's destination URL did not function properly or was incorrectly set up. | | `destinationNotCrawlable` | ``object (`DestinationNotCrawlableEvidence`)`` The creative's destination URL was not crawlable by Google. | | `httpCall` | ``object (`HttpCallEvidence`)`` HTTP calls made by the creative that resulted in policy violations. | | `domainCall` | ``object (`DomainCallEvidence`)`` Number of HTTP calls made by the creative, broken down by domain. | | `httpCookie` | ``object (`HttpCookieEvidence`)`` Evidence for HTTP cookie-related policy violations. | | `destinationUrl` | ``object (`DestinationUrlEvidence`)`` URL of the actual landing page. | | `downloadSize` | ``object (`DownloadSizeEvidence`)`` Total download size and URL-level download size breakdown for resources in a creative. | | End of mutually exclusive fields. || ### DestinationNotWorkingEvidence Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. | JSON representation | |---| | ``` { "expandedUrl": string, "platform": enum (`Platform`), "lastCheckTime": string, // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "dnsError": enum (`DnsError`), "httpError": integer, "invalidPage": enum (`InvalidPage`), "redirectionError": enum (`RedirectionError`), "urlRejected": enum (`UrlRejected`) // End of mutually exclusive fields. } ``` | | Fields || |---|---| | `expandedUrl` | `string` The full non-working URL. | | `platform` | ``enum (`Platform`)`` Platform of the non-working URL. | | `lastCheckTime` | ``string (`Timestamp` format)`` Approximate time when the ad destination was last checked. Uses RFC 3339, where generated output will always be Z-normalized and use 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"`. | | Reason of the destination not working. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response: || | `dnsError` | ``enum (`DnsError`)`` DNS lookup errors. | | `httpError` | `integer` HTTP error code (for example, 404 or 5xx) | | `invalidPage` | ``enum (`InvalidPage`)`` Page was crawled successfully, but was detected as either a page with no content or an error page. | | `redirectionError` | ``enum (`RedirectionError`)`` HTTP redirect chain error. | | `urlRejected` | ``enum (`UrlRejected`)`` Rejected because of malformed URLs or invalid requests. | | End of mutually exclusive fields. || ### DnsError DNS lookup errors. | Enums || |---|---| | `DNS_ERROR_UNSPECIFIED` | Default value that should never be used. | | `ERROR_DNS` | DNS name was not found. | | `GOOGLE_CRAWLER_DNS_ISSUE` | An internal issue occurred when Google's crawler tried to resolve the DNS entry. This is a Google-internal issue and may not be the result of an issue with the landing page. | ### InvalidPage The page was crawled successfully but an issue was detected with the page's content. | Enums || |---|---| | `INVALID_PAGE_UNSPECIFIED` | Default value that should never be used. | | `EMPTY_OR_ERROR_PAGE` | Page was empty or had an error. | ### RedirectionError Error in the HTTP redirect chain. | Enums || |---|---| | `REDIRECTION_ERROR_UNSPECIFIED` | Default value that should never be used. | | `TOO_MANY_REDIRECTS` | Too many redirect hops. | | `INVALID_REDIRECT` | Got a redirect but it was invalid. | | `EMPTY_REDIRECT` | Got a redirect but it was empty. | | `REDIRECT_ERROR_UNKNOWN` | Unknown redirect error. | ### UrlRejected URL was rejected because the request was malformed or the URL itself was malformed. | Enums || |---|---| | `URL_REJECTED_UNSPECIFIED` | Default value that should never be used. | | `BAD_REQUEST` | URL rejected because of a malformed request. | | `MALFORMED_URL` | URL rejected because of a malformed URL. | | `URL_REJECTED_UNKNOWN` | URL rejected because of unknown reason. | ### Platform Platform of the non-working URL. | Enums || |---|---| | `PLATFORM_UNSPECIFIED` | Default value that should never be used. | | `PERSONAL_COMPUTER` | The personal computer platform. | | `ANDROID` | The Android platform. | | `IOS` | The iOS platform. | ### DestinationNotCrawlableEvidence Evidence that the creative's destination URL was not crawlable by Google. | JSON representation | |---| | ``` { "crawledUrl": string, "reason": enum (`Reason`), "crawlTime": string } ``` | | Fields || |---|---| | `crawledUrl` | `string` Destination URL that was attempted to be crawled. | | `reason` | ``enum (`Reason`)`` Reason of destination not crawlable. | | `crawlTime` | ``string (`Timestamp` format)`` Approximate time of the crawl. Uses RFC 3339, where generated output will always be Z-normalized and use 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"`. | ### Reason Reason for destination being not crawlable. | Enums || |---|---| | `REASON_UNSPECIFIED` | Default value that should never be used. | | `UNREACHABLE_ROBOTS` | Site's robots exclusion file (for example, robots.txt) was unreachable. | | `TIMEOUT_ROBOTS` | Timed out reading site's robots exclusion file (for example, robots.txt). | | `ROBOTED_DENIED` | Crawler was disallowed by the site's robots exclusion file (for example, robots.txt). | | `UNKNOWN` | Unknown reason. | ### HttpCallEvidence HTTP calls made by a creative that resulted in policy violations. | JSON representation | |---| | ``` { "urls": [ string ] } ``` | | Fields || |---|---| | `urls[]` | `string` URLs of HTTP calls made by the creative. | ### DomainCallEvidence Number of HTTP calls made by a creative, broken down by domain. | JSON representation | |---| | ``` { "totalHttpCallCount": integer, "topHttpCallDomains": [ { object (`DomainCalls`) } ] } ``` | | Fields || |---|---| | `totalHttpCallCount` | `integer` The total number of HTTP calls made by the creative, including but not limited to the number of calls in the topHttpCallDomains. | | `topHttpCallDomains[]` | ``object (`DomainCalls`)`` Breakdown of the most frequent domains called through HTTP by the creative. | ### DomainCalls The number of HTTP calls made to the given domain. | JSON representation | |---| | ``` { "domain": string, "httpCallCount": integer } ``` | | Fields || |---|---| | `domain` | `string` The domain name. | | `httpCallCount` | `integer` Number of HTTP calls made to the domain. | ### HttpCookieEvidence Evidence for HTTP cookie-related policy violations. | JSON representation | |---| | ``` { "cookieNames": [ string ], "maxCookieCount": integer } ``` | | Fields || |---|---| | `cookieNames[]` | `string` Names of cookies that violate Google policies. For TOO_MANY_COOKIES policy, this will be the cookie names of top domains with the largest number of cookies. For other policies, this will be all the cookie names that violate the policy. | | `maxCookieCount` | `integer` The largest number of cookies set by a creative. If this field is set, cookieNames above will be set to the cookie names of top domains with the largest number of cookies. This field will only be set for TOO_MANY_COOKIES policy. | ### DestinationUrlEvidence The full landing page URL of the destination. | JSON representation | |---| | ``` { "destinationUrl": string } ``` | | Fields || |---|---| | `destinationUrl` | `string` The full landing page URL of the destination. | ### DownloadSizeEvidence Total download size and URL-level download size breakdown for resources in a creative. | JSON representation | |---| | ``` { "totalDownloadSizeKb": integer, "topUrlDownloadSizeBreakdowns": [ { object (`UrlDownloadSize`) } ] } ``` | | Fields || |---|---| | `totalDownloadSizeKb` | `integer` Total download size (in kilobytes) for all the resources in the creative. | | `topUrlDownloadSizeBreakdowns[]` | ``object (`UrlDownloadSize`)`` Download size broken down by URLs with the top download size. | ### UrlDownloadSize The URL-level breakdown for the download size. | JSON representation | |---| | ``` { "normalizedUrl": string, "downloadSizeKb": integer } ``` | | Fields || |---|---| | `normalizedUrl` | `string` The normalized URL with query parameters and fragment removed. | | `downloadSizeKb` | `integer` Download size of the URL in kilobytes. | ### AdCategoryTaxonomy Possible ad category taxonomies. | Enums || |---|---| | `AD_CATEGORY_TAXONOMY_UNSPECIFIED` | Default value that should never be used. | | `GOOGLE_AD_CATEGORY_TAXONOMY` | Google ad categories taxonomy, including product categories and sensitive categories. Find the category lists at | | `IAB_CONTENT_1_0` | IAB Content Taxonomy 1.0. See [Content Taxonomy 1.0.tsv](https://github.com/InteractiveAdvertisingBureau/Taxonomies/blob/main/Content%20Taxonomies/Content%20Taxonomy%201.0.tsv) for more details. | | `IAB_CONTENT_2_2` | IAB Content Taxonomy 2.2. See [Content Taxonomy 2.2.tsv](https://github.com/InteractiveAdvertisingBureau/Taxonomies/blob/main/Content%20Taxonomies/Content%20Taxonomy%202.2.tsv) for more details. | | ## Methods || |---|---| | ### `list` | Lists creatives as they are at the time of the initial request. | | ### `watch` | Watches all creatives pertaining to a bidder. |