- Resource: Creative
- HostingSource
- CreativeAttribute
- ReviewStatusInfo
- ApprovalStatus
- ReviewStatus
- ExchangeReviewStatus
- PublisherReviewStatus
- AssetAssociation
- Asset
- AssetRole
- ExitEvent
- ExitEventType
- TimerEvent
- CounterEvent
- AudioVideoOffset
- UniversalAdId
- UniversalAdRegistry
- ThirdPartyUrl
- ThirdPartyUrlType
- Transcode
- CmTrackingAd
- ObaIcon
- ObaIconPosition
- ExpandingDirection
- Methods
Resource: Creative
A single Creative.
JSON representation |
---|
{ "name": string, "advertiserId": string, "creativeId": string, "cmPlacementId": string, "displayName": string, "entityStatus": enum ( |
Fields | |
---|---|
name |
Output only. The resource name of the creative. |
advertiserId |
Output only. The unique ID of the advertiser the creative belongs to. |
creativeId |
Output only. The unique ID of the creative. Assigned by the system. |
cmPlacementId |
Output only. The unique ID of the Campaign Manager 360 placement associated with the creative. This field is only applicable for creatives that are synced from Campaign Manager. |
displayName |
Required. The display name of the creative. Must be UTF-8 encoded with a maximum size of 240 bytes. |
entityStatus |
Required. Controls whether or not the creative can serve. Accepted values are:
|
updateTime |
Output only. The timestamp when the creative was last updated, either by the user or system (e.g. creative review). Assigned by the system. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
createTime |
Output only. The timestamp when the creative was created. Assigned by the system. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
creativeType |
Required. Immutable. The type of the creative. |
hostingSource |
Required. Indicates where the creative is hosted. |
dynamic |
Output only. Indicates whether the creative is dynamic. |
dimensions |
Required. Primary dimensions of the creative. Applicable to all creative types. The value of
|
additionalDimensions[] |
Additional dimensions. Applicable when
If this field is specified, |
mediaDuration |
Output only. Media duration of the creative. Applicable when
A duration in seconds with up to nine fractional digits, ending with ' |
creativeAttributes[] |
Output only. A list of attributes of the creative that is generated by the system. |
reviewStatus |
Output only. The current status of the creative review process. |
assets[] |
Required. Assets associated to this creative. |
exitEvents[] |
Required. Exit events for this creative. An exit (also known as a click tag) is any area in your creative that someone can click or tap to open an advertiser's landing page. Every creative must include at least one exit. You can add an exit to your creative in any of the following ways:
|
timerEvents[] |
Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only. |
counterEvents[] |
Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only. |
appendedTag |
Third-party HTML tracking tag to be appended to the creative tag. |
integrationCode |
ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters. |
notes |
User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters. |
iasCampaignMonitoring |
Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the |
companionCreativeIds[] |
The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain This field is only supported for following
|
skippable |
Whether the user can choose to skip a video creative. This field is only supported for the following
|
skipOffset |
Amount of time to play the video before the skip button appears. This field is required when This field is only supported for the following
|
progressOffset |
Amount of time to play the video before counting a view. This field is required when This field is only supported for the following
|
universalAdId |
Optional. An optional creative identifier provided by a registry that is unique across all platforms. Universal Ad ID is part of the VAST 4.0 standard. It can be modified after the creative is created. This field is only supported for the following
|
thirdPartyUrls[] |
Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following
|
transcodes[] |
Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in following
|
trackerUrls[] |
Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with https (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in following
|
jsTrackerUrl |
JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in following
|
cmTrackingAd |
The Campaign Manager 360 tracking ad associated with the creative. Optional for the following
Output only for other cases. |
obaIcon |
Specifies the OBA icon for a video creative. This field is only supported in following
|
thirdPartyTag |
Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following
combined with following
|
requireMraid |
Optional. Indicates that the creative requires MRAID (Mobile Rich Media Ad Interface Definitions system). Set this if the creative relies on mobile gestures for interactivity, such as swiping or tapping. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following
combined with following
|
requireHtml5 |
Optional. Indicates that the creative relies on HTML5 to render properly. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following
combined with following
|
requirePingForAttribution |
Optional. Indicates that the creative will wait for a return ping for attribution. Only valid when using a Campaign Manager 360 tracking ad with a third-party ad server parameter and the ${DC_DBM_TOKEN} macro. Optional and only valid for third-party tag creatives or third-party VAST tag creatives. Third-party tag creatives are creatives with following
combined with following
Third-party VAST tag creatives are creatives with following
combined with following
|
expandingDirection |
Optional. Specifies the expanding direction of the creative. Required and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source:
combined with following
|
expandOnHover |
Optional. Indicates the creative will automatically expand on hover. Optional and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source:
combined with following
|
vastTagUrl |
Optional. The URL of the VAST tag for a third-party VAST tag creative. Required and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following
combined with following
|
vpaid |
Output only. Indicates the third-party VAST tag creative requires VPAID (Digital Video Player-Ad Interface). Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following
combined with following
|
html5Video |
Output only. Indicates the third-party VAST tag creative requires HTML5 Video support. Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following
combined with following
|
lineItemIds[] |
Output only. The IDs of the line items this creative is associated with. To associate a creative to a line item, use |
mp3Audio |
Output only. Indicates the third-party audio creative supports MP3. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following
combined with following
|
oggAudio |
Output only. Indicates the third-party audio creative supports OGG. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following
combined with following
|
HostingSource
Possible hosting sources for a creative. Indicates where a creative is created and hosted.
Enums | |
---|---|
HOSTING_SOURCE_UNSPECIFIED |
Hosting source is not specified or is unknown in this version. |
HOSTING_SOURCE_CM |
A creative synced from Campaign Manager 360. Create and update methods are not supported for this hosting type. |
HOSTING_SOURCE_THIRD_PARTY |
A creative hosted by a third-party ad server (3PAS). Create and update methods are supported for this hosting type if the
|
HOSTING_SOURCE_HOSTED |
A creative created in DV360 and hosted by Campaign Manager 360. Create and update methods are supported for this hosting type if the
|
HOSTING_SOURCE_RICH_MEDIA |
A rich media creative created in Studio and hosted by Campaign Manager 360. Create and update methods are not supported for this hosting type. |
CreativeAttribute
Possible attributes of a creative.
Enums | |
---|---|
CREATIVE_ATTRIBUTE_UNSPECIFIED |
The creative attribute is not specified or is unknown in this version. |
CREATIVE_ATTRIBUTE_VAST |
The creative is a VAST creative. |
CREATIVE_ATTRIBUTE_VPAID_LINEAR |
The creative is a linear VPAID creative. |
CREATIVE_ATTRIBUTE_VPAID_NON_LINEAR |
The creative is a non-linear VPAID creative. |
ReviewStatusInfo
Review statuses for the creative.
JSON representation |
---|
{ "approvalStatus": enum ( |
Fields | |
---|---|
approvalStatus |
Represents the basic approval needed for a creative to begin serving. Summary of |
creativeAndLandingPageReviewStatus |
Creative and landing page review status for the creative. |
contentAndPolicyReviewStatus |
Content and policy review status for the creative. |
exchangeReviewStatuses[] |
Exchange review statuses for the creative. |
publisherReviewStatuses[] |
Publisher review statuses for the creative. |
ApprovalStatus
Possible types of approval status. It is the summary of creativeAndLandingPageReviewStatus
and contentAndPolicyReviewStatus
.
Enums | |
---|---|
APPROVAL_STATUS_UNSPECIFIED |
Type value is not specified or is unknown in this version. |
APPROVAL_STATUS_PENDING_NOT_SERVABLE |
The creative is still under review and not servable. |
APPROVAL_STATUS_PENDING_SERVABLE |
The creative has passed creative & landing page review and is servable, but is awaiting additional content & policy review. |
APPROVAL_STATUS_APPROVED_SERVABLE |
Both creative & landing page review and content & policy review are approved. The creative is servable. |
APPROVAL_STATUS_REJECTED_NOT_SERVABLE |
There is an issue with the creative that must be fixed before it can serve. |
ReviewStatus
Possible types of review status.
Enums | |
---|---|
REVIEW_STATUS_UNSPECIFIED |
Type value is not specified or is unknown in this version. |
REVIEW_STATUS_APPROVED |
The creative is approved. |
REVIEW_STATUS_REJECTED |
The creative is rejected. |
REVIEW_STATUS_PENDING |
The creative is pending review. |
ExchangeReviewStatus
Exchange review status for the creative.
JSON representation |
---|
{ "exchange": enum ( |
Fields | |
---|---|
exchange |
The exchange reviewing the creative. |
status |
Status of the exchange review. |
PublisherReviewStatus
Publisher review status for the creative.
JSON representation |
---|
{
"publisherName": string,
"status": enum ( |
Fields | |
---|---|
publisherName |
The publisher reviewing the creative. |
status |
Status of the publisher review. |
AssetAssociation
Asset association for the creative.
JSON representation |
---|
{ "asset": { object ( |
Fields | |
---|---|
asset |
The associated asset. |
role |
The role of this asset for the creative. |
Asset
A single asset.
JSON representation |
---|
{ "mediaId": string, "content": string } |
Fields | |
---|---|
mediaId |
Media ID of the uploaded asset. This is a unique identifier for the asset. This ID can be passed to other API calls, e.g. The Media ID space updated on April 5, 2023. Update media IDs cached before April 5, 2023 by retrieving the new media ID from associated creative resources or re-uploading the asset. |
content |
The asset content. For uploaded assets, the content is the serving path. |
AssetRole
The role of this asset for the creative.
Enums | |
---|---|
ASSET_ROLE_UNSPECIFIED |
Asset role is not specified or is unknown in this version. |
ASSET_ROLE_MAIN |
The asset is the main asset of the creative. |
ASSET_ROLE_BACKUP |
The asset is a backup asset of the creative. |
ASSET_ROLE_POLITE_LOAD |
The asset is a polite load asset of the creative. |
ASSET_ROLE_HEADLINE |
Headline of a native creative. The This role is only supported in following
|
ASSET_ROLE_LONG_HEADLINE |
Long headline of a native creative. The This role is only supported in following
|
ASSET_ROLE_BODY |
Body text of a native creative. The This role is only supported in following
|
ASSET_ROLE_LONG_BODY |
Long body text of a native creative. The This role is only supported in following
|
ASSET_ROLE_CAPTION_URL |
A short, friendly version of the landing page URL to show in the creative. This URL gives people an idea of where they'll arrive after they click on the creative. The For example, if the landing page URL is 'http://www.example.com/page', the caption URL can be 'example.com'. The protocol (http://) is optional, but the URL can't contain spaces or special characters. This role is only supported in following
|
ASSET_ROLE_CALL_TO_ACTION |
The text to use on the call-to-action button of a native creative. The This role is only supported in following
|
ASSET_ROLE_ADVERTISER_NAME |
The text that identifies the advertiser or brand name. The This role is only supported in following
|
ASSET_ROLE_PRICE |
The purchase price of your app in the Google play store or iOS app store (for example, $5.99). Note that this value is not automatically synced with the actual value listed in the store. It will always be the one provided when save the creative. The Assets of this role are read-only. |
ASSET_ROLE_ANDROID_APP_ID |
The ID of an Android app in the Google play store. You can find this ID in the App’s Google Play Store URL after ‘id’. For example, in https://play.google.com/store/apps/details?id=com.company.appname the identifier is com.company.appname. Assets of this role are read-only. |
ASSET_ROLE_IOS_APP_ID |
The ID of an iOS app in the Apple app store. This ID number can be found in the Apple App Store URL as the string of numbers directly after "id". For example, in https://apps.apple.com/us/app/gmail-email-by-google/id422689480 the ID is 422689480. Assets of this role are read-only. |
ASSET_ROLE_RATING |
The rating of an app in the Google play store or iOS app store. Note that this value is not automatically synced with the actual rating in the store. It will always be the one provided when save the creative. Assets of this role are read-only. |
ASSET_ROLE_ICON |
The icon of a creative. This role is only supported and required in following
|
ASSET_ROLE_COVER_IMAGE |
The cover image of a native video creative. This role is only supported and required in following
|
ExitEvent
Exit event of the creative.
JSON representation |
---|
{
"type": enum ( |
Fields | |
---|---|
type |
Required. The type of the exit event. |
url |
Required. The click through URL of the exit event. This is required when
|
name |
The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only. |
reportingName |
The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only. |
ExitEventType
The type of an exit event.
Enums | |
---|---|
EXIT_EVENT_TYPE_UNSPECIFIED |
Exit event type is not specified or is unknown in this version. |
EXIT_EVENT_TYPE_DEFAULT |
The exit event is the default one. |
EXIT_EVENT_TYPE_BACKUP |
The exit event is a backup exit event. There could be multiple backup exit events in a creative. |
TimerEvent
Timer event of the creative.
JSON representation |
---|
{ "name": string, "reportingName": string } |
Fields | |
---|---|
name |
Required. The name of the timer event. |
reportingName |
Required. The name used to identify this timer event in reports. |
CounterEvent
Counter event of the creative.
JSON representation |
---|
{ "name": string, "reportingName": string } |
Fields | |
---|---|
name |
Required. The name of the counter event. |
reportingName |
Required. The name used to identify this counter event in reports. |
AudioVideoOffset
The length an audio or a video has been played.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field offset . The value of the offset. offset can be only one of the following: |
|
percentage |
The offset in percentage of the audio or video duration. |
seconds |
The offset in seconds from the start of the audio or video. |
UniversalAdId
A creative identifier provided by a registry that is unique across all platforms. This is part of the VAST 4.0 standard.
JSON representation |
---|
{
"id": string,
"registry": enum ( |
Fields | |
---|---|
id |
The unique creative identifier. |
registry |
The registry provides unique creative identifiers. |
UniversalAdRegistry
The registry provides unique creative identifiers in a Universal Ad ID.
Enums | |
---|---|
UNIVERSAL_AD_REGISTRY_UNSPECIFIED |
The Universal Ad registry is unspecified or is unknown in this version. |
UNIVERSAL_AD_REGISTRY_OTHER |
Use a custom provider to provide the Universal Ad ID. |
UNIVERSAL_AD_REGISTRY_AD_ID |
Use Ad-ID to provide the Universal Ad ID. |
UNIVERSAL_AD_REGISTRY_CLEARCAST |
Use clearcast.co.uk to provide the Universal Ad ID. |
UNIVERSAL_AD_REGISTRY_DV360 |
Use Display & Video 360 to provide the Universal Ad ID. |
UNIVERSAL_AD_REGISTRY_CM |
Use Campaign Manager 360 to provide the Universal Ad ID. |
ThirdPartyUrl
Tracking URLs from third parties to track interactions with an audio or a video creative.
JSON representation |
---|
{
"type": enum ( |
Fields | |
---|---|
type |
The type of interaction needs to be tracked by the tracking URL |
url |
Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with |
ThirdPartyUrlType
The type of interaction needs to be tracked by the third-party tracking URL.
Enums | |
---|---|
THIRD_PARTY_URL_TYPE_UNSPECIFIED |
The type of third-party URL is unspecified or is unknown in this version. |
THIRD_PARTY_URL_TYPE_IMPRESSION |
Used to count impressions of the creative after the audio or video buffering is complete. |
THIRD_PARTY_URL_TYPE_CLICK_TRACKING |
Used to track user clicks on the audio or video. |
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_START |
Used to track the number of times a user starts the audio or video. |
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_FIRST_QUARTILE |
Used to track the number of times the audio or video plays to 25% of its length. |
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_MIDPOINT |
Used to track the number of times the audio or video plays to 50% of its length. |
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_THIRD_QUARTILE |
Used to track the number of times the audio or video plays to 75% of its length. |
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_COMPLETE |
Used to track the number of times the audio or video plays to the end. |
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_MUTE |
Used to track the number of times a user mutes the audio or video. |
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_PAUSE |
Used to track the number of times a user pauses the audio or video. |
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_REWIND |
Used to track the number of times a user replays the audio or video. |
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_FULLSCREEN |
Used to track the number of times a user expands the player to full-screen size. |
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_STOP |
Used to track the number of times a user stops the audio or video. |
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_CUSTOM |
Used to track the number of times a user performs a custom click, such as clicking on a video hot spot. |
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_SKIP |
Used to track the number of times the audio or video was skipped. |
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_PROGRESS |
Used to track the number of times the audio or video plays to an offset determined by the progressOffset . |
Transcode
Represents information about the transcoded audio or video file.
JSON representation |
---|
{
"name": string,
"mimeType": string,
"transcoded": boolean,
"dimensions": {
object ( |
Fields | |
---|---|
name |
The name of the transcoded file. |
mimeType |
The MIME type of the transcoded file. |
transcoded |
Indicates if the transcoding was successful. |
dimensions |
The dimensions of the transcoded video. |
bitRateKbps |
The transcoding bit rate of the transcoded video, in kilobits per second. |
frameRate |
The frame rate of the transcoded video, in frames per second. |
audioBitRateKbps |
The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second. |
audioSampleRateHz |
The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz. |
fileSizeBytes |
The size of the transcoded file, in bytes. |
CmTrackingAd
A Campaign Manager 360 tracking ad.
JSON representation |
---|
{ "cmPlacementId": string, "cmCreativeId": string, "cmAdId": string } |
Fields | |
---|---|
cmPlacementId |
The placement ID of the campaign manager 360 tracking Ad. |
cmCreativeId |
The creative ID of the campaign manager 360 tracking Ad. |
cmAdId |
The ad ID of the campaign manager 360 tracking Ad. |
ObaIcon
OBA Icon for a Creative
JSON representation |
---|
{ "resourceUrl": string, "resourceMimeType": string, "position": enum ( |
Fields | |
---|---|
resourceUrl |
The URL of the OBA icon resource. |
resourceMimeType |
The MIME type of the OBA icon resource. |
position |
The position of the OBA icon on the creative. |
dimensions |
The dimensions of the OBA icon. |
program |
The program of the OBA icon. For example: “AdChoices”. |
landingPageUrl |
Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: |
clickTrackingUrl |
Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: |
viewTrackingUrl |
Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: |
ObaIconPosition
The position of the OBA icon on the creative.
Enums | |
---|---|
OBA_ICON_POSITION_UNSPECIFIED |
The OBA icon position is not specified. |
OBA_ICON_POSITION_UPPER_RIGHT |
At the upper right side of the creative. |
OBA_ICON_POSITION_UPPER_LEFT |
At the upper left side of the creative. |
OBA_ICON_POSITION_LOWER_RIGHT |
At the lower right side of the creative. |
OBA_ICON_POSITION_LOWER_LEFT |
At the lower left side of the creative. |
ExpandingDirection
The expanding direction of the third-party expandable creative.
Enums | |
---|---|
EXPANDING_DIRECTION_UNSPECIFIED |
The expanding direction is not specified. |
EXPANDING_DIRECTION_NONE |
Does not expand in any direction. |
EXPANDING_DIRECTION_UP |
Expands up. |
EXPANDING_DIRECTION_DOWN |
Expands down. |
EXPANDING_DIRECTION_LEFT |
Expands left. |
EXPANDING_DIRECTION_RIGHT |
Expands right. |
EXPANDING_DIRECTION_UP_AND_LEFT |
Expands up and to the left side. |
EXPANDING_DIRECTION_UP_AND_RIGHT |
Expands up and to the right side. |
EXPANDING_DIRECTION_DOWN_AND_LEFT |
Expands down and to the left side. |
EXPANDING_DIRECTION_DOWN_AND_RIGHT |
Expands down and to the right side. |
EXPANDING_DIRECTION_UP_OR_DOWN |
Expands either up or down. |
EXPANDING_DIRECTION_LEFT_OR_RIGHT |
Expands to either the left or the right side. |
EXPANDING_DIRECTION_ANY_DIAGONAL |
Can expand in any diagonal direction. |
Methods |
|
---|---|
|
Creates a new creative. |
|
Deletes a creative. |
|
Gets a creative. |
|
Lists creatives in an advertiser. |
|
Updates an existing creative. |