The Campaign Manager 360 API v3.3 is deprecated and will be sunset on June 30th, 2021. All users must migrate to a newer API version by that date.

REST Resource: creatives

Resource: Creative

Contains properties of a Creative.

JSON representation
{
  "id": string,
  "name": string,
  "renderingId": string,
  "advertiserId": string,
  "accountId": string,
  "subaccountId": string,
  "active": boolean,
  "archived": boolean,
  "version": integer,
  "size": {
    object (Size)
  },
  "creativeFieldAssignments": [
    {
      object (CreativeFieldAssignment)
    }
  ],
  "kind": string,
  "lastModifiedInfo": {
    object (LastModifiedInfo)
  },
  "sslCompliant": boolean,
  "compatibility": [
    enum (Compatibility)
  ],
  "type": enum (Type),
  "creativeAssets": [
    {
      object (CreativeAsset)
    }
  ],
  "redirectUrl": string,
  "htmlCode": string,
  "htmlCodeLocked": boolean,
  "backgroundColor": string,
  "allowScriptAccess": boolean,
  "fsCommand": {
    object (FsCommand)
  },
  "backupImageTargetWindow": {
    object (TargetWindow)
  },
  "clickTags": [
    {
      object (ClickTag)
    }
  ],
  "backupImageFeatures": [
    enum (BackupImageFeatures)
  ],
  "authoringTool": enum (AuthoringTool),
  "requiredFlashPluginVersion": string,
  "adTagKeys": [
    string
  ],
  "customKeyValues": [
    string
  ],
  "counterCustomEvents": [
    {
      object (CreativeCustomEvent)
    }
  ],
  "exitCustomEvents": [
    {
      object (CreativeCustomEvent)
    }
  ],
  "timerCustomEvents": [
    {
      object (CreativeCustomEvent)
    }
  ],
  "artworkType": enum (ArtworkType),
  "requiredFlashVersion": integer,
  "thirdPartyBackupImageImpressionsUrl": string,
  "thirdPartyRichMediaImpressionsUrl": string,
  "totalFileSize": string,
  "mediaDuration": number,
  "commercialId": string,
  "companionCreatives": [
    string
  ],
  "mediaDescription": string,
  "skippable": boolean,
  "thirdPartyUrls": [
    {
      object (ThirdPartyTrackingUrl)
    }
  ],
  "adParameters": string,
  "overrideCss": string,
  "studioCreativeId": string,
  "studioTraffickedCreativeId": string,
  "latestTraffickedCreativeId": string,
  "studioAdvertiserId": string,
  "autoAdvanceImages": boolean,
  "backupImageReportingLabel": string,
  "convertFlashToHtml5": boolean,
  "idDimensionValue": {
    object (DimensionValue)
  },
  "renderingIdDimensionValue": {
    object (DimensionValue)
  },
  "sslOverride": boolean,
  "skipOffset": {
    object (VideoOffset)
  },
  "progressOffset": {
    object (VideoOffset)
  },
  "obaIcon": {
    object (ObaIcon)
  },
  "authoringSource": enum (AuthoringSource),
  "dynamicAssetSelection": boolean,
  "creativeAssetSelection": {
    object (CreativeAssetSelection)
  },
  "universalAdId": {
    object (UniversalAdId)
  },
  "backupImageClickThroughUrl": {
    object (CreativeClickThroughUrl)
  },
  "additionalSizes": [
    {
      object (Size)
    }
  ]
}
Fields
id

string (int64 format)

ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.

name

string

Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.

renderingId

string (int64 format)

ID of current rendering version. This is a read-only field. Applicable to all creative types.

advertiserId

string (int64 format)

Advertiser ID of this creative. This is a required field. Applicable to all creative types.

accountId

string (int64 format)

Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.

subaccountId

string (int64 format)

Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.

active

boolean

Whether the creative is active. Applicable to all creative types.

archived

boolean

Whether the creative is archived. Applicable to all creative types.

version

integer

The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.

size

object (Size)

Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for

IMAGE

,

FLASH_INPAGE

creatives, and for

DISPLAY

creatives with a primary asset of type

HTML_IMAGE

, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types:

DISPLAY

,

DISPLAY_IMAGE_GALLERY

,

FLASH_INPAGE

,

HTML5_BANNER

,

IMAGE

, and all

RICH_MEDIA

.

creativeFieldAssignments[]

object (CreativeFieldAssignment)

Creative field assignments for this creative. Applicable to all creative types.

kind

string

Identifies what kind of resource this is. Value: the fixed string

"dfareporting#creative"

.

lastModifiedInfo

object (LastModifiedInfo)

Creative last modification information. This is a read-only field. Applicable to all creative types.

sslCompliant

boolean

Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.

compatibility[]

enum (Compatibility)

Compatibilities associated with this creative. This is a read-only field.

DISPLAY

and

DISPLAY_INTERSTITIAL

refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively.

APP

and

APP_INTERSTITIAL

are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned

DISPLAY

or

DISPLAY_INTERSTITIAL

instead.

IN_STREAM_VIDEO

refers to rendering in in-stream video ads developed with the VAST standard.

IN_STREAM_AUDIO

refers to rendering in in-stream audio ads developed with the VAST standard. Applicable to all creative types.

Acceptable values are:

  • "

    APP

    "

  • "

    APP_INTERSTITIAL

    "

  • "

    IN_STREAM_VIDEO

    "

  • "

    IN_STREAM_AUDIO

    "

  • "

    DISPLAY

    "

  • "

    DISPLAY_INTERSTITIAL

    "

type

enum (Type)

Type of this creative. This is a required field. Applicable to all creative types.

Note:

FLASH_INPAGE

,

HTML5_BANNER

, and

IMAGE

are only used for existing creatives. New creatives should use

DISPLAY

as a replacement for these types.

creativeAssets[]

object (CreativeAsset)

Assets associated with a creative. Applicable to all but the following creative types:

INTERNAL_REDIRECT

,

INTERSTITIAL_INTERNAL_REDIRECT

, and

REDIRECT

redirectUrl

string

URL of hosted image or hosted video or another ad tag. For

INSTREAM_VIDEO_REDIRECT

creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types:

DISPLAY_REDIRECT

,

INTERNAL_REDIRECT

,

INTERSTITIAL_INTERNAL_REDIRECT

, and

INSTREAM_VIDEO_REDIRECT

htmlCode

string

HTML code for the creative. This is a required field when applicable. This field is ignored if

htmlCodeLocked

is true. Applicable to the following creative types: all

CUSTOM

,

FLASH_INPAGE

, and

HTML5_BANNER

, and all

RICH_MEDIA

.

htmlCodeLocked

boolean

Whether HTML code is generated by Campaign Manager or manually entered. Set to true to ignore changes to

htmlCode

. Applicable to the following creative types:

FLASH_INPAGE

and

HTML5_BANNER

.

backgroundColor

string

The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types:

FLASH_INPAGE

.

allowScriptAccess

boolean

Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types:

FLASH_INPAGE

.

fsCommand

object (FsCommand)

OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if

allowScriptAccess

field is true. Applicable to the following creative types:

FLASH_INPAGE

.

backupImageTargetWindow

object (TargetWindow)

Target window for backup image. Applicable to the following creative types:

FLASH_INPAGE

and

HTML5_BANNER

. Applicable to

DISPLAY

when the primary asset type is not

HTML_IMAGE

.

clickTags[]

object (ClickTag)

Click tags of the creative. For

DISPLAY

,

FLASH_INPAGE

, and

HTML5_BANNER

creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the

creativeAssetMetadata

. When inserting the creative, populate the creative

clickTags

field using the

creativeAssetMetadata.clickTags

field. For

DISPLAY_IMAGE_GALLERY

creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the

clickTag.name

field with the

creativeAsset.assetIdentifier.name

field. Applicable to the following creative types:

DISPLAY_IMAGE_GALLERY

,

FLASH_INPAGE

,

HTML5_BANNER

. Applicable to

DISPLAY

when the primary asset type is not

HTML_IMAGE

.

backupImageFeatures[]

enum (BackupImageFeatures)

accountPermissionGroups.list of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by Campaign Manager for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the

creativeAssets

' detected features. Applicable to the following creative types:

HTML5_BANNER

. Applicable to

DISPLAY

when the primary asset type is not

HTML_IMAGE

.

authoringTool

enum (AuthoringTool)

Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types:

HTML5_BANNER

.

requiredFlashPluginVersion

string

The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all

RICH_MEDIA

, and all

VPAID

.

adTagKeys[]

string

Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all

RICH_MEDIA

, and all

VPAID

.

customKeyValues[]

string

Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all

RICH_MEDIA

, and all

VPAID

.

counterCustomEvents[]

object (CreativeCustomEvent)

accountPermissionGroups.list of counter events configured for the creative. For

DISPLAY_IMAGE_GALLERY

creatives, these are read-only and auto-generated from

clickTags

. Applicable to the following creative types:

DISPLAY_IMAGE_GALLERY

, all

RICH_MEDIA

, and all

VPAID

.

exitCustomEvents[]

object (CreativeCustomEvent)

accountPermissionGroups.list of exit events configured for the creative. For

DISPLAY

and

DISPLAY_IMAGE_GALLERY

creatives, these are read-only and auto-generated from

clickTags

, For

DISPLAY

, an event is also created from the

backupImageReportingLabel

. Applicable to the following creative types:

DISPLAY_IMAGE_GALLERY

, all

RICH_MEDIA

, and all

VPAID

. Applicable to

DISPLAY

when the primary asset type is not

HTML_IMAGE

.

timerCustomEvents[]

object (CreativeCustomEvent)

accountPermissionGroups.list of timer events configured for the creative. For

DISPLAY_IMAGE_GALLERY

creatives, these are read-only and auto-generated from

clickTags

. Applicable to the following creative types:

DISPLAY_IMAGE_GALLERY

, all

RICH_MEDIA

, and all

VPAID

. Applicable to

DISPLAY

when the primary asset is not

HTML_IMAGE

.

artworkType

enum (ArtworkType)

Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all

RICH_MEDIA

, and all

VPAID

.

requiredFlashVersion

integer

The internal Flash version for this creative as calculated by Studio. This is a read-only field. Applicable to the following creative types:

FLASH_INPAGE

all

RICH_MEDIA

, and all

VPAID

. Applicable to

DISPLAY

when the primary asset type is not

HTML_IMAGE

.

thirdPartyBackupImageImpressionsUrl

string

Third-party URL used to record backup image impressions. Applicable to the following creative types: all

RICH_MEDIA

.

thirdPartyRichMediaImpressionsUrl

string

Third-party URL used to record rich media impressions. Applicable to the following creative types: all

RICH_MEDIA

.

totalFileSize

string (int64 format)

Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all

RICH_MEDIA

, and all

VPAID

.

mediaDuration

number

Creative audio or video duration in seconds. This is a read-only field. Applicable to the following creative types:

INSTREAM_VIDEO

,

INSTREAM_AUDIO

, all

RICH_MEDIA

, and all

VPAID

.

commercialId

string

Industry standard ID assigned to creative for reach and frequency. Applicable to

INSTREAM_VIDEO_REDIRECT

creatives.

companionCreatives[]

string (int64 format)

accountPermissionGroups.list of companion creatives assigned to an in-Stream video creative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all

VPAID

, all

INSTREAM_AUDIO

and all

INSTREAM_VIDEO

with

dynamicAssetSelection

set to false.

mediaDescription

string

Description of the audio or video ad. Applicable to the following creative types: all

INSTREAM_VIDEO

,

INSTREAM_AUDIO

, and all

VPAID

.

skippable

boolean

Whether the user can choose to skip the creative. Applicable to the following creative types: all

INSTREAM_VIDEO

and all

VPAID

.

thirdPartyUrls[]

object (ThirdPartyTrackingUrl)

Third-party URLs for tracking in-stream creative events. Applicable to the following creative types: all

INSTREAM_VIDEO

, all

INSTREAM_AUDIO

, and all

VPAID

.

adParameters

string

Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all

VPAID

.

overrideCss

string

Override CSS value for rich media creatives. Applicable to the following creative types: all

RICH_MEDIA

.

studioCreativeId

string (int64 format)

Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all

RICH_MEDIA

, and all

VPAID

.

studioTraffickedCreativeId

string (int64 format)

Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all

RICH_MEDIA

, and all

VPAID

.

latestTraffickedCreativeId

string (int64 format)

Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all

RICH_MEDIA

, and all

VPAID

.

studioAdvertiserId

string (int64 format)

Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all

RICH_MEDIA

, and all

VPAID

.

autoAdvanceImages

boolean

Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types:

DISPLAY_IMAGE_GALLERY

.

backupImageReportingLabel

string

Reporting label used for HTML5 banner backup image. Applicable to the following creative types:

DISPLAY

when the primary asset type is not

HTML_IMAGE

.

convertFlashToHtml5

boolean

Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type:

FLASH_INPAGE

. Applicable to

DISPLAY

when the primary asset type is not

HTML_IMAGE

.

idDimensionValue

object (DimensionValue)

Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.

renderingIdDimensionValue

object (DimensionValue)

Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.

sslOverride

boolean

Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.

skipOffset

object (VideoOffset)

Amount of time to play the video before the skip button appears. Applicable to the following creative types: all

INSTREAM_VIDEO

.

progressOffset

object (VideoOffset)

Amount of time to play the video before counting a view. Applicable to the following creative types: all

INSTREAM_VIDEO

.

obaIcon

object (ObaIcon)

Online behavioral advertising icon to be added to the creative. Applicable to the following creative types: all

INSTREAM_VIDEO

.

authoringSource

enum (AuthoringSource)

Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.

dynamicAssetSelection

boolean

Set this to true to enable the use of rules to target individual assets in this creative. When set to true

creativeAssetSelection

must be set. This also controls asset-level companions. When this is true, companion creatives should be assigned to creative assets. Learn more. Applicable to

INSTREAM_VIDEO

creatives.

creativeAssetSelection

object (CreativeAssetSelection)

Required if

dynamicAssetSelection

is true.

universalAdId

object (UniversalAdId)

A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types:

INSTREAM_AUDIO

and

INSTREAM_VIDEO

and

VPAID

.

backupImageClickThroughUrl

object (CreativeClickThroughUrl)

Click-through URL for backup image. Applicable to

ENHANCED_BANNER

when the primary asset type is not

HTML_IMAGE

.

additionalSizes[]

object (Size)

Additional sizes associated with a responsive creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. Applicable to

DISPLAY

creatives when the primary asset type is

HTML_IMAGE

.

CreativeFieldAssignment

Creative Field Assignment.

JSON representation
{
  "creativeFieldId": string,
  "creativeFieldValueId": string
}
Fields
creativeFieldId

string (int64 format)

ID of the creative field.

creativeFieldValueId

string (int64 format)

ID of the creative field value.

Compatibility

Enums
DISPLAY
DISPLAY_INTERSTITIAL
APP
APP_INTERSTITIAL
IN_STREAM_VIDEO
IN_STREAM_AUDIO

Type

Enums
IMAGE
DISPLAY_REDIRECT
CUSTOM_DISPLAY
INTERNAL_REDIRECT
CUSTOM_DISPLAY_INTERSTITIAL
INTERSTITIAL_INTERNAL_REDIRECT
TRACKING_TEXT
RICH_MEDIA_DISPLAY_BANNER
RICH_MEDIA_INPAGE_FLOATING
RICH_MEDIA_IM_EXPAND
RICH_MEDIA_DISPLAY_EXPANDING
RICH_MEDIA_DISPLAY_INTERSTITIAL
RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL
RICH_MEDIA_MOBILE_IN_APP
FLASH_INPAGE
INSTREAM_VIDEO
VPAID_LINEAR_VIDEO
VPAID_NON_LINEAR_VIDEO
INSTREAM_VIDEO_REDIRECT
RICH_MEDIA_PEEL_DOWN
HTML5_BANNER
DISPLAY
BRAND_SAFE_DEFAULT_INSTREAM_VIDEO
INSTREAM_AUDIO

CreativeAsset

Creative Asset.

JSON representation
{
  "id": string,
  "assetIdentifier": {
    object (CreativeAssetId)
  },
  "sslCompliant": boolean,
  "size": {
    object (Size)
  },
  "fileSize": string,
  "flashVersion": integer,
  "actionScript3": boolean,
  "zipFilename": string,
  "zipFilesize": string,
  "detectedFeatures": [
    enum (DetectedFeatures)
  ],
  "displayType": enum (DisplayType),
  "artworkType": enum (ArtworkType),
  "collapsedSize": {
    object (Size)
  },
  "offset": {
    object (OffsetPosition)
  },
  "zIndex": integer,
  "windowMode": enum (WindowMode),
  "transparency": boolean,
  "pushdown": boolean,
  "pushdownDuration": number,
  "position": {
    object (OffsetPosition)
  },
  "positionTopUnit": enum (PositionTopUnit),
  "positionLeftUnit": enum (PositionLeftUnit),
  "verticallyLocked": boolean,
  "horizontallyLocked": boolean,
  "startTimeType": enum (StartTimeType),
  "customStartTimeValue": integer,
  "durationType": enum (DurationType),
  "duration": integer,
  "hideFlashObjects": boolean,
  "hideSelectionBoxes": boolean,
  "alignment": enum (Alignment),
  "childAssetType": enum (ChildAssetType),
  "originalBackup": boolean,
  "bitRate": integer,
  "mimeType": string,
  "active": boolean,
  "progressiveServingUrl": string,
  "streamingServingUrl": string,
  "mediaDuration": number,
  "expandedDimension": {
    object (Size)
  },
  "role": enum (Role),
  "backupImageExit": {
    object (CreativeCustomEvent)
  },
  "companionCreativeIds": [
    string
  ],
  "idDimensionValue": {
    object (DimensionValue)
  },
  "orientation": enum (Orientation),
  "additionalSizes": [
    {
      object (Size)
    }
  ],
  "audioBitRate": integer,
  "audioSampleRate": integer,
  "frameRate": number,
  "politeLoad": boolean
}
Fields
id

string (int64 format)

Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all

REDIRECT

and

TRACKING_TEXT

.

assetIdentifier

object (CreativeAssetId)

Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all

REDIRECT

and

TRACKING_TEXT

.

sslCompliant

boolean

Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all

REDIRECT

and

TRACKING_TEXT

.

size

object (Size)

Size associated with this creative asset. This is a required field when applicable; however for

IMAGE

and

FLASH_INPAGE

, creatives if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types:

DISPLAY_IMAGE_GALLERY

,

FLASH_INPAGE

,

HTML5_BANNER

,

IMAGE

, and all

RICH_MEDIA

. Applicable to

DISPLAY

when the primary asset type is not

HTML_IMAGE

.

fileSize

string (int64 format)

File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all

REDIRECT

and

TRACKING_TEXT

.

flashVersion

integer

Flash version of the asset. This is a read-only field. Applicable to the following creative types:

FLASH_INPAGE

, all

RICH_MEDIA

, and all

VPAID

. Applicable to

DISPLAY

when the primary asset type is not

HTML_IMAGE

.

actionScript3

boolean

Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type:

FLASH_INPAGE

. Applicable to

DISPLAY

when the primary asset type is not

HTML_IMAGE

.

zipFilename

string

File name of zip file. This is a read-only field. Applicable to the following creative types:

HTML5_BANNER

.

zipFilesize

string

Size of zip file. This is a read-only field. Applicable to the following creative types:

HTML5_BANNER

.

detectedFeatures[]

enum (DetectedFeatures)

accountPermissionGroups.list of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types:

HTML5_BANNER

. Applicable to

DISPLAY

when the primary asset type is not

HTML_IMAGE

.

displayType

enum (DisplayType)

Type of rich media asset. This is a read-only field. Applicable to the following creative types: all

RICH_MEDIA

.

artworkType

enum (ArtworkType)

Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all

RICH_MEDIA

.

collapsedSize

object (Size)

Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all

RICH_MEDIA

and all

VPAID

. Additionally, applicable to assets whose

displayType

is

ASSET_DISPLAY_TYPE_EXPANDING

or

ASSET_DISPLAY_TYPE_PEEL_DOWN

.

offset

object (OffsetPosition)

Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all

RICH_MEDIA

and all

VPAID

. Additionally, only applicable to assets whose

displayType

is

ASSET_DISPLAY_TYPE_EXPANDING

or

ASSET_DISPLAY_TYPE_PEEL_DOWN

.

zIndex

integer

zIndex value of an asset. Applicable to the following creative types: all

RICH_MEDIA

.Additionally, only applicable to assets whose

displayType

is NOT one of the following types:

ASSET_DISPLAY_TYPE_INPAGE

or

ASSET_DISPLAY_TYPE_OVERLAY

. Acceptable values are

-999999999

to

999999999

, inclusive.

windowMode

enum (WindowMode)

Window mode options for flash assets. Applicable to the following creative types:

FLASH_INPAGE

,

RICH_MEDIA_DISPLAY_EXPANDING

,

RICH_MEDIA_IM_EXPAND

,

RICH_MEDIA_DISPLAY_BANNER

, and

RICH_MEDIA_INPAGE_FLOATING

.

transparency

boolean

Whether the asset is transparent. Applicable to the following creative types: all

RICH_MEDIA

. Additionally, only applicable to

HTML5

assets.

pushdown

boolean

Whether the asset pushes down other content. Applicable to the following creative types: all

RICH_MEDIA

. Additionally, only applicable when the asset offsets are 0, the

collapsedSize.width

matches

size.width

, and the

collapsedSize.height

is less than

size.height

.

pushdownDuration

number

Pushdown duration in seconds for an asset. Applicable to the following creative types: all

RICH_MEDIA

.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the

collapsedSize.width

matches

size.width

, and the

collapsedSize.height

is less than

size.height

. Acceptable values are

0

to

9.99

, inclusive.

position

object (OffsetPosition)

Offset position for an asset. Applicable to the following creative types: all

RICH_MEDIA

.

positionTopUnit

enum (PositionTopUnit)

Offset top unit for an asset. This is a read-only field if the asset

displayType

is

ASSET_DISPLAY_TYPE_OVERLAY

. Applicable to the following creative types: all

RICH_MEDIA

.

positionLeftUnit

enum (PositionLeftUnit)

Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all

RICH_MEDIA

.

verticallyLocked

boolean

Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all

RICH_MEDIA

.

horizontallyLocked

boolean

Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all

RICH_MEDIA

.

startTimeType

enum (StartTimeType)

Initial wait time type before making the asset visible. Applicable to the following creative types: all

RICH_MEDIA

.

customStartTimeValue

integer

Custom start time in seconds for making the asset visible. Applicable to the following creative types: all

RICH_MEDIA

. Value must be greater than or equal to

0

.

durationType

enum (DurationType)

Duration type for which an asset will be displayed. Applicable to the following creative types: all

RICH_MEDIA

.

duration

integer

Duration in seconds for which an asset will be displayed. Applicable to the following creative types:

INSTREAM_AUDIO

,

INSTREAM_VIDEO

and

VPAID_LINEAR_VIDEO

. Value must be greater than or equal to

1

.

hideFlashObjects

boolean

Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all

RICH_MEDIA

.

hideSelectionBoxes

boolean

Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all

RICH_MEDIA

.

alignment

enum (Alignment)

Possible alignments for an asset. This is a read-only field. Applicable to the following creative types:

RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL

.

childAssetType

enum (ChildAssetType)

Rich media child asset type. This is a read-only field. Applicable to the following creative types: all

VPAID

.

originalBackup

boolean

Whether the backup asset is original or changed by the user in Campaign Manager. Applicable to the following creative types: all

RICH_MEDIA

.

bitRate

integer

Detected bit-rate for audio or video asset. This is a read-only field. Applicable to the following creative types:

INSTREAM_AUDIO

,

INSTREAM_VIDEO

and all

VPAID

.

mimeType

string

Detected MIME type for audio or video asset. This is a read-only field. Applicable to the following creative types:

INSTREAM_AUDIO

,

INSTREAM_VIDEO

and all

VPAID

.

active

boolean

Whether the video or audio asset is active. This is a read-only field for

VPAID_NON_LINEAR_VIDEO

assets. Applicable to the following creative types:

INSTREAM_AUDIO

,

INSTREAM_VIDEO

and all

VPAID

.

progressiveServingUrl

string

Progressive URL for video asset. This is a read-only field. Applicable to the following creative types:

INSTREAM_VIDEO

and all

VPAID

.

streamingServingUrl

string

Streaming URL for video asset. This is a read-only field. Applicable to the following creative types:

INSTREAM_VIDEO

and all

VPAID

.

mediaDuration

number

Detected duration for audio or video asset. This is a read-only field. Applicable to the following creative types:

INSTREAM_AUDIO

,

INSTREAM_VIDEO

and all

VPAID

.

expandedDimension

object (Size)

Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types:

INSTREAM_VIDEO

and all

VPAID

.

role

enum (Role)

Role of the asset in relation to creative. Applicable to all but the following creative types: all

REDIRECT

and

TRACKING_TEXT

. This is a required field.

PRIMARY

applies to

DISPLAY

,

FLASH_INPAGE

,

HTML5_BANNER

,

IMAGE

,

DISPLAY_IMAGE_GALLERY

, all

RICH_MEDIA

(which may contain multiple primary assets), and all

VPAID

creatives.

BACKUP_IMAGE

applies to

FLASH_INPAGE

,

HTML5_BANNER

,

all RICH_MEDIA

, and all

VPAID

creatives. Applicable to

DISPLAY

when the primary asset type is not

HTML_IMAGE

.

ADDITIONAL_IMAGE

and

ADDITIONAL_FLASH

apply to

FLASH_INPAGE

creatives.

OTHER

refers to assets from sources other than Campaign Manager, such as Studio uploaded assets, applicable to all

RICH_MEDIA

and all

VPAID

creatives.

PARENT_VIDEO

refers to videos uploaded by the user in Campaign Manager and is applicable to

INSTREAM_VIDEO

and

VPAID_LINEAR_VIDEO

creatives.

TRANSCODED_VIDEO

refers to videos transcoded by Campaign Manager from

PARENT_VIDEO

assets and is applicable to

INSTREAM_VIDEO

and

VPAID_LINEAR_VIDEO

creatives.

ALTERNATE_VIDEO

refers to the Campaign Manager representation of child asset videos from Studio, and is applicable to

VPAID_LINEAR_VIDEO

creatives. These cannot be added or removed within Campaign Manager.

For

VPAID_LINEAR_VIDEO

creatives,

PARENT_VIDEO

,

TRANSCODED_VIDEO

and

ALTERNATE_VIDEO

assets that are marked

active

serve as backup in case the

VPAID

creative cannot be served. Only

PARENT_VIDEO

assets can be added or removed for an

INSTREAM_VIDEO

or

VPAID_LINEAR_VIDEO

creative.

PARENT_AUDIO

refers to audios uploaded by the user in Campaign Manager and is applicable to

INSTREAM_AUDIO

creatives.

TRANSCODED_AUDIO

refers to audios transcoded by Campaign Manager from

PARENT_AUDIO

assets and is applicable to

INSTREAM_AUDIO

creatives.

backupImageExit

object (CreativeCustomEvent)

Exit event configured for the backup image. Applicable to the following creative types: all

RICH_MEDIA

.

companionCreativeIds[]

string (int64 format)

accountPermissionGroups.list of companion creatives assigned to an in-stream video creative asset. Acceptable values include IDs of existing flash and image creatives. Applicable to

INSTREAM_VIDEO

creative type with

dynamicAssetSelection

set to true.

idDimensionValue

object (DimensionValue)

Dimension value for the ID of the asset. This is a read-only, auto-generated field.

orientation

enum (Orientation)

Orientation of video asset. This is a read-only, auto-generated field.

additionalSizes[]

object (Size)

Additional sizes associated with this creative asset. HTML5 asset generated by compatible software such as GWD will be able to support more sizes this creative asset can render.

audioBitRate

integer

Audio stream bit rate in kbps. This is a read-only field. Applicable to the following creative types:

INSTREAM_AUDIO

,

INSTREAM_VIDEO

and all

VPAID

.

audioSampleRate

integer

Audio sample bit rate in hertz. This is a read-only field. Applicable to the following creative types:

INSTREAM_AUDIO

,

INSTREAM_VIDEO

and all

VPAID

.

frameRate

number

Video frame rate for video asset in frames per second. This is a read-only field. Applicable to the following creative types:

INSTREAM_VIDEO

and all

VPAID

.

politeLoad

boolean

Whether this asset is used as a polite load asset.

CreativeAssetId

Creative Asset ID.

JSON representation
{
  "type": enum (Type),
  "name": string
}
Fields
type

enum (Type)

Type of asset to upload. This is a required field.

FLASH

and

IMAGE

are no longer supported for new uploads. All image assets should use

HTML_IMAGE

.

name

string

Name of the creative asset. This is a required field while inserting an asset. After insertion, this

assetIdentifier

is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: "

.-_

". Spaces are allowed.

Type

Enums
IMAGE
FLASH
VIDEO
HTML
HTML_IMAGE
AUDIO

DetectedFeatures

Enums
CSS_FONT_FACE
CSS_BACKGROUND_SIZE
CSS_BORDER_IMAGE
CSS_BORDER_RADIUS
CSS_BOX_SHADOW
CSS_FLEX_BOX
CSS_HSLA
CSS_MULTIPLE_BGS
CSS_OPACITY
CSS_RGBA
CSS_TEXT_SHADOW
CSS_ANIMATIONS
CSS_COLUMNS
CSS_GENERATED_CONTENT
CSS_GRADIENTS
CSS_REFLECTIONS
CSS_TRANSFORMS
CSS_TRANSFORMS3D
CSS_TRANSITIONS
APPLICATION_CACHE
CANVAS
CANVAS_TEXT
DRAG_AND_DROP
HASH_CHANGE
HISTORY
AUDIO
VIDEO
INDEXED_DB
INPUT_ATTR_AUTOCOMPLETE
INPUT_ATTR_AUTOFOCUS
INPUT_ATTR_LIST
INPUT_ATTR_PLACEHOLDER
INPUT_ATTR_MAX
INPUT_ATTR_MIN
INPUT_ATTR_MULTIPLE
INPUT_ATTR_PATTERN
INPUT_ATTR_REQUIRED
INPUT_ATTR_STEP
INPUT_TYPE_TEL
INPUT_TYPE_URL
INPUT_TYPE_EMAIL
INPUT_TYPE_DATETIME
INPUT_TYPE_DATE
INPUT_TYPE_MONTH
INPUT_TYPE_WEEK
INPUT_TYPE_TIME
INPUT_TYPE_DATETIME_LOCAL
INPUT_TYPE_NUMBER
INPUT_TYPE_RANGE
INPUT_TYPE_COLOR
LOCAL_STORAGE
POST_MESSAGE
SESSION_STORAGE
WEB_SOCKETS
WEB_SQL_DATABASE
WEB_WORKERS
GEO_LOCATION
INLINE_SVG
SMIL
SVG_HREF
SVG_CLIP_PATHS
TOUCH
WEBGL
SVG_FILTERS
SVG_FE_IMAGE

DisplayType

Enums
ASSET_DISPLAY_TYPE_INPAGE
ASSET_DISPLAY_TYPE_FLOATING
ASSET_DISPLAY_TYPE_OVERLAY
ASSET_DISPLAY_TYPE_EXPANDING
ASSET_DISPLAY_TYPE_FLASH_IN_FLASH
ASSET_DISPLAY_TYPE_FLASH_IN_FLASH_EXPANDING
ASSET_DISPLAY_TYPE_PEEL_DOWN
ASSET_DISPLAY_TYPE_VPAID_LINEAR
ASSET_DISPLAY_TYPE_VPAID_NON_LINEAR
ASSET_DISPLAY_TYPE_BACKDROP

ArtworkType

Enums
ARTWORK_TYPE_FLASH
ARTWORK_TYPE_HTML5
ARTWORK_TYPE_MIXED
ARTWORK_TYPE_IMAGE

OffsetPosition

Offset Position.

JSON representation
{
  "top": integer,
  "left": integer
}
Fields
top

integer

Offset distance from top side of an asset or a window.

left

integer

Offset distance from left side of an asset or a window.

WindowMode

Enums
OPAQUE
WINDOW
TRANSPARENT

PositionTopUnit

Enums
OFFSET_UNIT_PIXEL
OFFSET_UNIT_PERCENT
OFFSET_UNIT_PIXEL_FROM_CENTER

PositionLeftUnit

Enums
OFFSET_UNIT_PIXEL
OFFSET_UNIT_PERCENT
OFFSET_UNIT_PIXEL_FROM_CENTER

StartTimeType

Enums
ASSET_START_TIME_TYPE_NONE
ASSET_START_TIME_TYPE_CUSTOM

DurationType

Enums
ASSET_DURATION_TYPE_AUTO
ASSET_DURATION_TYPE_NONE
ASSET_DURATION_TYPE_CUSTOM

Alignment

Enums
ALIGNMENT_TOP
ALIGNMENT_RIGHT
ALIGNMENT_BOTTOM
ALIGNMENT_LEFT

ChildAssetType

Enums
CHILD_ASSET_TYPE_FLASH
CHILD_ASSET_TYPE_VIDEO
CHILD_ASSET_TYPE_IMAGE
CHILD_ASSET_TYPE_DATA

Role

Enums
PRIMARY
BACKUP_IMAGE
ADDITIONAL_IMAGE
ADDITIONAL_FLASH
PARENT_VIDEO
TRANSCODED_VIDEO
OTHER
ALTERNATE_VIDEO
PARENT_AUDIO
TRANSCODED_AUDIO

CreativeCustomEvent

Creative Custom Event.

JSON representation
{
  "artworkLabel": string,
  "id": string,
  "videoReportingId": string,
  "artworkType": enum (ArtworkType),
  "advertiserCustomEventName": string,
  "targetType": enum (TargetType),
  "advertiserCustomEventType": enum (AdvertiserCustomEventType),
  "popupWindowProperties": {
    object (PopupWindowProperties)
  },
  "advertiserCustomEventId": string,
  "exitClickThroughUrl": {
    object (CreativeClickThroughUrl)
  }
}
Fields
artworkLabel

string

Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.

id

string (int64 format)

ID of this event. This is a required field and should not be modified after insertion.

videoReportingId

string

Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.

artworkType

enum (ArtworkType)

Artwork type used by the creative.This is a read-only field.

advertiserCustomEventName

string

User-entered name for the event.

targetType

enum (TargetType)

Target type used by the event.

advertiserCustomEventType

enum (AdvertiserCustomEventType)

Type of the event. This is a read-only field.

popupWindowProperties

object (PopupWindowProperties)

Properties for rich media popup windows. This field is used only for exit events.

advertiserCustomEventId

string (int64 format)

Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.

exitClickThroughUrl

object (CreativeClickThroughUrl)

Exit click-through URL for the event. This field is used only for exit events.

ArtworkType

Enums
ARTWORK_TYPE_FLASH
ARTWORK_TYPE_HTML5
ARTWORK_TYPE_MIXED
ARTWORK_TYPE_IMAGE

TargetType

Enums
TARGET_BLANK
TARGET_TOP
TARGET_SELF
TARGET_PARENT
TARGET_POPUP

AdvertiserCustomEventType

Enums
ADVERTISER_EVENT_TIMER
ADVERTISER_EVENT_EXIT
ADVERTISER_EVENT_COUNTER

PopupWindowProperties

Popup Window Properties.

JSON representation
{
  "offset": {
    object (OffsetPosition)
  },
  "showScrollBar": boolean,
  "showToolBar": boolean,
  "showMenuBar": boolean,
  "showAddressBar": boolean,
  "showStatusBar": boolean,
  "positionType": enum (PositionType),
  "dimension": {
    object (Size)
  },
  "title": string
}
Fields
offset

object (OffsetPosition)

Upper-left corner coordinates of the popup window. Applicable if

positionType

is

COORDINATES

.

showScrollBar

boolean

Whether to display the browser scroll bar.

showToolBar

boolean

Whether to display the browser tool bar.

showMenuBar

boolean

Whether to display the browser menu bar.

showAddressBar

boolean

Whether to display the browser address bar.

showStatusBar

boolean

Whether to display the browser status bar.

positionType

enum (PositionType)

Popup window position either centered or at specific coordinate.

dimension

object (Size)

Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all

RICH_MEDIA

and all

VPAID

title

string

Title of popup window.

PositionType

Enums
CENTER
COORDINATES

CreativeClickThroughUrl

Click-through URL

JSON representation
{
  "landingPageId": string,
  "customClickThroughUrl": string,
  "computedClickThroughUrl": string
}
Fields
landingPageId

string (int64 format)

ID of the landing page for the click-through URL.

customClickThroughUrl

string

Custom click-through URL. Applicable if the

landingPageId

field is left unset.

computedClickThroughUrl

string

Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:

  • If

    landingPageId

    is specified then that landing page's URL is assigned to this field.

  • Otherwise, the

    customClickThroughUrl

    is assigned to this field.

Orientation

Enums
LANDSCAPE
PORTRAIT
SQUARE

FsCommand

FsCommand.

JSON representation
{
  "positionOption": enum (PositionOption),
  "top": integer,
  "left": integer,
  "windowWidth": integer,
  "windowHeight": integer
}
Fields
positionOption

enum (PositionOption)

Position in the browser where the window will open.

top

integer

Distance from the top of the browser. Applicable when positionOption is

DISTANCE_FROM_TOP_LEFT_CORNER

.

left

integer

Distance from the left of the browser.Applicable when positionOption is

DISTANCE_FROM_TOP_LEFT_CORNER

.

windowWidth

integer

Width of the window.

windowHeight

integer

Height of the window.

PositionOption

Enums
CENTERED
DISTANCE_FROM_TOP_LEFT_CORNER

TargetWindow

Target Window.

JSON representation
{
  "targetWindowOption": enum (TargetWindowOption),
  "customHtml": string
}
Fields
targetWindowOption

enum (TargetWindowOption)

Type of browser window for which the backup image of the flash creative can be displayed.

customHtml

string

User-entered value.

TargetWindowOption

Enums
NEW_WINDOW
CURRENT_WINDOW
CUSTOM

ClickTag

Creative Click Tag.

JSON representation
{
  "name": string,
  "eventName": string,
  "clickThroughUrl": {
    object (CreativeClickThroughUrl)
  }
}
Fields
name

string

Parameter name for the specified click tag. For

DISPLAY_IMAGE_GALLERY

creative assets, this field must match the value of the creative asset's

creativeAssetId.name

field.

eventName

string

Advertiser event name associated with the click tag. This field is used by

DISPLAY_IMAGE_GALLERY

and

HTML5_BANNER

creatives. Applicable to

DISPLAY

when the primary asset type is not

HTML_IMAGE

.

clickThroughUrl

object (CreativeClickThroughUrl)

Parameter value for the specified click tag. This field contains a click-through url.

BackupImageFeatures

Enums
CSS_FONT_FACE
CSS_BACKGROUND_SIZE
CSS_BORDER_IMAGE
CSS_BORDER_RADIUS
CSS_BOX_SHADOW
CSS_FLEX_BOX
CSS_HSLA
CSS_MULTIPLE_BGS
CSS_OPACITY
CSS_RGBA
CSS_TEXT_SHADOW
CSS_ANIMATIONS
CSS_COLUMNS
CSS_GENERATED_CONTENT
CSS_GRADIENTS
CSS_REFLECTIONS
CSS_TRANSFORMS
CSS_TRANSFORMS3D
CSS_TRANSITIONS
APPLICATION_CACHE
CANVAS
CANVAS_TEXT
DRAG_AND_DROP
HASH_CHANGE
HISTORY
AUDIO
VIDEO
INDEXED_DB
INPUT_ATTR_AUTOCOMPLETE
INPUT_ATTR_AUTOFOCUS
INPUT_ATTR_LIST
INPUT_ATTR_PLACEHOLDER
INPUT_ATTR_MAX
INPUT_ATTR_MIN
INPUT_ATTR_MULTIPLE
INPUT_ATTR_PATTERN
INPUT_ATTR_REQUIRED
INPUT_ATTR_STEP
INPUT_TYPE_TEL
INPUT_TYPE_URL
INPUT_TYPE_EMAIL
INPUT_TYPE_DATETIME
INPUT_TYPE_DATE
INPUT_TYPE_MONTH
INPUT_TYPE_WEEK
INPUT_TYPE_TIME
INPUT_TYPE_DATETIME_LOCAL
INPUT_TYPE_NUMBER
INPUT_TYPE_RANGE
INPUT_TYPE_COLOR
LOCAL_STORAGE
POST_MESSAGE
SESSION_STORAGE
WEB_SOCKETS
WEB_SQL_DATABASE
WEB_WORKERS
GEO_LOCATION
INLINE_SVG
SMIL
SVG_HREF
SVG_CLIP_PATHS
TOUCH
WEBGL
SVG_FILTERS
SVG_FE_IMAGE

AuthoringTool

Enums
NINJA
SWIFFY

ArtworkType

Enums
ARTWORK_TYPE_FLASH
ARTWORK_TYPE_HTML5
ARTWORK_TYPE_MIXED
ARTWORK_TYPE_IMAGE

ThirdPartyTrackingUrl

Third-party Tracking URL.

JSON representation
{
  "thirdPartyUrlType": enum (ThirdPartyUrlType),
  "url": string
}
Fields
thirdPartyUrlType

enum (ThirdPartyUrlType)

Third-party URL type for in-stream video and in-stream audio creatives.

url

string

URL for the specified third-party URL type.

ThirdPartyUrlType

Enums
IMPRESSION
CLICK_TRACKING
VIDEO_START
VIDEO_FIRST_QUARTILE
VIDEO_MIDPOINT
VIDEO_THIRD_QUARTILE
VIDEO_COMPLETE
VIDEO_MUTE
VIDEO_PAUSE
VIDEO_REWIND
VIDEO_FULLSCREEN
VIDEO_STOP
VIDEO_CUSTOM
SURVEY
RICH_MEDIA_IMPRESSION
RICH_MEDIA_RM_IMPRESSION
RICH_MEDIA_BACKUP_IMPRESSION
VIDEO_SKIP
VIDEO_PROGRESS

AuthoringSource

Enums
CREATIVE_AUTHORING_SOURCE_DCM
CREATIVE_AUTHORING_SOURCE_DBM
CREATIVE_AUTHORING_SOURCE_STUDIO
CREATIVE_AUTHORING_SOURCE_GWD

CreativeAssetSelection

Encapsulates the list of rules for asset selection and a default asset in case none of the rules match. Applicable to

INSTREAM_VIDEO

creatives.

JSON representation
{
  "rules": [
    {
      object (Rule)
    }
  ],
  "defaultAssetId": string
}
Fields
rules[]

object (Rule)

Rules determine which asset will be served to a viewer. Rules will be evaluated in the order in which they are stored in this list. This list must contain at least one rule. Applicable to

INSTREAM_VIDEO

creatives.

defaultAssetId

string (int64 format)

A

creativeAssets[].id

. This should refer to one of the parent assets in this creative, and will be served if none of the rules match. This is a required field.

Rule

A rule associates an asset with a targeting template for asset-level targeting. Applicable to

INSTREAM_VIDEO

creatives.

JSON representation
{
  "name": string,
  "assetId": string,
  "targetingTemplateId": string
}
Fields
name

string

A user-friendly name for this rule. This is a required field.

assetId

string (int64 format)

A

creativeAssets[].id

. This should refer to one of the parent assets in this creative. This is a required field.

targetingTemplateId

string (int64 format)

A targeting template ID. The targeting from the targeting template will be used to determine whether this asset should be served. This is a required field.

UniversalAdId

A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types:

INSTREAM_AUDIO

,

INSTREAM_VIDEO

and

VPAID

.

JSON representation
{
  "registry": enum (Registry),
  "value": string
}
Fields
registry

enum (Registry)

Registry used for the Ad ID value.

value

string

ID value for this creative. Only alphanumeric characters and the following symbols are valid: "

_/-

". Maximum length is 64 characters. Read only when

registry

is

DCM

.

Registry

Enums
OTHER
AD_ID_OFFICIAL
CLEARCAST
DCM

Methods

get

Gets one creative by ID.

insert

Inserts a new creative.

list

Retrieves a list of creatives, possibly filtered.

patch

Updates an existing creative.

update

Updates an existing creative.