List

Retrieves a list of creatives, possibly filtered

17 variables
194 variables

Retrieves a list of creatives, possibly filtered. This method supports paging

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • View and manage your DoubleClick Campaign Manager's (DCM) display ad campaigns

Input

This building block consumes 17 input parameters

  = Parameter name
  = Format

profileId INTEGER Required

User profile ID associated with this request

active BOOLEAN

Select only active creatives. Leave blank to select active and inactive creatives

advertiserId INTEGER

Select only creatives with this advertiser ID

archived BOOLEAN

Select only archived creatives. Leave blank to select archived and unarchived creatives

campaignId INTEGER

Select only creatives with this campaign ID

companionCreativeIds INTEGER

Select only in-stream video creatives with these companion IDs

creativeFieldIds INTEGER

Select only creatives with these creative field IDs

ids INTEGER

Select only creatives with these IDs

maxResults INTEGER

Maximum number of results to return

pageToken STRING

Value of the nextPageToken from the previous result page

renderingIds INTEGER

Select only creatives with these rendering IDs

searchString STRING

Allows searching for objects by name or ID. Wildcards () are allowed. For example, "creative2015" will return objects with names like "creative June 2015", "creative April 2015", or simply "creative 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "creative" will match objects with name "my creative", "creative 2015", or simply "creative"

sizeIds INTEGER

Select only creatives with these size IDs

sortField ENUMERATION

Field by which to sort the list

sortOrder ENUMERATION

Order of sorted results

studioCreativeId INTEGER

Select only creatives corresponding to this Studio creative ID

types ENUMERATION

Select only creatives with these creative types

Output

This building block provides 194 output parameters

  = Parameter name
  = Format

creatives[] OBJECT

Contains properties of a Creative

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

creatives[].active BOOLEAN

Whether the creative is active. Applicable to all creative types

creatives[].adParameters STRING

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

creatives[].adTagKeys[] STRING

creatives[].additionalSizes[] OBJECT

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

creatives[].additionalSizes[].height INTEGER

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

creatives[].additionalSizes[].iab BOOLEAN

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

creatives[].additionalSizes[].id INTEGER

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

creatives[].additionalSizes[].kind STRING

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

creatives[].additionalSizes[].width INTEGER

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

creatives[].advertiserId INTEGER

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

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

creatives[].archived BOOLEAN

Whether the creative is archived. Applicable to all creative types

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

creatives[].authoringSource ENUMERATION

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

creatives[].authoringTool ENUMERATION

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

creatives[].autoAdvanceImages BOOLEAN

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

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

creatives[].backupImageClickThroughUrl OBJECT

Click-through URL

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

creatives[].backupImageClickThroughUrl.customClickThroughUrl STRING

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

creatives[].backupImageClickThroughUrl.landingPageId INTEGER

ID of the landing page for the click-through URL

creatives[].backupImageFeatures[] ENUMERATION

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

creatives[].backupImageTargetWindow OBJECT

Target Window

creatives[].backupImageTargetWindow.customHtml STRING

User-entered value

creatives[].backupImageTargetWindow.targetWindowOption ENUMERATION

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

creatives[].clickTags[] OBJECT

Creative Click Tag

creatives[].clickTags[].clickThroughUrl OBJECT

Click-through URL

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

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

creatives[].commercialId STRING

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

creatives[].companionCreatives[] INTEGER

creatives[].compatibility[] ENUMERATION

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

creatives[].counterCustomEvents[] OBJECT

Creative Custom Event

creatives[].counterCustomEvents[].advertiserCustomEventId INTEGER

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

creatives[].counterCustomEvents[].advertiserCustomEventName STRING

User-entered name for the event

creatives[].counterCustomEvents[].advertiserCustomEventType ENUMERATION

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

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

creatives[].counterCustomEvents[].artworkType ENUMERATION

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

creatives[].counterCustomEvents[].exitClickThroughUrl OBJECT

Click-through URL

creatives[].counterCustomEvents[].id INTEGER

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

creatives[].counterCustomEvents[].popupWindowProperties OBJECT

Popup Window Properties

creatives[].counterCustomEvents[].targetType ENUMERATION

Target type used by the event

creatives[].counterCustomEvents[].videoReportingId STRING

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

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

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

creatives[].creativeAssetSelection.rules[] OBJECT

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

creatives[].creativeAssets[] OBJECT

Creative Asset

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

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

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

creatives[].creativeAssets[].artworkType ENUMERATION

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

creatives[].creativeAssets[].assetIdentifier OBJECT

Creative Asset ID

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

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

creatives[].creativeAssets[].backupImageExit OBJECT

Creative Custom Event

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

creatives[].creativeAssets[].childAssetType ENUMERATION

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

creatives[].creativeAssets[].collapsedSize OBJECT

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

creatives[].creativeAssets[].companionCreativeIds[] INTEGER

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

creatives[].creativeAssets[].detectedFeatures[] ENUMERATION

creatives[].creativeAssets[].displayType ENUMERATION

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

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

creatives[].creativeAssets[].durationType ENUMERATION

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

creatives[].creativeAssets[].expandedDimension OBJECT

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

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

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

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

creatives[].creativeAssets[].hideFlashObjects BOOLEAN

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

creatives[].creativeAssets[].hideSelectionBoxes BOOLEAN

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

creatives[].creativeAssets[].horizontallyLocked BOOLEAN

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

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

creatives[].creativeAssets[].idDimensionValue OBJECT

Represents a DimensionValue resource

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

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

creatives[].creativeAssets[].offset OBJECT

Offset Position

creatives[].creativeAssets[].orientation ENUMERATION

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

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

creatives[].creativeAssets[].politeLoad BOOLEAN

Whether this asset is used as a polite load asset

creatives[].creativeAssets[].position OBJECT

Offset Position

creatives[].creativeAssets[].positionLeftUnit ENUMERATION

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

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

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

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

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

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

creatives[].creativeAssets[].size OBJECT

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

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

creatives[].creativeAssets[].startTimeType ENUMERATION

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

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

creatives[].creativeAssets[].transparency BOOLEAN

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

creatives[].creativeAssets[].verticallyLocked BOOLEAN

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

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

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

creatives[].creativeAssets[].zipFilename STRING

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

creatives[].creativeAssets[].zipFilesize STRING

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

creatives[].creativeFieldAssignments[] OBJECT

Creative Field Assignment

creatives[].creativeFieldAssignments[].creativeFieldId INTEGER

ID of the creative field

creatives[].creativeFieldAssignments[].creativeFieldValueId INTEGER

ID of the creative field value

creatives[].customKeyValues[] STRING

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

creatives[].exitCustomEvents[] OBJECT

Creative Custom Event

creatives[].exitCustomEvents[].advertiserCustomEventId INTEGER

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

creatives[].exitCustomEvents[].advertiserCustomEventName STRING

User-entered name for the event

creatives[].exitCustomEvents[].advertiserCustomEventType ENUMERATION

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

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

creatives[].exitCustomEvents[].artworkType ENUMERATION

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

creatives[].exitCustomEvents[].exitClickThroughUrl OBJECT

Click-through URL

creatives[].exitCustomEvents[].id INTEGER

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

creatives[].exitCustomEvents[].popupWindowProperties OBJECT

Popup Window Properties

creatives[].exitCustomEvents[].targetType ENUMERATION

Target type used by the event

creatives[].exitCustomEvents[].videoReportingId STRING

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

creatives[].fsCommand OBJECT

FsCommand

creatives[].fsCommand.left INTEGER

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

creatives[].fsCommand.positionOption ENUMERATION

Position in the browser where the window will open

creatives[].fsCommand.top INTEGER

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

creatives[].fsCommand.windowHeight INTEGER

Height of the window

creatives[].fsCommand.windowWidth INTEGER

Width of the window

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

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

creatives[].id INTEGER

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

creatives[].idDimensionValue OBJECT

Represents a DimensionValue resource

creatives[].idDimensionValue.dimensionName STRING

The name of the dimension

creatives[].idDimensionValue.etag STRING

The eTag of this response for caching purposes

creatives[].idDimensionValue.id STRING

The ID associated with the value if available

creatives[].idDimensionValue.kind STRING

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

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

creatives[].idDimensionValue.value STRING

The value of the dimension

creatives[].kind STRING

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

creatives[].lastModifiedInfo OBJECT

Modification timestamp

creatives[].lastModifiedInfo.time INTEGER

Timestamp of the last change in milliseconds since epoch

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

creatives[].mediaDescription STRING

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

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

creatives[].name STRING

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

creatives[].overrideCss STRING

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

creatives[].progressOffset OBJECT

Video Offset

creatives[].progressOffset.offsetPercentage INTEGER

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

creatives[].progressOffset.offsetSeconds INTEGER

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

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

creatives[].renderingId INTEGER

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

creatives[].renderingIdDimensionValue OBJECT

Represents a DimensionValue resource

creatives[].renderingIdDimensionValue.dimensionName STRING

The name of the dimension

creatives[].renderingIdDimensionValue.etag STRING

The eTag of this response for caching purposes

creatives[].renderingIdDimensionValue.id STRING

The ID associated with the value if available

creatives[].renderingIdDimensionValue.kind STRING

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

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

creatives[].renderingIdDimensionValue.value STRING

The value of the dimension

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

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

creatives[].size OBJECT

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

creatives[].size.height INTEGER

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

creatives[].size.iab BOOLEAN

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

creatives[].size.id INTEGER

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

creatives[].size.kind STRING

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

creatives[].size.width INTEGER

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

creatives[].skipOffset OBJECT

Video Offset

creatives[].skipOffset.offsetPercentage INTEGER

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

creatives[].skipOffset.offsetSeconds INTEGER

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

creatives[].skippable BOOLEAN

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

creatives[].sslCompliant BOOLEAN

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

creatives[].sslOverride BOOLEAN

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

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

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

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

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

creatives[].thirdPartyBackupImageImpressionsUrl STRING

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

creatives[].thirdPartyRichMediaImpressionsUrl STRING

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

creatives[].thirdPartyUrls[] OBJECT

Third-party Tracking URL

creatives[].thirdPartyUrls[].thirdPartyUrlType ENUMERATION

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

creatives[].thirdPartyUrls[].url STRING

URL for the specified third-party URL type

creatives[].timerCustomEvents[] OBJECT

Creative Custom Event

creatives[].timerCustomEvents[].advertiserCustomEventId INTEGER

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

creatives[].timerCustomEvents[].advertiserCustomEventName STRING

User-entered name for the event

creatives[].timerCustomEvents[].advertiserCustomEventType ENUMERATION

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

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

creatives[].timerCustomEvents[].artworkType ENUMERATION

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

creatives[].timerCustomEvents[].exitClickThroughUrl OBJECT

Click-through URL

creatives[].timerCustomEvents[].id INTEGER

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

creatives[].timerCustomEvents[].popupWindowProperties OBJECT

Popup Window Properties

creatives[].timerCustomEvents[].targetType ENUMERATION

Target type used by the event

creatives[].timerCustomEvents[].videoReportingId STRING

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

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

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

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

creatives[].universalAdId.registry ENUMERATION

Registry used for the Ad ID value

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

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

kind STRING

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

nextPageToken STRING

Pagination token to be used for the next list operation