REST Resource: advertisers.creatives

Resource: Creative

A single Creative.

JSON representation
{
  "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
  ]
}
Fields
name

string

Output only. The resource name of the creative.

advertiserId

string (int64 format)

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

creativeId

string (int64 format)

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

cmPlacementId

string (int64 format)

Output only. The unique ID of the Campaign Manager placement associated with the creative. This field is only applicable for creatives that are synced from Campaign Manager.

displayName

string

Required. The display name of the creative.

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

entityStatus

enum (EntityStatus)

Required. Controls whether or not the creative can serve.

Accepted values are:

  • ENTITY_STATUS_ACTIVE
  • ENTITY_STATUS_ARCHIVED
  • ENTITY_STATUS_PAUSED
updateTime

string (Timestamp format)

Output only. The timestamp when the creative was last updated. 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".

createTime

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".

creativeType

enum (CreativeType)

Required. Immutable. The type of the creative.

hostingSource

enum (HostingSource)

Required. Indicates where the creative is hosted.

dynamic

boolean

Output only. Indicates whether the creative is dynamic.

dimensions

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_TEMPLATED_APP_INSTALL_INTERSTITIAL
  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_NATIVE_VIDEO
  • CREATIVE_TYPE_TEMPLATED_APP_INSTALL_VIDEO
additionalDimensions[]

object (Dimensions)

Additional dimensions. Applicable when creativeType is one of:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE
  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_TEMPLATED_APP_INSTALL
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_LIGHTBOX
  • CREATIVE_TYPE_NATIVE_APP_INSTALL
  • CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE
  • CREATIVE_TYPE_PUBLISHER_HOSTED

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

mediaDuration

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, terminated by 's'. Example: "3.5s".

creativeAttributes[]

enum (CreativeAttribute)

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

reviewStatus

object (ReviewStatusInfo)

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

assets[]

object (AssetAssociation)

Required. Assets associated to this creative. Assets can be associated to the creative in one of following roles:

  • ASSET_ROLE_UNSPECIFIED
  • ASSET_ROLE_MAIN
  • ASSET_ROLE_BACKUP
  • ASSET_ROLE_POLITE_LOAD
exitEvents[]

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.
timerEvents[]

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.

counterEvents[]

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.

appendedTag

string

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

integrationCode

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.

notes

string

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

iasCampaignMonitoring

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.

companionCreativeIds[]

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
skippable

boolean

Whether the user can choose to skip a video creative.

This field is only supported for the following creativeType:

  • CREATIVE_TYPE_VIDEO
skipOffset

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
progressOffset

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
universalAdId

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
thirdPartyUrls[]

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
transcodes[]

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
trackerUrls[]

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 supported in following creativeType:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_APP_INSTALL
  • CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
jsTrackerUrl

string

JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported.

This field is only supported in following creativeType:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_APP_INSTALL
  • CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
cmTrackingAd

object (CmTrackingAd)

The Campaign Manager tracking ad associated with the creative.

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

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_APP_INSTALL
  • CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE

Output only for other cases.

obaIcon

object (ObaIcon)

Specifies the OBA icon for a video creative.

This field is only supported in following creativeType:

  • CREATIVE_TYPE_VIDEO
thirdPartyTag

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
requireMraid

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
requireHtml5

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
requirePingForAttribution

boolean

Optional. Indicates that the creative will wait for a return ping for attribution.

Only valid when using a Campaign Manager 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_VIDEO
expandingDirection

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
expandOnHover

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
vastTagUrl

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_VIDEO
vpaid

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
html5Video

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
lineItemIds[]

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.

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.

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 creativeType is one of the following:

  • CREATIVE_TYPE_EXPANDABLE
  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO
HOSTING_SOURCE_HOSTED

A creative created in DV360 and hosted by Campaign Manager.

Create and update methods are supported for this hosting type if the creativeType is one of the following:

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_APP_INSTALL
  • CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO
HOSTING_SOURCE_RICH_MEDIA

A rich media creative created in Studio and hosted by Campaign Manager.

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 (ApprovalStatus),
  "creativeAndLandingPageReviewStatus": enum (ReviewStatus),
  "contentAndPolicyReviewStatus": enum (ReviewStatus),
  "exchangeReviewStatuses": [
    {
      object (ExchangeReviewStatus)
    }
  ],
  "publisherReviewStatuses": [
    {
      object (PublisherReviewStatus)
    }
  ]
}
Fields
approvalStatus

enum (ApprovalStatus)

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

creativeAndLandingPageReviewStatus

enum (ReviewStatus)

Creative and landing page review status for the creative.

contentAndPolicyReviewStatus

enum (ReviewStatus)

Content and policy review status for the creative.

exchangeReviewStatuses[]

object (ExchangeReviewStatus)

Exchange review statuses for the creative.

publisherReviewStatuses[]

object (PublisherReviewStatus)

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 (Exchange),
  "status": enum (ReviewStatus)
}
Fields
exchange

enum (Exchange)

The exchange reviewing the creative.

status

enum (ReviewStatus)

Status of the exchange review.

PublisherReviewStatus

Publisher review status for the creative.

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

string

The publisher reviewing the creative.

status

enum (ReviewStatus)

Status of the publisher review.

AssetAssociation

Asset association for the creative.

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

object (Asset)

The associated asset.

role

enum (AssetRole)

The role of this asset for the creative.

Asset

A single asset.

JSON representation
{
  "mediaId": string,
  "content": string
}
Fields
mediaId

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.

content

string

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 content must be UTF-8 encoded with a length of no more than 25 characters.

This role is only supported in following creativeType:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_APP_INSTALL
  • CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_LONG_HEADLINE

Long headline of a native creative.

The content must be UTF-8 encoded with a length of no more than 50 characters.

This role is only supported in following creativeType:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_APP_INSTALL
  • CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_BODY

Body text of a native creative.

The content must be UTF-8 encoded with a length of no more than 90 characters.

This role is only supported in following creativeType:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_APP_INSTALL
  • CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_LONG_BODY

Long body text of a native creative.

The content must be UTF-8 encoded with a length of no more than 150 characters.

This role is only supported in following creativeType:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_APP_INSTALL
  • CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
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 content must be UTF-8 encoded with a length of no more than 30 characters.

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

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_APP_INSTALL
  • CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_CALL_TO_ACTION

The text to use on the call-to-action button of a native creative.

The content must be UTF-8 encoded with a length of no more than 15 characters.

This role is only supported in following creativeType:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_APP_INSTALL
  • CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_ADVERTISER_NAME

The text that identifies the advertiser or brand name.

The content must be UTF-8 encoded with a length of no more than 25 characters.

This role is only supported in following creativeType:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_APP_INSTALL
  • CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
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 content must be UTF-8 encoded with a length of no more than 15 characters.

This role is only supported in following creativeType:

  • CREATIVE_TYPE_NATIVE_APP_INSTALL
  • CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE
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.

This role is only supported in following creativeType:

  • CREATIVE_TYPE_NATIVE_APP_INSTALL
  • CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE
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.

This role is only supported in following creativeType:

  • CREATIVE_TYPE_NATIVE_APP_INSTALL
  • CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE
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.

This role is only supported in following creativeType:

  • CREATIVE_TYPE_NATIVE_APP_INSTALL
  • CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE
ASSET_ROLE_ICON

The icon of a creative.

This role is only supported and required in following creativeType:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_APP_INSTALL
  • CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE
ASSET_ROLE_COVER_IMAGE

The cover image of a native video creative.

This role is only supported and required in following creativeType:

  • CREATIVE_TYPE_VIDEO

ExitEvent

Exit event of the creative.

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

enum (ExitEventType)

Required. The type of the exit event.

url

string

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

  • EXIT_EVENT_TYPE_DEFAULT
  • EXIT_EVENT_TYPE_BACKUP
name

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.

reportingName

string

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

string

Required. The name of the timer event.

reportingName

string

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

string

Required. The name of the counter event.

reportingName

string

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 offset can be only one of the following:
  "percentage": string,
  "seconds": string
  // End of list of possible types for union field offset.
}
Fields
Union field offset. The value of the offset. offset can be only one of the following:
percentage

string (int64 format)

The offset in percentage of the audio or video duration.

seconds

string (int64 format)

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 (UniversalAdRegistry)
}
Fields
id

string

The unique creative identifier.

registry

enum (UniversalAdRegistry)

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 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 (ThirdPartyUrlType),
  "url": string
}
Fields
type

enum (ThirdPartyUrlType)

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

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

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 (Dimensions)
  },
  "bitRateKbps": string,
  "frameRate": number,
  "audioBitRateKbps": string,
  "audioSampleRateHz": string,
  "fileSizeBytes": string
}
Fields
name

string

The name of the transcoded file.

mimeType

string

The MIME type of the transcoded file.

transcoded

boolean

Indicates if the transcoding was successful.

dimensions

object (Dimensions)

The dimensions of the transcoded video.

bitRateKbps

string (int64 format)

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

frameRate

number

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

audioBitRateKbps

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.

audioSampleRateHz

string (int64 format)

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

fileSizeBytes

string (int64 format)

The size of the transcoded file, in bytes.

CmTrackingAd

A Campaign Manager tracking ad.

JSON representation
{
  "cmPlacementId": string,
  "cmCreativeId": string,
  "cmAdId": string
}
Fields
cmPlacementId

string (int64 format)

The placement ID of the campaign manager tracking Ad.

cmCreativeId

string (int64 format)

The creative ID of the campaign manager tracking Ad.

cmAdId

string (int64 format)

The ad ID of the campaign manager tracking Ad.

ObaIcon

OBA Icon for a Creative

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

string

The URL of the OBA icon resource.

resourceMimeType

string

The MIME type of the OBA icon resource.

position

enum (ObaIconPosition)

The position of the OBA icon on the creative.

dimensions

object (Dimensions)

The dimensions of the OBA icon.

program

string

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

landingPageUrl

string

Required. The landing page URL of the OBA icon.

Only URLs of the following domains are allowed:

clickTrackingUrl

string

Required. The click tracking URL of the OBA icon.

Only URLs of the following domains are allowed:

viewTrackingUrl

string

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

create

Creates a new creative.

delete

Deletes a creative.

get

Gets a creative.

list

Lists creatives in an advertiser.

patch

Updates an existing creative.