profileId INTEGER Required

User profile ID associated with this request

id INTEGER Required

Creative ID

accountId INTEGER

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

active BOOLEAN

Whether the creative is active. Applicable to all creative types

adParameters STRING

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

adTagKeys[] STRING

additionalSizes[] OBJECT

Represents the dimensions of ads, placements, creatives, or creative assets

additionalSizes[].height INTEGER

Height of this size. Acceptable values are 0 to 32767, inclusive

additionalSizes[].iab BOOLEAN

IAB standard size. This is a read-only, auto-generated field

additionalSizes[].id INTEGER

ID of this size. This is a read-only, auto-generated field

additionalSizes[].kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#size"

additionalSizes[].width INTEGER

Width of this size. Acceptable values are 0 to 32767, inclusive

advertiserId INTEGER

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

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

archived BOOLEAN

Whether the creative is archived. Applicable to all creative types

artworkType ENUMERATION

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

authoringSource ENUMERATION

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

authoringTool ENUMERATION

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

autoAdvanceImages BOOLEAN

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

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

backupImageClickThroughUrl OBJECT

Click-through URL

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

backupImageClickThroughUrl.customClickThroughUrl STRING

Custom click-through URL. Applicable if the landingPageId field is left unset

backupImageClickThroughUrl.landingPageId INTEGER

ID of the landing page for the click-through URL

backupImageFeatures[] ENUMERATION

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

backupImageTargetWindow OBJECT

Target Window

backupImageTargetWindow.customHtml STRING

User-entered value

backupImageTargetWindow.targetWindowOption ENUMERATION

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

clickTags[] OBJECT

Creative Click Tag

clickTags[].clickThroughUrl OBJECT

Click-through URL

clickTags[].clickThroughUrl.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.

clickTags[].clickThroughUrl.customClickThroughUrl STRING

Custom click-through URL. Applicable if the landingPageId field is left unset

clickTags[].clickThroughUrl.landingPageId INTEGER

ID of the landing page for the click-through URL

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

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

commercialId STRING

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

companionCreatives[] INTEGER

compatibility[] ENUMERATION

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

counterCustomEvents[] OBJECT

Creative Custom Event

counterCustomEvents[].advertiserCustomEventId INTEGER

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

counterCustomEvents[].advertiserCustomEventName STRING

User-entered name for the event

counterCustomEvents[].advertiserCustomEventType ENUMERATION

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

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

counterCustomEvents[].artworkType ENUMERATION

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

counterCustomEvents[].exitClickThroughUrl OBJECT

Click-through URL

counterCustomEvents[].exitClickThroughUrl.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.

counterCustomEvents[].exitClickThroughUrl.customClickThroughUrl STRING

Custom click-through URL. Applicable if the landingPageId field is left unset

counterCustomEvents[].exitClickThroughUrl.landingPageId INTEGER

ID of the landing page for the click-through URL

counterCustomEvents[].id INTEGER

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

counterCustomEvents[].popupWindowProperties OBJECT

Popup Window Properties

counterCustomEvents[].popupWindowProperties.dimension OBJECT

Represents the dimensions of ads, placements, creatives, or creative assets

counterCustomEvents[].popupWindowProperties.dimension.height INTEGER

Height of this size. Acceptable values are 0 to 32767, inclusive

counterCustomEvents[].popupWindowProperties.dimension.iab BOOLEAN

IAB standard size. This is a read-only, auto-generated field

counterCustomEvents[].popupWindowProperties.dimension.id INTEGER

ID of this size. This is a read-only, auto-generated field

counterCustomEvents[].popupWindowProperties.dimension.kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#size"

counterCustomEvents[].popupWindowProperties.dimension.width INTEGER

Width of this size. Acceptable values are 0 to 32767, inclusive

counterCustomEvents[].popupWindowProperties.offset OBJECT

Offset Position

counterCustomEvents[].popupWindowProperties.offset.left INTEGER

Offset distance from left side of an asset or a window

counterCustomEvents[].popupWindowProperties.offset.top INTEGER

Offset distance from top side of an asset or a window

counterCustomEvents[].popupWindowProperties.positionType ENUMERATION

Popup window position either centered or at specific coordinate

counterCustomEvents[].popupWindowProperties.showAddressBar BOOLEAN

Whether to display the browser address bar

counterCustomEvents[].popupWindowProperties.showMenuBar BOOLEAN

Whether to display the browser menu bar

counterCustomEvents[].popupWindowProperties.showScrollBar BOOLEAN

Whether to display the browser scroll bar

counterCustomEvents[].popupWindowProperties.showStatusBar BOOLEAN

Whether to display the browser status bar

counterCustomEvents[].popupWindowProperties.showToolBar BOOLEAN

Whether to display the browser tool bar

counterCustomEvents[].popupWindowProperties.title STRING

Title of popup window

counterCustomEvents[].targetType ENUMERATION

Target type used by the event

counterCustomEvents[].videoReportingId STRING

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

creativeAssetSelection OBJECT

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

creativeAssetSelection.defaultAssetId INTEGER

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

creativeAssetSelection.rules[] OBJECT

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

creativeAssetSelection.rules[].assetId INTEGER

A creativeAssets[].id. This should refer to one of the parent assets in this creative. This is a required field

creativeAssetSelection.rules[].name STRING

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

creativeAssetSelection.rules[].targetingTemplateId INTEGER

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

creativeAssets[] OBJECT

Creative Asset

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

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

creativeAssets[].additionalSizes[] OBJECT

Represents the dimensions of ads, placements, creatives, or creative assets

creativeAssets[].additionalSizes[].height INTEGER

Height of this size. Acceptable values are 0 to 32767, inclusive

creativeAssets[].additionalSizes[].iab BOOLEAN

IAB standard size. This is a read-only, auto-generated field

creativeAssets[].additionalSizes[].id INTEGER

ID of this size. This is a read-only, auto-generated field

creativeAssets[].additionalSizes[].kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#size"

creativeAssets[].additionalSizes[].width INTEGER

Width of this size. Acceptable values are 0 to 32767, inclusive

creativeAssets[].alignment ENUMERATION

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

creativeAssets[].artworkType ENUMERATION

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

creativeAssets[].assetIdentifier OBJECT

Creative Asset ID

creativeAssets[].assetIdentifier.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

creativeAssets[].assetIdentifier.type ENUMERATION

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

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

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

creativeAssets[].backupImageExit OBJECT

Creative Custom Event

creativeAssets[].backupImageExit.advertiserCustomEventId INTEGER

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

creativeAssets[].backupImageExit.advertiserCustomEventName STRING

User-entered name for the event

creativeAssets[].backupImageExit.advertiserCustomEventType ENUMERATION

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

creativeAssets[].backupImageExit.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

creativeAssets[].backupImageExit.artworkType ENUMERATION

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

creativeAssets[].backupImageExit.exitClickThroughUrl OBJECT

Click-through URL

creativeAssets[].backupImageExit.exitClickThroughUrl.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.

creativeAssets[].backupImageExit.exitClickThroughUrl.customClickThroughUrl STRING

Custom click-through URL. Applicable if the landingPageId field is left unset

creativeAssets[].backupImageExit.exitClickThroughUrl.landingPageId INTEGER

ID of the landing page for the click-through URL

creativeAssets[].backupImageExit.id INTEGER

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

creativeAssets[].backupImageExit.popupWindowProperties OBJECT

Popup Window Properties

creativeAssets[].backupImageExit.popupWindowProperties.positionType ENUMERATION

Popup window position either centered or at specific coordinate

creativeAssets[].backupImageExit.popupWindowProperties.showAddressBar BOOLEAN

Whether to display the browser address bar

creativeAssets[].backupImageExit.popupWindowProperties.showMenuBar BOOLEAN

Whether to display the browser menu bar

creativeAssets[].backupImageExit.popupWindowProperties.showScrollBar BOOLEAN

Whether to display the browser scroll bar

creativeAssets[].backupImageExit.popupWindowProperties.showStatusBar BOOLEAN

Whether to display the browser status bar

creativeAssets[].backupImageExit.popupWindowProperties.showToolBar BOOLEAN

Whether to display the browser tool bar

creativeAssets[].backupImageExit.popupWindowProperties.title STRING

Title of popup window

creativeAssets[].backupImageExit.targetType ENUMERATION

Target type used by the event

creativeAssets[].backupImageExit.videoReportingId STRING

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

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

creativeAssets[].childAssetType ENUMERATION

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

creativeAssets[].collapsedSize OBJECT

Represents the dimensions of ads, placements, creatives, or creative assets

creativeAssets[].collapsedSize.height INTEGER

Height of this size. Acceptable values are 0 to 32767, inclusive

creativeAssets[].collapsedSize.iab BOOLEAN

IAB standard size. This is a read-only, auto-generated field

creativeAssets[].collapsedSize.id INTEGER

ID of this size. This is a read-only, auto-generated field

creativeAssets[].collapsedSize.kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#size"

creativeAssets[].collapsedSize.width INTEGER

Width of this size. Acceptable values are 0 to 32767, inclusive

creativeAssets[].companionCreativeIds[] INTEGER

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

creativeAssets[].detectedFeatures[] ENUMERATION

creativeAssets[].displayType ENUMERATION

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

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

creativeAssets[].durationType ENUMERATION

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

creativeAssets[].expandedDimension OBJECT

Represents the dimensions of ads, placements, creatives, or creative assets

creativeAssets[].expandedDimension.height INTEGER

Height of this size. Acceptable values are 0 to 32767, inclusive

creativeAssets[].expandedDimension.iab BOOLEAN

IAB standard size. This is a read-only, auto-generated field

creativeAssets[].expandedDimension.id INTEGER

ID of this size. This is a read-only, auto-generated field

creativeAssets[].expandedDimension.kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#size"

creativeAssets[].expandedDimension.width INTEGER

Width of this size. Acceptable values are 0 to 32767, inclusive

creativeAssets[].fileSize INTEGER

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

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

creativeAssets[].frameRate FLOAT

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

creativeAssets[].hideFlashObjects BOOLEAN

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

creativeAssets[].hideSelectionBoxes BOOLEAN

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

creativeAssets[].horizontallyLocked BOOLEAN

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

creativeAssets[].id INTEGER

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

creativeAssets[].idDimensionValue OBJECT

Represents a DimensionValue resource

creativeAssets[].idDimensionValue.dimensionName STRING

The name of the dimension

creativeAssets[].idDimensionValue.etag STRING

The eTag of this response for caching purposes

creativeAssets[].idDimensionValue.id STRING

The ID associated with the value if available

creativeAssets[].idDimensionValue.kind STRING

The kind of resource this is, in this case dfareporting#dimensionValue

creativeAssets[].idDimensionValue.matchType ENUMERATION

Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT

creativeAssets[].idDimensionValue.value STRING

The value of the dimension

creativeAssets[].mediaDuration FLOAT

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

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

creativeAssets[].offset OBJECT

Offset Position

creativeAssets[].offset.left INTEGER

Offset distance from left side of an asset or a window

creativeAssets[].offset.top INTEGER

Offset distance from top side of an asset or a window

creativeAssets[].orientation ENUMERATION

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

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

creativeAssets[].politeLoad BOOLEAN

Whether this asset is used as a polite load asset

creativeAssets[].position OBJECT

Offset Position

creativeAssets[].position.left INTEGER

Offset distance from left side of an asset or a window

creativeAssets[].position.top INTEGER

Offset distance from top side of an asset or a window

creativeAssets[].positionLeftUnit ENUMERATION

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

creativeAssets[].positionTopUnit ENUMERATION

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

creativeAssets[].progressiveServingUrl STRING

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

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

creativeAssets[].pushdownDuration FLOAT

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

creativeAssets[].role ENUMERATION

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

creativeAssets[].size OBJECT

Represents the dimensions of ads, placements, creatives, or creative assets

creativeAssets[].size.height INTEGER

Height of this size. Acceptable values are 0 to 32767, inclusive

creativeAssets[].size.iab BOOLEAN

IAB standard size. This is a read-only, auto-generated field

creativeAssets[].size.id INTEGER

ID of this size. This is a read-only, auto-generated field

creativeAssets[].size.kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#size"

creativeAssets[].size.width INTEGER

Width of this size. Acceptable values are 0 to 32767, inclusive

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

creativeAssets[].startTimeType ENUMERATION

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

creativeAssets[].streamingServingUrl STRING

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

creativeAssets[].transparency BOOLEAN

Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets

creativeAssets[].verticallyLocked BOOLEAN

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

creativeAssets[].windowMode ENUMERATION

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

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

creativeAssets[].zipFilename STRING

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

creativeAssets[].zipFilesize STRING

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

creativeFieldAssignments[] OBJECT

Creative Field Assignment

creativeFieldAssignments[].creativeFieldId INTEGER

ID of the creative field

creativeFieldAssignments[].creativeFieldValueId INTEGER

ID of the creative field value

customKeyValues[] STRING

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

exitCustomEvents[] OBJECT

Creative Custom Event

exitCustomEvents[].advertiserCustomEventId INTEGER

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

exitCustomEvents[].advertiserCustomEventName STRING

User-entered name for the event

exitCustomEvents[].advertiserCustomEventType ENUMERATION

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

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

exitCustomEvents[].artworkType ENUMERATION

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

exitCustomEvents[].exitClickThroughUrl OBJECT

Click-through URL

exitCustomEvents[].exitClickThroughUrl.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.

exitCustomEvents[].exitClickThroughUrl.customClickThroughUrl STRING

Custom click-through URL. Applicable if the landingPageId field is left unset

exitCustomEvents[].exitClickThroughUrl.landingPageId INTEGER

ID of the landing page for the click-through URL

exitCustomEvents[].id INTEGER

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

exitCustomEvents[].popupWindowProperties OBJECT

Popup Window Properties

exitCustomEvents[].popupWindowProperties.dimension OBJECT

Represents the dimensions of ads, placements, creatives, or creative assets

exitCustomEvents[].popupWindowProperties.dimension.height INTEGER

Height of this size. Acceptable values are 0 to 32767, inclusive

exitCustomEvents[].popupWindowProperties.dimension.iab BOOLEAN

IAB standard size. This is a read-only, auto-generated field

exitCustomEvents[].popupWindowProperties.dimension.id INTEGER

ID of this size. This is a read-only, auto-generated field

exitCustomEvents[].popupWindowProperties.dimension.kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#size"

exitCustomEvents[].popupWindowProperties.dimension.width INTEGER

Width of this size. Acceptable values are 0 to 32767, inclusive

exitCustomEvents[].popupWindowProperties.offset OBJECT

Offset Position

exitCustomEvents[].popupWindowProperties.offset.left INTEGER

Offset distance from left side of an asset or a window

exitCustomEvents[].popupWindowProperties.offset.top INTEGER

Offset distance from top side of an asset or a window

exitCustomEvents[].popupWindowProperties.positionType ENUMERATION

Popup window position either centered or at specific coordinate

exitCustomEvents[].popupWindowProperties.showAddressBar BOOLEAN

Whether to display the browser address bar

exitCustomEvents[].popupWindowProperties.showMenuBar BOOLEAN

Whether to display the browser menu bar

exitCustomEvents[].popupWindowProperties.showScrollBar BOOLEAN

Whether to display the browser scroll bar

exitCustomEvents[].popupWindowProperties.showStatusBar BOOLEAN

Whether to display the browser status bar

exitCustomEvents[].popupWindowProperties.showToolBar BOOLEAN

Whether to display the browser tool bar

exitCustomEvents[].popupWindowProperties.title STRING

Title of popup window

exitCustomEvents[].targetType ENUMERATION

Target type used by the event

exitCustomEvents[].videoReportingId STRING

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

fsCommand OBJECT

FsCommand

fsCommand.left INTEGER

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

fsCommand.positionOption ENUMERATION

Position in the browser where the window will open

fsCommand.top INTEGER

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

fsCommand.windowHeight INTEGER

Height of the window

fsCommand.windowWidth INTEGER

Width of the window

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

id INTEGER

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

idDimensionValue OBJECT

Represents a DimensionValue resource

idDimensionValue.dimensionName STRING

The name of the dimension

idDimensionValue.etag STRING

The eTag of this response for caching purposes

idDimensionValue.id STRING

The ID associated with the value if available

idDimensionValue.kind STRING

The kind of resource this is, in this case dfareporting#dimensionValue

idDimensionValue.matchType ENUMERATION

Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT

idDimensionValue.value STRING

The value of the dimension

kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative"

lastModifiedInfo OBJECT

Modification timestamp

lastModifiedInfo.time INTEGER

Timestamp of the last change in milliseconds since epoch

latestTraffickedCreativeId INTEGER

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

mediaDescription STRING

Description of the audio or video ad. Applicable to the following creative types: all INSTREAM_VIDEO, INSTREAM_AUDIO, and all VPAID

mediaDuration FLOAT

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

name STRING

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

overrideCss STRING

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

progressOffset OBJECT

Video Offset

progressOffset.offsetPercentage INTEGER

Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive

progressOffset.offsetSeconds INTEGER

Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive

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

renderingId INTEGER

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

renderingIdDimensionValue OBJECT

Represents a DimensionValue resource

renderingIdDimensionValue.dimensionName STRING

The name of the dimension

renderingIdDimensionValue.etag STRING

The eTag of this response for caching purposes

renderingIdDimensionValue.id STRING

The ID associated with the value if available

renderingIdDimensionValue.kind STRING

The kind of resource this is, in this case dfareporting#dimensionValue

renderingIdDimensionValue.matchType ENUMERATION

Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT

renderingIdDimensionValue.value STRING

The value of the dimension

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

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

size OBJECT

Represents the dimensions of ads, placements, creatives, or creative assets

size.height INTEGER

Height of this size. Acceptable values are 0 to 32767, inclusive

size.iab BOOLEAN

IAB standard size. This is a read-only, auto-generated field

size.id INTEGER

ID of this size. This is a read-only, auto-generated field

size.kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#size"

size.width INTEGER

Width of this size. Acceptable values are 0 to 32767, inclusive

skipOffset OBJECT

Video Offset

skipOffset.offsetPercentage INTEGER

Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive

skipOffset.offsetSeconds INTEGER

Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive

skippable BOOLEAN

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

sslCompliant BOOLEAN

Whether the creative is SSL-compliant. 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

studioAdvertiserId INTEGER

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

studioCreativeId INTEGER

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 INTEGER

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

subaccountId INTEGER

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

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

thirdPartyUrls[] OBJECT

Third-party Tracking URL

thirdPartyUrls[].thirdPartyUrlType ENUMERATION

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

thirdPartyUrls[].url STRING

URL for the specified third-party URL type

timerCustomEvents[] OBJECT

Creative Custom Event

timerCustomEvents[].advertiserCustomEventId INTEGER

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

timerCustomEvents[].advertiserCustomEventName STRING

User-entered name for the event

timerCustomEvents[].advertiserCustomEventType ENUMERATION

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

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

timerCustomEvents[].artworkType ENUMERATION

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

timerCustomEvents[].exitClickThroughUrl OBJECT

Click-through URL

timerCustomEvents[].exitClickThroughUrl.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.

timerCustomEvents[].exitClickThroughUrl.customClickThroughUrl STRING

Custom click-through URL. Applicable if the landingPageId field is left unset

timerCustomEvents[].exitClickThroughUrl.landingPageId INTEGER

ID of the landing page for the click-through URL

timerCustomEvents[].id INTEGER

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

timerCustomEvents[].popupWindowProperties OBJECT

Popup Window Properties

timerCustomEvents[].popupWindowProperties.dimension OBJECT

Represents the dimensions of ads, placements, creatives, or creative assets

timerCustomEvents[].popupWindowProperties.dimension.height INTEGER

Height of this size. Acceptable values are 0 to 32767, inclusive

timerCustomEvents[].popupWindowProperties.dimension.iab BOOLEAN

IAB standard size. This is a read-only, auto-generated field

timerCustomEvents[].popupWindowProperties.dimension.id INTEGER

ID of this size. This is a read-only, auto-generated field

timerCustomEvents[].popupWindowProperties.dimension.kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#size"

timerCustomEvents[].popupWindowProperties.dimension.width INTEGER

Width of this size. Acceptable values are 0 to 32767, inclusive

timerCustomEvents[].popupWindowProperties.offset OBJECT

Offset Position

timerCustomEvents[].popupWindowProperties.offset.left INTEGER

Offset distance from left side of an asset or a window

timerCustomEvents[].popupWindowProperties.offset.top INTEGER

Offset distance from top side of an asset or a window

timerCustomEvents[].popupWindowProperties.positionType ENUMERATION

Popup window position either centered or at specific coordinate

timerCustomEvents[].popupWindowProperties.showAddressBar BOOLEAN

Whether to display the browser address bar

timerCustomEvents[].popupWindowProperties.showMenuBar BOOLEAN

Whether to display the browser menu bar

timerCustomEvents[].popupWindowProperties.showScrollBar BOOLEAN

Whether to display the browser scroll bar

timerCustomEvents[].popupWindowProperties.showStatusBar BOOLEAN

Whether to display the browser status bar

timerCustomEvents[].popupWindowProperties.showToolBar BOOLEAN

Whether to display the browser tool bar

timerCustomEvents[].popupWindowProperties.title STRING

Title of popup window

timerCustomEvents[].targetType ENUMERATION

Target type used by the event

timerCustomEvents[].videoReportingId STRING

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

totalFileSize INTEGER

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

type ENUMERATION

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

universalAdId OBJECT

A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID

universalAdId.registry ENUMERATION

Registry used for the Ad ID value

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

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