CreativeAssets

有关此类资源的方法列表,请参阅本页面的结尾部分。

资源表示形式

CreativeAssets 包含将上传或已上传的某个广告素材资源文件的属性。请参阅广告素材示例代码,了解如何上传素材资源并插入广告素材。

{
  "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
      }
    }
  ]
}
属性名称 说明 备注
assetIdentifier nested object 广告素材资源的 ID。此字段是必填字段。
assetIdentifier.name string 广告素材资源的名称。插入素材资源时,此字段是必填字段。插入后,此 assetIdentifier 用于标识已上传的素材资源。名称中的字符必须是字母数字或“.-_ ”中的一个字符。可以使用空格。
assetIdentifier.type string 要上传的素材资源的类型。此字段是必填字段。对于新的上传,FLASHIMAGE 不再受支持。所有图片素材资源都应使用 HTML_IMAGE

可接受的值为:
  • AUDIO
  • FLASH
  • HTML
  • HTML_IMAGE
  • IMAGE
  • VIDEO
clickTags[] list 为素材资源检测到的点击代码列表。此字段是自动生成的只读字段。对于富媒体素材资源,此字段为空。
clickTags[].clickThroughUrl nested object 指定点击代码的参数值。此字段包含点击后到达网址。
clickTags[].clickThroughUrl.computedClickThroughUrl string 此字段是一个便利的只读字段,用于表示在执行此点击后会使用的实际网址。该网址的计算方式如下:
  • 如果指定了 landingPageId,则系统会将对应着陆页的网址分配给此字段。
  • 如未指定,则系统会将 customClickThroughUrl 分配给此字段。
clickTags[].clickThroughUrl.customClickThroughUrl string 自定义点击后到达网址。如果未设置 landingPageId 字段,则此字段适用。
clickTags[].clickThroughUrl.landingPageId long 点击后到达网址指向的着陆页的 ID。
clickTags[].eventName string 与点击代码相关联的广告客户事件名称。此字段由 DISPLAY_IMAGE_GALLERYHTML5_BANNER 广告素材使用。当主素材资源类型不是 HTML_IMAGE 时,适用于 DISPLAY
clickTags[].name string 指定点击代码的参数名称。对于 DISPLAY_IMAGE_GALLERY 广告素材资源,此字段必须与广告素材资源中 creativeAssetId.name 字段的值相符。
counterCustomEvents[] list 为素材资源配置的计数器事件列表。此字段是自动生成的只读字段,仅适用于富媒体素材资源。
counterCustomEvents[].advertiserCustomEventId long 此事件的唯一 ID,由报表和数据传输使用。此字段是只读字段。
counterCustomEvents[].advertiserCustomEventName string 此事件的用户输入的名称。
counterCustomEvents[].advertiserCustomEventType string 事件的类型。此字段是只读字段。

可接受的值为:
  • ADVERTISER_EVENT_COUNTER
  • ADVERTISER_EVENT_EXIT
  • ADVERTISER_EVENT_TIMER
counterCustomEvents[].artworkLabel string 图片标签列,用于将 Campaign Manager 中的事件关联回 Studio 中的事件。此字段是必填字段,插入后不应进行修改。
counterCustomEvents[].artworkType string 广告素材使用的图片类型。此字段是只读字段。

可接受的值为:
  • ARTWORK_TYPE_FLASH
  • ARTWORK_TYPE_HTML5
  • ARTWORK_TYPE_IMAGE
  • ARTWORK_TYPE_MIXED
counterCustomEvents[].exitClickThroughUrl nested object 事件的退出点击后到达网址。此字段仅用于退出事件。
counterCustomEvents[].exitClickThroughUrl.computedClickThroughUrl string 此字段是一个便利的只读字段,用于表示在执行此点击后会使用的实际网址。该网址的计算方式如下:
  • 如果指定了 landingPageId,则系统会将对应着陆页的网址分配给此字段。
  • 如未指定,则系统会将 customClickThroughUrl 分配给此字段。
counterCustomEvents[].exitClickThroughUrl.customClickThroughUrl string 自定义点击后到达网址。如果未设置 landingPageId 字段,则此字段适用。
counterCustomEvents[].exitClickThroughUrl.landingPageId long 点击后到达网址指向的着陆页的 ID。
counterCustomEvents[].id long 此事件的 ID。此字段是必填字段,插入后不应进行修改。
counterCustomEvents[].popupWindowProperties nested object 富媒体弹出式窗口的属性。此字段仅用于退出事件。
counterCustomEvents[].popupWindowProperties.dimension nested object 广告素材的弹出式窗口的尺寸。此字段是只读字段。适用于以下广告素材类型:所有 RICH_MEDIA 和所有 VPAID
counterCustomEvents[].popupWindowProperties.offset nested object 弹出式窗口的左上角坐标。如果 positionType 设为 COORDINATES,则此字段适用。
counterCustomEvents[].popupWindowProperties.offset.left integer 与素材资源或窗口左侧的距离差。
counterCustomEvents[].popupWindowProperties.offset.top integer 与素材资源或窗口顶部的距离差。
counterCustomEvents[].popupWindowProperties.positionType string 弹出式窗口的位置(居中或位于特定坐标点)。

可接受的值为:
  • CENTER
  • COORDINATES
counterCustomEvents[].popupWindowProperties.showAddressBar boolean 是否显示浏览器地址栏。
counterCustomEvents[].popupWindowProperties.showMenuBar boolean 是否显示浏览器菜单栏。
counterCustomEvents[].popupWindowProperties.showScrollBar boolean 是否显示浏览器滚动条。
counterCustomEvents[].popupWindowProperties.showStatusBar boolean 是否显示浏览器状态栏。
counterCustomEvents[].popupWindowProperties.showToolBar boolean 是否显示浏览器工具栏。
counterCustomEvents[].popupWindowProperties.title string 弹出式窗口的标题。
counterCustomEvents[].targetType string 事件使用的目标类型。

可接受的值为:
  • TARGET_BLANK
  • TARGET_PARENT
  • TARGET_POPUP
  • TARGET_SELF
  • TARGET_TOP
counterCustomEvents[].videoReportingId string 视频报表 ID,用于区分单个广告素材中的多个视频。此字段是只读字段。
detectedFeatures[] list Campaign Manager 为广告素材资源检测到的关联功能列表。关联功能是指浏览器为了能够正常呈现 HTML5 广告素材而必须支持的功能。此字段是自动生成的只读字段。
exitCustomEvents[] list 为素材资源配置的退出事件列表。此字段是自动生成的只读字段,仅适用于富媒体素材资源。
exitCustomEvents[].advertiserCustomEventId long 此事件的唯一 ID,由报表和数据传输使用。此字段是只读字段。
exitCustomEvents[].advertiserCustomEventName string 此事件的用户输入的名称。
exitCustomEvents[].advertiserCustomEventType string 事件的类型。此字段是只读字段。

可接受的值为:
  • ADVERTISER_EVENT_COUNTER
  • ADVERTISER_EVENT_EXIT
  • ADVERTISER_EVENT_TIMER
exitCustomEvents[].artworkLabel string 图片标签列,用于将 Campaign Manager 中的事件关联回 Studio 中的事件。此字段是必填字段,插入后不应进行修改。
exitCustomEvents[].artworkType string 广告素材使用的图片类型。此字段是只读字段。

可接受的值为:
  • ARTWORK_TYPE_FLASH
  • ARTWORK_TYPE_HTML5
  • ARTWORK_TYPE_IMAGE
  • ARTWORK_TYPE_MIXED
exitCustomEvents[].exitClickThroughUrl nested object 事件的退出点击后到达网址。此字段仅用于退出事件。
exitCustomEvents[].exitClickThroughUrl.computedClickThroughUrl string 此字段是一个便利的只读字段,用于表示在执行此点击后会使用的实际网址。该网址的计算方式如下:
  • 如果指定了 landingPageId,则系统会将对应着陆页的网址分配给此字段。
  • 如未指定,则系统会将 customClickThroughUrl 分配给此字段。
exitCustomEvents[].exitClickThroughUrl.customClickThroughUrl string 自定义点击后到达网址。如果未设置 landingPageId 字段,则此字段适用。
exitCustomEvents[].exitClickThroughUrl.landingPageId long 点击后到达网址指向的着陆页的 ID。
exitCustomEvents[].id long 此事件的 ID。此字段是必填字段,插入后不应进行修改。
exitCustomEvents[].popupWindowProperties nested object 富媒体弹出式窗口的属性。此字段仅用于退出事件。
exitCustomEvents[].popupWindowProperties.dimension nested object 广告素材的弹出式窗口的尺寸。此字段是只读字段。适用于以下广告素材类型:所有 RICH_MEDIA 和所有 VPAID
exitCustomEvents[].popupWindowProperties.offset nested object 弹出式窗口的左上角坐标。如果 positionType 设为 COORDINATES,则此字段适用。
exitCustomEvents[].popupWindowProperties.offset.left integer 与素材资源或窗口左侧的距离差。
exitCustomEvents[].popupWindowProperties.offset.top integer 与素材资源或窗口顶部的距离差。
exitCustomEvents[].popupWindowProperties.positionType string 弹出式窗口的位置(居中或位于特定坐标点)。

可接受的值为:
  • CENTER
  • COORDINATES
exitCustomEvents[].popupWindowProperties.showAddressBar boolean 是否显示浏览器地址栏。
exitCustomEvents[].popupWindowProperties.showMenuBar boolean 是否显示浏览器菜单栏。
exitCustomEvents[].popupWindowProperties.showScrollBar boolean 是否显示浏览器滚动条。
exitCustomEvents[].popupWindowProperties.showStatusBar boolean 是否显示浏览器状态栏。
exitCustomEvents[].popupWindowProperties.showToolBar boolean 是否显示浏览器工具栏。
exitCustomEvents[].popupWindowProperties.title string 弹出式窗口的标题。
exitCustomEvents[].targetType string 事件使用的目标类型。

可接受的值为:
  • TARGET_BLANK
  • TARGET_PARENT
  • TARGET_POPUP
  • TARGET_SELF
  • TARGET_TOP
exitCustomEvents[].videoReportingId string 视频报表 ID,用于区分单个广告素材中的多个视频。此字段是只读字段。
id long 素材资源的数字 ID。此字段是自动生成的只读字段。
idDimensionValue nested object 素材资源数字 ID 的维度值。此字段是自动生成的只读字段。
kind string 标识所属资源种类。值:固定字符串 "dfareporting#creativeAssetMetadata"
richMedia boolean 如果上传的素材资源是富媒体素材资源,则为 True。此字段是自动生成的只读字段。
timerCustomEvents[] list 为素材资源配置的计时器事件列表。此字段是自动生成的只读字段,仅适用于富媒体素材资源。
timerCustomEvents[].advertiserCustomEventId long 此事件的唯一 ID,由报表和数据传输使用。此字段是只读字段。
timerCustomEvents[].advertiserCustomEventName string 此事件的用户输入的名称。
timerCustomEvents[].advertiserCustomEventType string 事件的类型。此字段是只读字段。

可接受的值为:
  • ADVERTISER_EVENT_COUNTER
  • ADVERTISER_EVENT_EXIT
  • ADVERTISER_EVENT_TIMER
timerCustomEvents[].artworkLabel string 图片标签列,用于将 Campaign Manager 中的事件关联回 Studio 中的事件。此字段是必填字段,插入后不应进行修改。
timerCustomEvents[].artworkType string 广告素材使用的图片类型。此字段是只读字段。

可接受的值为:
  • ARTWORK_TYPE_FLASH
  • ARTWORK_TYPE_HTML5
  • ARTWORK_TYPE_IMAGE
  • ARTWORK_TYPE_MIXED
timerCustomEvents[].exitClickThroughUrl nested object 事件的退出点击后到达网址。此字段仅用于退出事件。
timerCustomEvents[].exitClickThroughUrl.computedClickThroughUrl string 此字段是一个便利的只读字段,用于表示在执行此点击后会使用的实际网址。该网址的计算方式如下:
  • 如果指定了 landingPageId,则系统会将对应着陆页的网址分配给此字段。
  • 如未指定,则系统会将 customClickThroughUrl 分配给此字段。
timerCustomEvents[].exitClickThroughUrl.customClickThroughUrl string 自定义点击后到达网址。如果未设置 landingPageId 字段,则此字段适用。
timerCustomEvents[].exitClickThroughUrl.landingPageId long 点击后到达网址指向的着陆页的 ID。
timerCustomEvents[].id long 此事件的 ID。此字段是必填字段,插入后不应进行修改。
timerCustomEvents[].popupWindowProperties nested object 富媒体弹出式窗口的属性。此字段仅用于退出事件。
timerCustomEvents[].popupWindowProperties.dimension nested object 广告素材的弹出式窗口的尺寸。此字段是只读字段。适用于以下广告素材类型:所有 RICH_MEDIA 和所有 VPAID
timerCustomEvents[].popupWindowProperties.offset nested object 弹出式窗口的左上角坐标。如果 positionType 设为 COORDINATES,则此字段适用。
timerCustomEvents[].popupWindowProperties.offset.left integer 与素材资源或窗口左侧的距离差。
timerCustomEvents[].popupWindowProperties.offset.top integer 与素材资源或窗口顶部的距离差。
timerCustomEvents[].popupWindowProperties.positionType string 弹出式窗口的位置(居中或位于特定坐标点)。

可接受的值为:
  • CENTER
  • COORDINATES
timerCustomEvents[].popupWindowProperties.showAddressBar boolean 是否显示浏览器地址栏。
timerCustomEvents[].popupWindowProperties.showMenuBar boolean 是否显示浏览器菜单栏。
timerCustomEvents[].popupWindowProperties.showScrollBar boolean 是否显示浏览器滚动条。
timerCustomEvents[].popupWindowProperties.showStatusBar boolean 是否显示浏览器状态栏。
timerCustomEvents[].popupWindowProperties.showToolBar boolean 是否显示浏览器工具栏。
timerCustomEvents[].popupWindowProperties.title string 弹出式窗口的标题。
timerCustomEvents[].targetType string 事件使用的目标类型。

可接受的值为:
  • TARGET_BLANK
  • TARGET_PARENT
  • TARGET_POPUP
  • TARGET_SELF
  • TARGET_TOP
timerCustomEvents[].videoReportingId string 视频报表 ID,用于区分单个广告素材中的多个视频。此字段是只读字段。
warnedValidationRules[] list 生成警告的代码生成过程中验证的规则。此字段是自动生成的只读字段。

可能的值为:
  • 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

方法

insert
插入新的广告素材资源。