CreativeAssets

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

Resource representations

CreativeAssets contains properties of a creative asset file which will be uploaded or has already been uploaded. Refer to the creative sample code for how to upload assets and insert a creative.

{
  "kind": "dfareporting#creativeAssetMetadata",
  "assetIdentifier": {
    "type": string,
    "name": string
  },
  "detectedFeatures": [
    string
  ],
  "warnedValidationRules": [
    string
  ],
  "clickTags": [
    {
      "name": string,
      "eventName": string,
      "clickThroughUrl": {
        "landingPageId": long,
        "customClickThroughUrl": string,
        "computedClickThroughUrl": string
      }
    }
  ],
  "id": long,
  "idDimensionValue": dimensionValues Resource,
  "richMedia": boolean,
  "counterCustomEvents": [
    {
      "artworkLabel": string,
      "id": long,
      "videoReportingId": string,
      "artworkType": string,
      "advertiserCustomEventName": string,
      "targetType": string,
      "advertiserCustomEventType": 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,
      "exitClickThroughUrl": {
        "landingPageId": long,
        "customClickThroughUrl": string,
        "computedClickThroughUrl": string
      }
    }
  ],
  "exitCustomEvents": [
    {
      "artworkLabel": string,
      "id": long,
      "videoReportingId": string,
      "artworkType": string,
      "advertiserCustomEventName": string,
      "targetType": string,
      "advertiserCustomEventType": 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,
      "exitClickThroughUrl": {
        "landingPageId": long,
        "customClickThroughUrl": string,
        "computedClickThroughUrl": string
      }
    }
  ],
  "timerCustomEvents": [
    {
      "artworkLabel": string,
      "id": long,
      "videoReportingId": string,
      "artworkType": string,
      "advertiserCustomEventName": string,
      "targetType": string,
      "advertiserCustomEventType": 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,
      "exitClickThroughUrl": {
        "landingPageId": long,
        "customClickThroughUrl": string,
        "computedClickThroughUrl": string
      }
    }
  ]
}

Property name	Value	Description
`assetIdentifier`	`nested object`	ID of the creative asset. This is a required field.
`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.
`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: "`AUDIO`" "`FLASH`" "`HTML`" "`HTML_IMAGE`" "`IMAGE`" "`VIDEO`"
`clickTags[]`	`list`	List of detected click tags for assets. This is a read-only, auto-generated field. This field is empty for a rich media asset.
`clickTags[].clickThroughUrl`	`nested object`	Parameter value for the specified click tag. This field contains a 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`	`long`	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.
`counterCustomEvents[]`	`list`	List of counter events configured for the asset. This is a read-only, auto-generated field and only applicable to a rich media asset.
`counterCustomEvents[].advertiserCustomEventId`	`long`	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`	`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 Campaign Manager 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[].exitClickThroughUrl`	`nested object`	Exit click-through URL for the event. This field is used only for exit events.
`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`	`long`	ID of the landing page for the click-through URL.
`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.
`detectedFeatures[]`	`list`	List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field.
`exitCustomEvents[]`	`list`	List of exit events configured for the asset. This is a read-only, auto-generated field and only applicable to a rich media asset.
`exitCustomEvents[].advertiserCustomEventId`	`long`	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`	`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 Campaign Manager 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[].exitClickThroughUrl`	`nested object`	Exit click-through URL for the event. This field is used only for exit events.
`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`	`long`	ID of the landing page for the click-through URL.
`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.
`id`	`long`	Numeric ID of the asset. This is a read-only, auto-generated field.
`idDimensionValue`	`nested object`	Dimension value for the numeric ID of the asset. This is a read-only, auto-generated field.
`kind`	`string`	Identifies what kind of resource this is. Value: the fixed string `"dfareporting#creativeAssetMetadata"`.
`richMedia`	`boolean`	True if the uploaded asset is a rich media asset. This is a read-only, auto-generated field.
`timerCustomEvents[]`	`list`	List of timer events configured for the asset. This is a read-only, auto-generated field and only applicable to a rich media asset.
`timerCustomEvents[].advertiserCustomEventId`	`long`	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`	`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 Campaign Manager 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[].exitClickThroughUrl`	`nested object`	Exit click-through URL for the event. This field is used only for exit events.
`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`	`long`	ID of the landing page for the click-through URL.
`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.
`warnedValidationRules[]`	`list`	Rules validated during code generation that generated a warning. This is a read-only, auto-generated field. Possible values are: "`ADMOB_REFERENCED`" "`ASSET_FORMAT_UNSUPPORTED_DCM`" "`ASSET_INVALID`" "`CLICK_TAG_HARD_CODED`" "`CLICK_TAG_INVALID`" "`CLICK_TAG_IN_GWD`" "`CLICK_TAG_MISSING`" "`CLICK_TAG_MORE_THAN_ONE`" "`CLICK_TAG_NON_TOP_LEVEL`" "`COMPONENT_UNSUPPORTED_DCM`" "`ENABLER_UNSUPPORTED_METHOD_DCM`" "`EXTERNAL_FILE_REFERENCED`" "`FILE_DETAIL_EMPTY`" "`FILE_TYPE_INVALID`" "`GWD_PROPERTIES_INVALID`" "`HTML5_FEATURE_UNSUPPORTED`" "`LINKED_FILE_NOT_FOUND`" "`MAX_FLASH_VERSION_11`" "`MRAID_REFERENCED`" "`NOT_SSL_COMPLIANT`" "`ORPHANED_ASSET`" "`PRIMARY_HTML_MISSING`" "`SVG_INVALID`" "`ZIP_INVALID`"

Methods

insert: Inserts a new creative asset.