REST Resource: advertisers.creatives

{
  "name": string,
  "advertiserId": string,
  "creativeId": string,
  "cmPlacementId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "createTime": string,
  "creativeType": enum (CreativeType),
  "hostingSource": enum (HostingSource),
  "dynamic": boolean,
  "dimensions": {
    object (Dimensions)
  },
  "additionalDimensions": [
    {
      object (Dimensions)
    }
  ],
  "mediaDuration": string,
  "creativeAttributes": [
    enum (CreativeAttribute)
  ],
  "reviewStatus": {
    object (ReviewStatusInfo)
  },
  "assets": [
    {
      object (AssetAssociation)
    }
  ],
  "exitEvents": [
    {
      object (ExitEvent)
    }
  ],
  "timerEvents": [
    {
      object (TimerEvent)
    }
  ],
  "counterEvents": [
    {
      object (CounterEvent)
    }
  ],
  "appendedTag": string,
  "integrationCode": string,
  "notes": string,
  "iasCampaignMonitoring": boolean,
  "companionCreativeIds": [
    string
  ],
  "skippable": boolean,
  "skipOffset": {
    object (AudioVideoOffset)
  },
  "progressOffset": {
    object (AudioVideoOffset)
  },
  "universalAdId": {
    object (UniversalAdId)
  },
  "thirdPartyUrls": [
    {
      object (ThirdPartyUrl)
    }
  ],
  "transcodes": [
    {
      object (Transcode)
    }
  ],
  "trackerUrls": [
    string
  ],
  "jsTrackerUrl": string,
  "cmTrackingAd": {
    object (CmTrackingAd)
  },
  "obaIcon": {
    object (ObaIcon)
  },
  "thirdPartyTag": string,
  "requireMraid": boolean,
  "requireHtml5": boolean,
  "requirePingForAttribution": boolean,
  "expandingDirection": enum (ExpandingDirection),
  "expandOnHover": boolean,
  "vastTagUrl": string,
  "vpaid": boolean,
  "html5Video": boolean,
  "lineItemIds": [
    string
  ],
  "mp3Audio": boolean,
  "oggAudio": boolean
}

string

Output only. The resource name of the creative.

string (int64 format)

Output only. The unique ID of the advertiser the creative belongs to.

string (int64 format)

Output only. The unique ID of the creative. Assigned by the system.

string (int64 format)

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.

string

Required. The display name of the creative.

Must be UTF-8 encoded with a maximum size of 240 bytes.

enum (EntityStatus)

Required. Controls whether or not the creative can serve.

Accepted values are:

• ENTITY_STATUS_ACTIVE
• ENTITY_STATUS_ARCHIVED
• ENTITY_STATUS_PAUSED

string (Timestamp format)

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: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

string (Timestamp format)

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: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

enum (CreativeType)

Required. Immutable. The type of the creative.

enum (HostingSource)

Required. Indicates where the creative is hosted.

boolean

Output only. Indicates whether the creative is dynamic.

object (Dimensions)

Required. Primary dimensions of the creative. Applicable to all creative types. The value of widthPixels and heightPixels defaults to 0 when creativeType is one of:

• CREATIVE_TYPE_VIDEO
• CREATIVE_TYPE_AUDIO
• CREATIVE_TYPE_NATIVE_VIDEO

object (Dimensions)

Additional dimensions. Applicable when creativeType is one of:

• CREATIVE_TYPE_STANDARD
• CREATIVE_TYPE_EXPANDABLE
• CREATIVE_TYPE_NATIVE
• CREATIVE_TYPE_NATIVE_SITE_SQUARE
• CREATIVE_TYPE_LIGHTBOX
• CREATIVE_TYPE_PUBLISHER_HOSTED

If this field is specified, widthPixels and heightPixels are both required and must be greater than or equal to 0.

string (Duration format)

Output only. Media duration of the creative. Applicable when creativeType is one of:

• CREATIVE_TYPE_VIDEO
• CREATIVE_TYPE_AUDIO
• CREATIVE_TYPE_NATIVE_VIDEO
• CREATIVE_TYPE_PUBLISHER_HOSTED

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

enum (CreativeAttribute)

Output only. A list of attributes of the creative that is generated by the system.

object (ReviewStatusInfo)

Output only. The current status of the creative review process.

object (AssetAssociation)

Required. Assets associated to this creative.

object (ExitEvent)

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:

• Use Google Web Designer's tap area.
• Define a JavaScript variable called "clickTag".
• Use the Enabler (Enabler.exit()) to track exits in rich media formats.

object (TimerEvent)

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.

object (CounterEvent)

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.

string

Third-party HTML tracking tag to be appended to the creative tag.

string

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.

string

User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters.

boolean

Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID.

string (int64 format)

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 additional dimensions can not be companion creatives.

This field is only supported for following creativeType:

• CREATIVE_TYPE_AUDIO
• CREATIVE_TYPE_VIDEO

boolean

Whether the user can choose to skip a video creative.

This field is only supported for the following creativeType:

• CREATIVE_TYPE_VIDEO

object (AudioVideoOffset)

Amount of time to play the video before the skip button appears.

This field is required when skippable is true.

This field is only supported for the following creativeType:

• CREATIVE_TYPE_VIDEO

object (AudioVideoOffset)

Amount of time to play the video before counting a view.

This field is required when skippable is true.

This field is only supported for the following creativeType:

• CREATIVE_TYPE_VIDEO

object (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 creativeType:

• CREATIVE_TYPE_VIDEO

object (ThirdPartyUrl)

Tracking URLs from third parties to track interactions with a video creative.

This field is only supported for the following creativeType:

• CREATIVE_TYPE_AUDIO
• CREATIVE_TYPE_VIDEO
• CREATIVE_TYPE_NATIVE_VIDEO

object (Transcode)

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 creativeType:

• CREATIVE_TYPE_VIDEO
• CREATIVE_TYPE_NATIVE_VIDEO
• CREATIVE_TYPE_AUDIO

string

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 creativeType:

• CREATIVE_TYPE_NATIVE
• CREATIVE_TYPE_NATIVE_SITE_SQUARE
• CREATIVE_TYPE_NATIVE_VIDEO

string

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 creativeType:

• CREATIVE_TYPE_NATIVE
• CREATIVE_TYPE_NATIVE_SITE_SQUARE
• CREATIVE_TYPE_NATIVE_VIDEO

object (CmTrackingAd)

The Campaign Manager 360 tracking ad associated with the creative.

Optional for the following creativeType when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving:

• CREATIVE_TYPE_NATIVE
• CREATIVE_TYPE_NATIVE_SITE_SQUARE

Output only for other cases.

object (ObaIcon)

Specifies the OBA icon for a video creative.

This field is only supported in following creativeType:

• CREATIVE_TYPE_VIDEO

string

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 hostingSource:

• HOSTING_SOURCE_THIRD_PARTY

combined with following creativeType:

• CREATIVE_TYPE_STANDARD
• CREATIVE_TYPE_EXPANDABLE

boolean

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 hostingSource:

• HOSTING_SOURCE_THIRD_PARTY

combined with following creativeType:

• CREATIVE_TYPE_STANDARD
• CREATIVE_TYPE_EXPANDABLE

boolean

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 hostingSource:

• HOSTING_SOURCE_THIRD_PARTY

combined with following creativeType:

• CREATIVE_TYPE_STANDARD
• CREATIVE_TYPE_EXPANDABLE

boolean

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 hostingSource:

• HOSTING_SOURCE_THIRD_PARTY

combined with following creativeType:

• CREATIVE_TYPE_STANDARD
• CREATIVE_TYPE_EXPANDABLE

Third-party VAST tag creatives are creatives with following hostingSource:

• HOSTING_SOURCE_THIRD_PARTY

combined with following creativeType:

• CREATIVE_TYPE_AUDIO
• CREATIVE_TYPE_VIDEO

enum (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:

• HOSTING_SOURCE_THIRD_PARTY

combined with following creativeType:

• CREATIVE_TYPE_EXPANDABLE

boolean

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:

• HOSTING_SOURCE_THIRD_PARTY

combined with following creativeType:

• CREATIVE_TYPE_EXPANDABLE

string

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 hostingSource:

• HOSTING_SOURCE_THIRD_PARTY

combined with following creativeType:

• CREATIVE_TYPE_AUDIO
• CREATIVE_TYPE_VIDEO

boolean

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 hostingSource:

• HOSTING_SOURCE_THIRD_PARTY

combined with following creativeType:

• CREATIVE_TYPE_VIDEO

boolean

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 hostingSource:

• HOSTING_SOURCE_THIRD_PARTY

combined with following creativeType:

• CREATIVE_TYPE_VIDEO

string (int64 format)

Output only. The IDs of the line items this creative is associated with.

To associate a creative to a line item, use LineItem.creative_ids instead.

boolean

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 hostingSource:

• HOSTING_SOURCE_THIRD_PARTY

combined with following creativeType:

• CREATIVE_TYPE_AUDIO

boolean

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 hostingSource:

• HOSTING_SOURCE_THIRD_PARTY

combined with following creativeType:

• CREATIVE_TYPE_AUDIO

{
  "approvalStatus": enum (ApprovalStatus),
  "creativeAndLandingPageReviewStatus": enum (ReviewStatus),
  "contentAndPolicyReviewStatus": enum (ReviewStatus),
  "exchangeReviewStatuses": [
    {
      object (ExchangeReviewStatus)
    }
  ],
  "publisherReviewStatuses": [
    {
      object (PublisherReviewStatus)
    }
  ]
}

enum (ApprovalStatus)

Represents the basic approval needed for a creative to begin serving. Summary of creativeAndLandingPageReviewStatus and contentAndPolicyReviewStatus.

enum (ReviewStatus)

Creative and landing page review status for the creative.

enum (ReviewStatus)

Content and policy review status for the creative.

object (ExchangeReviewStatus)

Exchange review statuses for the creative.

object (PublisherReviewStatus)

Publisher review statuses for the creative.

{
  "exchange": enum (Exchange),
  "status": enum (ReviewStatus)
}

enum (Exchange)

The exchange reviewing the creative.

enum (ReviewStatus)

Status of the exchange review.

{
  "publisherName": string,
  "status": enum (ReviewStatus)
}

string

The publisher reviewing the creative.

enum (ReviewStatus)

Status of the publisher review.

{
  "asset": {
    object (Asset)
  },
  "role": enum (AssetRole)
}

object (Asset)

The associated asset.

enum (AssetRole)

The role of this asset for the creative.

{
  "mediaId": string,
  "content": string
}

string (int64 format)

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. creatives.create to associate the asset with a creative.

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.

string

The asset content. For uploaded assets, the content is the serving path.

{
  "type": enum (ExitEventType),
  "url": string,
  "name": string,
  "reportingName": string
}

enum (ExitEventType)

Required. The type of the exit event.

string

Required. The click through URL of the exit event. This is required when type is:

• EXIT_EVENT_TYPE_DEFAULT
• EXIT_EVENT_TYPE_BACKUP

string

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.

string

The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only.

{
  "name": string,
  "reportingName": string
}

string

Required. The name of the timer event.

string

Required. The name used to identify this timer event in reports.

{
  "name": string,
  "reportingName": string
}

string

Required. The name of the counter event.

string

Required. The name used to identify this counter event in reports.

{

  // Union field offset can be only one of the following:
  "percentage": string,
  "seconds": string
  // End of list of possible types for union field offset.
}

string (int64 format)

The offset in percentage of the audio or video duration.

string (int64 format)

The offset in seconds from the start of the audio or video.

{
  "id": string,
  "registry": enum (UniversalAdRegistry)
}

string

The unique creative identifier.

enum (UniversalAdRegistry)

The registry provides unique creative identifiers.

{
  "type": enum (ThirdPartyUrlType),
  "url": string
}

enum (ThirdPartyUrlType)

The type of interaction needs to be tracked by the tracking URL

string

Tracking URL used to track the interaction.

Provide a URL with optional path or query string, beginning with https:. For example, https://www.example.com/path

{
  "name": string,
  "mimeType": string,
  "transcoded": boolean,
  "dimensions": {
    object (Dimensions)
  },
  "bitRateKbps": string,
  "frameRate": number,
  "audioBitRateKbps": string,
  "audioSampleRateHz": string,
  "fileSizeBytes": string
}

string

The name of the transcoded file.

string

The MIME type of the transcoded file.

boolean

Indicates if the transcoding was successful.

object (Dimensions)

The dimensions of the transcoded video.

string (int64 format)

The transcoding bit rate of the transcoded video, in kilobits per second.

number

The frame rate of the transcoded video, in frames per second.

string (int64 format)

The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second.

string (int64 format)

The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz.

string (int64 format)

The size of the transcoded file, in bytes.

{
  "cmPlacementId": string,
  "cmCreativeId": string,
  "cmAdId": string
}

string (int64 format)

The placement ID of the campaign manager 360 tracking Ad.

string (int64 format)

The creative ID of the campaign manager 360 tracking Ad.

string (int64 format)

The ad ID of the campaign manager 360 tracking Ad.

{
  "resourceUrl": string,
  "resourceMimeType": string,
  "position": enum (ObaIconPosition),
  "dimensions": {
    object (Dimensions)
  },
  "program": string,
  "landingPageUrl": string,
  "clickTrackingUrl": string,
  "viewTrackingUrl": string
}

string

The URL of the OBA icon resource.

string

The MIME type of the OBA icon resource.

enum (ObaIconPosition)

The position of the OBA icon on the creative.

object (Dimensions)

The dimensions of the OBA icon.

string

The program of the OBA icon. For example: “AdChoices”.

string

Required. The landing page URL of the OBA icon.

Only URLs of the following domains are allowed:

• https://info.evidon.com
• https://l.betrad.com

string

Required. The click tracking URL of the OBA icon.

Only URLs of the following domains are allowed:

• https://info.evidon.com
• https://l.betrad.com

string

Required. The view tracking URL of the OBA icon.

Only URLs of the following domains are allowed:

• https://info.evidon.com
• https://l.betrad.com