The DCM/DFA Reporting and Trafficking API v2.7 is deprecated and will be sunset on November 30th, 2017. All users must migrate to a newer API version by that date.

Creatives

For a list of methods for this resource, see the end of this page.

Resource representations

Contains properties of a Creative.

{
  "kind": "dfareporting#creative",
  "id": long,
  "idDimensionValue": dimensionValues Resource,
  "renderingIdDimensionValue": dimensionValues Resource,
  "name": string,
  "renderingId": long,
  "advertiserId": long,
  "accountId": long,
  "subaccountId": long,
  "active": boolean,
  "archived": boolean,
  "version": integer,
  "size": sizes Resource,
  "creativeFieldAssignments": [
    {
      "creativeFieldId": long,
      "creativeFieldValueId": long
    }
  ],
  "lastModifiedInfo": {
    "time": long
  },
  "sslCompliant": boolean,
  "compatibility": [
    string
  ],
  "type": string,
  "creativeAssets": [
    {
      "id": long,
      "assetIdentifier": {
        "type": string,
        "name": string
      },
      "sslCompliant": boolean,
      "size": sizes Resource,
      "fileSize": long,
      "flashVersion": integer,
      "actionScript3": boolean,
      "zipFilename": string,
      "zipFilesize": string,
      "detectedFeatures": [
        string
      ],
      "displayType": string,
      "artworkType": string,
      "collapsedSize": sizes Resource,
      "offset": {
        "top": integer,
        "left": integer
      },
      "zIndex": integer,
      "windowMode": string,
      "transparency": boolean,
      "pushdown": boolean,
      "pushdownDuration": float,
      "position": {
        "top": integer,
        "left": integer
      },
      "positionTopUnit": string,
      "positionLeftUnit": string,
      "verticallyLocked": boolean,
      "horizontallyLocked": boolean,
      "startTimeType": string,
      "customStartTimeValue": integer,
      "durationType": string,
      "duration": integer,
      "hideFlashObjects": boolean,
      "hideSelectionBoxes": boolean,
      "alignment": string,
      "childAssetType": string,
      "originalBackup": boolean,
      "bitRate": integer,
      "mimeType": string,
      "active": boolean,
      "progressiveServingUrl": string,
      "streamingServingUrl": string,
      "videoDuration": float,
      "expandedDimension": sizes Resource,
      "role": string,
      "backupImageExit": {
        "artworkLabel": string,
        "id": long,
        "videoReportingId": string,
        "artworkType": string,
        "advertiserCustomEventName": string,
        "targetType": string,
        "advertiserCustomEventType": string,
        "exitUrl": string,
        "popupWindowProperties": {
          "offset": {
            "top": integer,
            "left": integer
          },
          "showScrollBar": boolean,
          "showToolBar": boolean,
          "showMenuBar": boolean,
          "showAddressBar": boolean,
          "showStatusBar": boolean,
          "positionType": string,
          "dimension": sizes Resource,
          "title": string
        },
        "advertiserCustomEventId": long
      },
      "companionCreativeIds": [
        long
      ],
      "idDimensionValue": dimensionValues Resource
    }
  ],
  "redirectUrl": string,
  "htmlCode": string,
  "htmlCodeLocked": boolean,
  "backgroundColor": string,
  "allowScriptAccess": boolean,
  "fsCommand": {
    "positionOption": string,
    "top": integer,
    "left": integer,
    "windowWidth": integer,
    "windowHeight": integer
  },
  "backupImageClickThroughUrl": string,
  "backupImageTargetWindow": {
    "targetWindowOption": string,
    "customHtml": string
  },
  "clickTags": [
    {
      "name": string,
      "value": string,
      "eventName": string
    }
  ],
  "backupImageFeatures": [
    string
  ],
  "authoringTool": string,
  "requiredFlashPluginVersion": string,
  "adTagKeys": [
    string
  ],
  "customKeyValues": [
    string
  ],
  "counterCustomEvents": [
    {
      "artworkLabel": string,
      "id": long,
      "videoReportingId": string,
      "artworkType": string,
      "advertiserCustomEventName": string,
      "targetType": string,
      "advertiserCustomEventType": string,
      "exitUrl": string,
      "popupWindowProperties": {
        "offset": {
          "top": integer,
          "left": integer
        },
        "showScrollBar": boolean,
        "showToolBar": boolean,
        "showMenuBar": boolean,
        "showAddressBar": boolean,
        "showStatusBar": boolean,
        "positionType": string,
        "dimension": sizes Resource,
        "title": string
      },
      "advertiserCustomEventId": long
    }
  ],
  "exitCustomEvents": [
    {
      "artworkLabel": string,
      "id": long,
      "videoReportingId": string,
      "artworkType": string,
      "advertiserCustomEventName": string,
      "targetType": string,
      "advertiserCustomEventType": string,
      "exitUrl": string,
      "popupWindowProperties": {
        "offset": {
          "top": integer,
          "left": integer
        },
        "showScrollBar": boolean,
        "showToolBar": boolean,
        "showMenuBar": boolean,
        "showAddressBar": boolean,
        "showStatusBar": boolean,
        "positionType": string,
        "dimension": sizes Resource,
        "title": string
      },
      "advertiserCustomEventId": long
    }
  ],
  "timerCustomEvents": [
    {
      "artworkLabel": string,
      "id": long,
      "videoReportingId": string,
      "artworkType": string,
      "advertiserCustomEventName": string,
      "targetType": string,
      "advertiserCustomEventType": string,
      "exitUrl": string,
      "popupWindowProperties": {
        "offset": {
          "top": integer,
          "left": integer
        },
        "showScrollBar": boolean,
        "showToolBar": boolean,
        "showMenuBar": boolean,
        "showAddressBar": boolean,
        "showStatusBar": boolean,
        "positionType": string,
        "dimension": sizes Resource,
        "title": string
      },
      "advertiserCustomEventId": long
    }
  ],
  "artworkType": string,
  "requiredFlashVersion": integer,
  "thirdPartyBackupImageImpressionsUrl": string,
  "thirdPartyRichMediaImpressionsUrl": string,
  "totalFileSize": long,
  "videoDuration": float,
  "commercialId": string,
  "companionCreatives": [
    long
  ],
  "videoDescription": string,
  "skippable": boolean,
  "thirdPartyUrls": [
    {
      "thirdPartyUrlType": string,
      "url": string
    }
  ],
  "adParameters": string,
  "overrideCss": string,
  "studioCreativeId": long,
  "studioTraffickedCreativeId": long,
  "latestTraffickedCreativeId": long,
  "studioAdvertiserId": long,
  "autoAdvanceImages": boolean,
  "backupImageReportingLabel": string,
  "convertFlashToHtml5": boolean,
  "sslOverride": boolean,
  "skipOffset": {
    "offsetSeconds": integer,
    "offsetPercentage": integer
  },
  "progressOffset": {
    "offsetSeconds": integer,
    "offsetPercentage": integer
  },
  "authoringSource": string,
  "dynamicAssetSelection": boolean,
  "creativeAssetSelection": {
    "rules": [
      {
        "name": string,
        "assetId": long,
        "targetingTemplateId": long
      }
    ],
    "defaultAssetId": long
  },
  "universalAdId": {
    "registry": string,
    "value": string
  }
}
Property name Value Description Notes
accountId long 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[] list 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.
advertiserId long 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 string 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.

Acceptable values are:
  • "ARTWORK_TYPE_FLASH"
  • "ARTWORK_TYPE_HTML5"
  • "ARTWORK_TYPE_IMAGE"
  • "ARTWORK_TYPE_MIXED"
authoringSource string Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.

Acceptable values are:
  • "CREATIVE_AUTHORING_SOURCE_DBM"
  • "CREATIVE_AUTHORING_SOURCE_DCM"
  • "CREATIVE_AUTHORING_SOURCE_STUDIO"
authoringTool string Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.

Acceptable values are:
  • "NINJA"
  • "SWIFFY"
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 string Click-through URL 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.
backupImageFeatures[] list 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 DCM 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.
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 nested object 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.
backupImageTargetWindow.customHtml string User-entered value.
backupImageTargetWindow.targetWindowOption string Type of browser window for which the backup image of the flash creative can be displayed.

Acceptable values are:
  • "CURRENT_WINDOW"
  • "CUSTOM"
  • "NEW_WINDOW"
clickTags[] list 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.
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.
clickTags[].value string Parameter value for the specified click tag. This field contains a click-through url.
commercialId string Industry standard ID assigned to creative for reach and frequency. Applicable to INSTREAM_VIDEO_REDIRECT creatives.
companionCreatives[] list List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all VPAID and all INSTREAM_VIDEO with dynamicAssetSelection set to false.
compatibility[] list 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. Applicable to all creative types.

Acceptable values are:
  • "APP"
  • "APP_INTERSTITIAL"
  • "IN_STREAM_VIDEO"
  • "DISPLAY"
  • "DISPLAY_INTERSTITIAL"
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[] list 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.
counterCustomEvents[].advertiserCustomEventId long Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
counterCustomEvents[].advertiserCustomEventName string User-entered name for the event.
counterCustomEvents[].advertiserCustomEventType string Type of the event. This is a read-only field.

Acceptable values are:
  • "ADVERTISER_EVENT_COUNTER"
  • "ADVERTISER_EVENT_EXIT"
  • "ADVERTISER_EVENT_TIMER"
counterCustomEvents[].artworkLabel string Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
counterCustomEvents[].artworkType string Artwork type used by the creative.This is a read-only field.

Acceptable values are:
  • "ARTWORK_TYPE_FLASH"
  • "ARTWORK_TYPE_HTML5"
  • "ARTWORK_TYPE_IMAGE"
  • "ARTWORK_TYPE_MIXED"
counterCustomEvents[].exitUrl string Exit URL of the event. This field is used only for exit events.
counterCustomEvents[].id long ID of this event. This is a required field and should not be modified after insertion.
counterCustomEvents[].popupWindowProperties nested object Properties for rich media popup windows. This field is used only for exit events.
counterCustomEvents[].popupWindowProperties.dimension nested object Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
counterCustomEvents[].popupWindowProperties.offset nested object Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
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 string Popup window position either centered or at specific coordinate.

Acceptable values are:
  • "CENTER"
  • "COORDINATES"
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 string Target type used by the event.

Acceptable values are:
  • "TARGET_BLANK"
  • "TARGET_PARENT"
  • "TARGET_POPUP"
  • "TARGET_SELF"
  • "TARGET_TOP"
counterCustomEvents[].videoReportingId string Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
creativeAssetSelection nested object Required if dynamicAssetSelection is true.
creativeAssetSelection.defaultAssetId long 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[] list 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.
creativeAssetSelection.rules[].assetId long 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 long 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[] list Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
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 asset is active. This is a read-only field for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
creativeAssets[].alignment string Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL.

Acceptable values are:
  • "ALIGNMENT_BOTTOM"
  • "ALIGNMENT_LEFT"
  • "ALIGNMENT_RIGHT"
  • "ALIGNMENT_TOP"
creativeAssets[].artworkType string Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.

Acceptable values are:
  • "ARTWORK_TYPE_FLASH"
  • "ARTWORK_TYPE_HTML5"
  • "ARTWORK_TYPE_IMAGE"
  • "ARTWORK_TYPE_MIXED"
creativeAssets[].assetIdentifier nested object 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.
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 string 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.

Acceptable values are:
  • "FLASH"
  • "HTML"
  • "HTML_IMAGE"
  • "IMAGE"
  • "VIDEO"
creativeAssets[].backupImageExit nested object Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
creativeAssets[].backupImageExit.advertiserCustomEventId long Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
creativeAssets[].backupImageExit.advertiserCustomEventName string User-entered name for the event.
creativeAssets[].backupImageExit.advertiserCustomEventType string Type of the event. This is a read-only field.

Acceptable values are:
  • "ADVERTISER_EVENT_COUNTER"
  • "ADVERTISER_EVENT_EXIT"
  • "ADVERTISER_EVENT_TIMER"
creativeAssets[].backupImageExit.artworkLabel string Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
creativeAssets[].backupImageExit.artworkType string Artwork type used by the creative.This is a read-only field.

Acceptable values are:
  • "ARTWORK_TYPE_FLASH"
  • "ARTWORK_TYPE_HTML5"
  • "ARTWORK_TYPE_IMAGE"
  • "ARTWORK_TYPE_MIXED"
creativeAssets[].backupImageExit.exitUrl string Exit URL of the event. This field is used only for exit events.
creativeAssets[].backupImageExit.id long ID of this event. This is a required field and should not be modified after insertion.
creativeAssets[].backupImageExit.popupWindowProperties nested object Properties for rich media popup windows. This field is used only for exit events.
creativeAssets[].backupImageExit.popupWindowProperties.dimension nested object Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
creativeAssets[].backupImageExit.popupWindowProperties.offset nested object Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
creativeAssets[].backupImageExit.popupWindowProperties.offset.left integer Offset distance from left side of an asset or a window.
creativeAssets[].backupImageExit.popupWindowProperties.offset.top integer Offset distance from top side of an asset or a window.
creativeAssets[].backupImageExit.popupWindowProperties.positionType string Popup window position either centered or at specific coordinate.

Acceptable values are:
  • "CENTER"
  • "COORDINATES"
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 string Target type used by the event.

Acceptable values are:
  • "TARGET_BLANK"
  • "TARGET_PARENT"
  • "TARGET_POPUP"
  • "TARGET_SELF"
  • "TARGET_TOP"
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 video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
creativeAssets[].childAssetType string Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.

Acceptable values are:
  • "CHILD_ASSET_TYPE_DATA"
  • "CHILD_ASSET_TYPE_FLASH"
  • "CHILD_ASSET_TYPE_IMAGE"
  • "CHILD_ASSET_TYPE_VIDEO"
creativeAssets[].collapsedSize nested object 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.
creativeAssets[].companionCreativeIds[] list 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.
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[] list List of feature dependencies for the creative asset that are detected by DCM. 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.
creativeAssets[].displayType string Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.

Acceptable values are:
  • "ASSET_DISPLAY_TYPE_BACKDROP"
  • "ASSET_DISPLAY_TYPE_EXPANDING"
  • "ASSET_DISPLAY_TYPE_FLASH_IN_FLASH"
  • "ASSET_DISPLAY_TYPE_FLASH_IN_FLASH_EXPANDING"
  • "ASSET_DISPLAY_TYPE_FLOATING"
  • "ASSET_DISPLAY_TYPE_INPAGE"
  • "ASSET_DISPLAY_TYPE_OVERLAY"
  • "ASSET_DISPLAY_TYPE_PEEL_DOWN"
  • "ASSET_DISPLAY_TYPE_VPAID_LINEAR"
  • "ASSET_DISPLAY_TYPE_VPAID_NON_LINEAR"
creativeAssets[].duration integer Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR_VIDEO. Value must be greater than or equal to 1.
creativeAssets[].durationType string Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.

Acceptable values are:
  • "ASSET_DURATION_TYPE_AUTO"
  • "ASSET_DURATION_TYPE_CUSTOM"
  • "ASSET_DURATION_TYPE_NONE"
creativeAssets[].expandedDimension nested object Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
creativeAssets[].fileSize long 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[].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 long 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 nested object Dimension value for the ID of the asset. This is a read-only, auto-generated field.
creativeAssets[].mimeType string Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
creativeAssets[].offset nested object 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.
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[].originalBackup boolean Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
creativeAssets[].position nested object Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
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 string Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.

Acceptable values are:
  • "OFFSET_UNIT_PERCENT"
  • "OFFSET_UNIT_PIXEL"
  • "OFFSET_UNIT_PIXEL_FROM_CENTER"
creativeAssets[].positionTopUnit string 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.

Acceptable values are:
  • "OFFSET_UNIT_PERCENT"
  • "OFFSET_UNIT_PIXEL"
  • "OFFSET_UNIT_PIXEL_FROM_CENTER"
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 string 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 DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.

PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives.

TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives.

ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.

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.



Acceptable values are:
  • "ADDITIONAL_FLASH"
  • "ADDITIONAL_IMAGE"
  • "ALTERNATE_VIDEO"
  • "BACKUP_IMAGE"
  • "OTHER"
  • "PARENT_VIDEO"
  • "PRIMARY"
  • "TRANSCODED_VIDEO"
creativeAssets[].size nested object 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.
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 string Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.

Acceptable values are:
  • "ASSET_START_TIME_TYPE_CUSTOM"
  • "ASSET_START_TIME_TYPE_NONE"
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[].videoDuration float Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
creativeAssets[].windowMode string 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.

Acceptable values are:
  • "OPAQUE"
  • "TRANSPARENT"
  • "WINDOW"
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[] list Creative field assignments for this creative. Applicable to all creative types.
creativeFieldAssignments[].creativeFieldId long ID of the creative field.
creativeFieldAssignments[].creativeFieldValueId long ID of the creative field value.
customKeyValues[] list 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.
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[] list 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.
exitCustomEvents[].advertiserCustomEventId long Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
exitCustomEvents[].advertiserCustomEventName string User-entered name for the event.
exitCustomEvents[].advertiserCustomEventType string Type of the event. This is a read-only field.

Acceptable values are:
  • "ADVERTISER_EVENT_COUNTER"
  • "ADVERTISER_EVENT_EXIT"
  • "ADVERTISER_EVENT_TIMER"
exitCustomEvents[].artworkLabel string Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
exitCustomEvents[].artworkType string Artwork type used by the creative.This is a read-only field.

Acceptable values are:
  • "ARTWORK_TYPE_FLASH"
  • "ARTWORK_TYPE_HTML5"
  • "ARTWORK_TYPE_IMAGE"
  • "ARTWORK_TYPE_MIXED"
exitCustomEvents[].exitUrl string Exit URL of the event. This field is used only for exit events.
exitCustomEvents[].id long ID of this event. This is a required field and should not be modified after insertion.
exitCustomEvents[].popupWindowProperties nested object Properties for rich media popup windows. This field is used only for exit events.
exitCustomEvents[].popupWindowProperties.dimension nested object Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
exitCustomEvents[].popupWindowProperties.offset nested object Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
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 string Popup window position either centered or at specific coordinate.

Acceptable values are:
  • "CENTER"
  • "COORDINATES"
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 string Target type used by the event.

Acceptable values are:
  • "TARGET_BLANK"
  • "TARGET_PARENT"
  • "TARGET_POPUP"
  • "TARGET_SELF"
  • "TARGET_TOP"
exitCustomEvents[].videoReportingId string Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
fsCommand nested object 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.
fsCommand.left integer Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
fsCommand.positionOption string Position in the browser where the window will open.

Acceptable values are:
  • "CENTERED"
  • "DISTANCE_FROM_TOP_LEFT_CORNER"
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 DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
id long ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
idDimensionValue nested object Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
kind string Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
lastModifiedInfo nested object Creative last modification information. This is a read-only field. Applicable to all creative types.
lastModifiedInfo.time long Timestamp of the last change in milliseconds since epoch.
latestTraffickedCreativeId long 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.
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 nested object Amount of time to play the video before counting a view. Applicable to the following creative types: all INSTREAM_VIDEO.
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 long ID of current rendering version. This is a read-only field. Applicable to all creative types.
renderingIdDimensionValue nested object Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
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 DoubleClick 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 nested object 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.
skipOffset nested object Amount of time to play the video before the skip button appears. Applicable to the following creative types: all INSTREAM_VIDEO.
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 long 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 long 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 long 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 long 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[] list Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
thirdPartyUrls[].thirdPartyUrlType string Third-party URL type for in-stream video creatives.

Acceptable values are:
  • "CLICK_TRACKING"
  • "IMPRESSION"
  • "RICH_MEDIA_BACKUP_IMPRESSION"
  • "RICH_MEDIA_IMPRESSION"
  • "RICH_MEDIA_RM_IMPRESSION"
  • "SURVEY"
  • "VIDEO_COMPLETE"
  • "VIDEO_CUSTOM"
  • "VIDEO_FIRST_QUARTILE"
  • "VIDEO_FULLSCREEN"
  • "VIDEO_MIDPOINT"
  • "VIDEO_MUTE"
  • "VIDEO_PAUSE"
  • "VIDEO_PROGRESS"
  • "VIDEO_REWIND"
  • "VIDEO_SKIP"
  • "VIDEO_START"
  • "VIDEO_STOP"
  • "VIDEO_THIRD_QUARTILE"
thirdPartyUrls[].url string URL for the specified third-party URL type.
timerCustomEvents[] list 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.
timerCustomEvents[].advertiserCustomEventId long Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
timerCustomEvents[].advertiserCustomEventName string User-entered name for the event.
timerCustomEvents[].advertiserCustomEventType string Type of the event. This is a read-only field.

Acceptable values are:
  • "ADVERTISER_EVENT_COUNTER"
  • "ADVERTISER_EVENT_EXIT"
  • "ADVERTISER_EVENT_TIMER"
timerCustomEvents[].artworkLabel string Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
timerCustomEvents[].artworkType string Artwork type used by the creative.This is a read-only field.

Acceptable values are:
  • "ARTWORK_TYPE_FLASH"
  • "ARTWORK_TYPE_HTML5"
  • "ARTWORK_TYPE_IMAGE"
  • "ARTWORK_TYPE_MIXED"
timerCustomEvents[].exitUrl string Exit URL of the event. This field is used only for exit events.
timerCustomEvents[].id long ID of this event. This is a required field and should not be modified after insertion.
timerCustomEvents[].popupWindowProperties nested object Properties for rich media popup windows. This field is used only for exit events.
timerCustomEvents[].popupWindowProperties.dimension nested object Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
timerCustomEvents[].popupWindowProperties.offset nested object Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
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 string Popup window position either centered or at specific coordinate.

Acceptable values are:
  • "CENTER"
  • "COORDINATES"
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 string Target type used by the event.

Acceptable values are:
  • "TARGET_BLANK"
  • "TARGET_PARENT"
  • "TARGET_POPUP"
  • "TARGET_SELF"
  • "TARGET_TOP"
timerCustomEvents[].videoReportingId string Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
totalFileSize long 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 string 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.

Acceptable values are:
  • "BRAND_SAFE_DEFAULT_INSTREAM_VIDEO"
  • "CUSTOM_DISPLAY"
  • "CUSTOM_DISPLAY_INTERSTITIAL"
  • "DISPLAY"
  • "DISPLAY_IMAGE_GALLERY"
  • "DISPLAY_REDIRECT"
  • "FLASH_INPAGE"
  • "HTML5_BANNER"
  • "IMAGE"
  • "INSTREAM_VIDEO"
  • "INSTREAM_VIDEO_REDIRECT"
  • "INTERNAL_REDIRECT"
  • "INTERSTITIAL_INTERNAL_REDIRECT"
  • "RICH_MEDIA_DISPLAY_BANNER"
  • "RICH_MEDIA_DISPLAY_EXPANDING"
  • "RICH_MEDIA_DISPLAY_INTERSTITIAL"
  • "RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL"
  • "RICH_MEDIA_IM_EXPAND"
  • "RICH_MEDIA_INPAGE_FLOATING"
  • "RICH_MEDIA_MOBILE_IN_APP"
  • "RICH_MEDIA_PEEL_DOWN"
  • "TRACKING_TEXT"
  • "VPAID_LINEAR_VIDEO"
  • "VPAID_NON_LINEAR_VIDEO"
universalAdId nested object A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_VIDEO and VPAID.
universalAdId.registry string Registry used for the Ad ID value.

Acceptable values are:
  • "AD_ID.ORG"
  • "CLEARCAST"
  • "DCM"
  • "OTHER"
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.
videoDescription string Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
videoDuration float Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.

Methods

get
Gets one creative by ID.
insert
Inserts a new creative.
list
Retrieves a list of creatives, possibly filtered. This method supports paging.
patch
Updates an existing creative. This method supports patch semantics.
update
Updates an existing creative.

Send feedback about...

DoubleClick Campaign Manager
DoubleClick Campaign Manager