Creatives

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

资源表示形式

内含广告素材的各项属性。

{
  "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,
  "additionalSizes": [
    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,
      "additionalSizes": [
        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,
      "mediaDuration": float,
      "expandedDimension": sizes Resource,
      "role": string,
      "backupImageExit": {
        "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
        }
      },
      "companionCreativeIds": [
        long
      ],
      "idDimensionValue": dimensionValues Resource,
      "orientation": string,
      "audioBitRate": integer,
      "audioSampleRate": integer,
      "frameRate": float,
      "politeLoad": boolean
    }
  ],
  "redirectUrl": string,
  "htmlCode": string,
  "htmlCodeLocked": boolean,
  "backgroundColor": string,
  "allowScriptAccess": boolean,
  "fsCommand": {
    "positionOption": string,
    "top": integer,
    "left": integer,
    "windowWidth": integer,
    "windowHeight": integer
  },
  "backupImageClickThroughUrl": {
    "landingPageId": long,
    "customClickThroughUrl": string,
    "computedClickThroughUrl": string
  },
  "backupImageTargetWindow": {
    "targetWindowOption": string,
    "customHtml": string
  },
  "clickTags": [
    {
      "name": string,
      "eventName": string,
      "clickThroughUrl": {
        "landingPageId": long,
        "customClickThroughUrl": string,
        "computedClickThroughUrl": 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,
      "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
      }
    }
  ],
  "artworkType": string,
  "requiredFlashVersion": integer,
  "thirdPartyBackupImageImpressionsUrl": string,
  "thirdPartyRichMediaImpressionsUrl": string,
  "totalFileSize": long,
  "mediaDuration": float,
  "commercialId": string,
  "companionCreatives": [
    long
  ],
  "mediaDescription": 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
  },
  "obaIcon": {
    "resourceUrl": string,
    "xPosition": string,
    "yPosition": string,
    "size": sizes Resource,
    "program": string,
    "iconClickThroughUrl": string,
    "iconClickTrackingUrl": string,
    "iconViewTrackingUrl": string
  },
  "authoringSource": string,
  "dynamicAssetSelection": boolean,
  "creativeAssetSelection": {
    "rules": [
      {
        "name": string,
        "assetId": long,
        "targetingTemplateId": long
      }
    ],
    "defaultAssetId": long
  },
  "universalAdId": {
    "registry": string,
    "value": string
  }
}
属性名称 说明 备注
accountId long 对应广告素材的帐号 ID。如未设置,系统会针对插入和更新这两项操作自动生成此字段。适用于所有广告素材类型。
active boolean 用于指明广告素材是否有效。适用于所有广告素材类型。
adParameters string VPAID 广告素材使用的广告参数。此字段是只读字段。适用于以下广告素材类型:所有 VPAID
adTagKeys[] list 富媒体广告素材的关键字。您可以使用关键字来自定义您网站上投放的富媒体广告的广告素材设置,而不必与广告客户联系。您可以使用关键字来动态更改广告素材的外观或功能。适用于以下广告素材类型:所有 RICH_MEDIA 和所有 VPAID
additionalSizes[] list 与自适应广告素材相关联的其他尺寸。在插入或更新广告素材时,既可以使用尺寸的 ID 字段,也可以结合使用尺寸的宽度和高度字段。当主素材资源类型为 HTML_IMAGE 时,适用于 DISPLAY 广告素材。
advertiserId long 对应广告素材的广告客户 ID。此字段是必填字段。适用于所有广告素材类型。
allowScriptAccess boolean 用于指明对应广告素材是否允许脚本访问。此字段是一个弃用的只读字段,会在更新时自动设为 true。适用于以下广告素材类型:FLASH_INPAGE
archived boolean 用于指明广告素材是否已归档。适用于所有广告素材类型。
artworkType string 广告素材所用图片的类型。此字段是只读字段。适用于以下广告素材类型:所有 RICH_MEDIA 和所有 VPAID

可接受的值包括:
  • ARTWORK_TYPE_FLASH
  • ARTWORK_TYPE_HTML5
  • ARTWORK_TYPE_IMAGE
  • ARTWORK_TYPE_MIXED
authoringSource string 制作广告素材的源应用。目前,只有由 DBM 制作的广告素材才能设置此字段。适用于所有广告素材类型。

可接受的值包括:
  • CREATIVE_AUTHORING_SOURCE_DBM
  • CREATIVE_AUTHORING_SOURCE_DCM
  • CREATIVE_AUTHORING_SOURCE_GWD
  • CREATIVE_AUTHORING_SOURCE_STUDIO
authoringTool string HTML5 横幅广告素材的制作工具。此字段是只读字段。适用于以下广告素材类型:HTML5_BANNER

可接受的值包括:
  • NINJA
  • SWIFFY
autoAdvanceImages boolean 用于指明是否会为图库广告素材自动切换图片。适用于以下广告素材类型:DISPLAY_IMAGE_GALLERY
backgroundColor string 内含 6 个字符的 HTML 颜色代码(以 # 开头),用于指定显示 Flash 文件的窗口区域的背景颜色。默认值为 white(白色)。适用于以下广告素材类型:FLASH_INPAGE
backupImageClickThroughUrl nested object 备用图片的点击后到达网址。当主素材资源类型不是 HTML_IMAGE 时,适用于 ENHANCED_BANNER
backupImageClickThroughUrl.computedClickThroughUrl string 此字段是一个便利的只读字段,用于表示在执行相应点击后会使用的实际网址。该网址的计算方式如下:
  • 如果指定了 landingPageId,则系统会将对应着陆页的网址分配给此字段。
  • 如未指定,则系统会将 customClickThroughUrl 分配给此字段。
backupImageClickThroughUrl.customClickThroughUrl string 自定义点击后到达网址。如果未设置 landingPageId 字段,则此字段适用。
backupImageClickThroughUrl.landingPageId long 点击后到达网址指向的着陆页的 ID。
backupImageFeatures[] list 罗列关联功能。当投放广告的浏览器不支持所列的关联功能时,系统将投放备用图片。关联功能是指浏览器为了能够正常呈现 HTML5 广告素材资源而必须支持的功能。此字段最初是系统自动生成的,其中包含 Campaign Manager 为对应广告素材的所有素材资源检测到的所有功能;之后可由客户进行修改。如需重置此字段,请复制为 creativeAssets 检测到的所有功能。适用于以下广告素材类型:HTML5_BANNER。当主素材资源类型不是 HTML_IMAGE 时,适用于 DISPLAY
backupImageReportingLabel string 用于 HTML5 横幅广告备用图片的报表标签。当主素材资源类型不是 HTML_IMAGE 时,适用于以下广告素材类型:DISPLAY
backupImageTargetWindow nested object 备用图片的目标窗口。适用于以下广告素材类型:FLASH_INPAGEHTML5_BANNER。当主素材资源类型不是 HTML_IMAGE 时,适用于 DISPLAY
backupImageTargetWindow.customHtml string 用户输入的值。
backupImageTargetWindow.targetWindowOption string 可在其中展示 Flash 广告素材备用图片的浏览器窗口的类型。

可接受的值包括:
  • CURRENT_WINDOW
  • CUSTOM
  • NEW_WINDOW
clickTags[] list 广告素材的点击代码。对于 DISPLAYFLASH_INPAGEHTML5_BANNER 广告素材,则是系统为对应广告素材关联的素材资源检测到的一部分点击代码。创建 Flash 素材资源后,系统将会在 creativeAssetMetadata 中返回检测到的点击代码。在插入广告素材时,请使用 creativeAssetMetadata.clickTags 字段填充广告素材的 clickTags 字段。对于 DISPLAY_IMAGE_GALLERY 广告素材,每个图片广告素材资源在此列表中应正好有一个条目。通过将 clickTag.name 字段与 creativeAsset.assetIdentifier.name 字段进行匹配,点击代码便可匹配到对应的广告素材资源。适用于以下广告素材类型:DISPLAY_IMAGE_GALLERYFLASH_INPAGEHTML5_BANNER。当主素材资源类型不是 HTML_IMAGE 时,适用于 DISPLAY
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 字段的值相符。
commercialId string 分配给广告素材的业界标准 ID,以用于衡量覆盖面和频次。适用于 INSTREAM_VIDEO_REDIRECT 广告素材。
companionCreatives[] list 罗列向插播视频广告素材分配的随播广告素材。可接受的值包括现有 Flash 广告素材和图片广告素材的 ID。适用于以下广告素材类型:所有 VPAID、所有 INSTREAM_AUDIO,以及所有 dynamicAssetSelection 设为 false 的 INSTREAM_VIDEO
compatibility[] list 与对应广告素材相关联的兼容性。此字段是只读字段。DISPLAYDISPLAY_INTERSTITIAL 分别是指常规广告或插页式广告在桌面设备、移动设备或移动应用中的呈现。APPAPP_INTERSTITIAL 是指在移动应用中的呈现。只有先前已存在的广告素材才能具备这些兼容性,因为系统会为新广告素材改为分配 DISPLAYDISPLAY_INTERSTITIALIN_STREAM_VIDEO 是指在采用 VAST 标准制作的插播视频广告中的呈现。IN_STREAM_AUDIO 是指在采用 VAST 标准制作的插播音频广告中的呈现。适用于所有广告素材类型。

可接受的值包括:
  • APP
  • APP_INTERSTITIAL
  • IN_STREAM_VIDEO
  • IN_STREAM_AUDIO
  • DISPLAY
  • DISPLAY_INTERSTITIAL
convertFlashToHtml5 boolean 用于指明与广告素材相关联的 Flash 资源是否需要自动转换为 HTML5 格式。此标记默认处于启用状态。如果用户不想让系统为对应广告素材生成和使用 HTML5 素材资源,可以选择停用此标记。适用于以下广告素材类型:FLASH_INPAGE。当主素材资源类型不是 HTML_IMAGE 时,适用于 DISPLAY
counterCustomEvents[] list 罗列为广告素材配置的计数器事件。对于 DISPLAY_IMAGE_GALLERY 广告素材,这些会是从 clickTags 中自动生成的只读事件。适用于以下广告素材类型:DISPLAY_IMAGE_GALLERY、所有 RICH_MEDIA 和所有 VPAID
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,用于区分单个广告素材中的多个视频。此字段是只读字段。
creativeAssetSelection nested object 如果 dynamicAssetSelection 为 true,则为必填字段。
creativeAssetSelection.defaultAssetId long 一种 creativeAssets[].id。此字段应引用对应广告素材中的其中一个父素材资源。如果没有匹配的规则,系统将投放该素材资源。此字段是必填字段。
creativeAssetSelection.rules[] list 用于确定将向观看者投放哪个素材资源的规则。系统将按照规则在此列表中的存储顺序来评估规则。此列表必须包含至少一条规则。适用于 INSTREAM_VIDEO 广告素材。
creativeAssetSelection.rules[].assetId long 一种 creativeAssets[].id。此字段应引用对应广告素材中的其中一个父素材资源。此字段是必填字段。
creativeAssetSelection.rules[].name string 对应规则直观易懂的名称。此字段是必填字段。
creativeAssetSelection.rules[].targetingTemplateId long 定位条件模板 ID。系统将根据定位条件模板中的定位条件来确定是否应投放对应的素材资源。此字段是必填字段。
creativeAssets[] list 与广告素材相关联的素材资源。适用于除以下广告素材类型之外的所有广告素材类型:INTERNAL_REDIRECTINTERSTITIAL_INTERNAL_REDIRECTREDIRECT
creativeAssets[].actionScript3 boolean 用于指明是否为 Flash 资源启用 ActionScript3。此字段是只读字段。适用于以下广告素材类型:FLASH_INPAGE。当主素材资源类型不是 HTML_IMAGE 时,适用于 DISPLAY
creativeAssets[].active boolean 用于指明视频/音频资源是否有效。此字段是 VPAID_NON_LINEAR_VIDEO 素材资源的只读字段。适用于以下广告素材类型:INSTREAM_AUDIOINSTREAM_VIDEO 和所有 VPAID
creativeAssets[].additionalSizes[] list 与对应广告素材资源相关联的其他尺寸。由 GWD 等兼容软件生成的 HTML5 素材资源可支持对应广告素材资源所能呈现的其他尺寸。
creativeAssets[].alignment string 素材资源可能采用的对齐方式。此字段是只读字段。适用于以下广告素材类型:RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL

可接受的值包括:
  • ALIGNMENT_BOTTOM
  • ALIGNMENT_LEFT
  • ALIGNMENT_RIGHT
  • ALIGNMENT_TOP
creativeAssets[].artworkType string 富媒体广告素材的图片类型。此字段是只读字段。适用于以下广告素材类型:所有 RICH_MEDIA

可接受的值包括:
  • ARTWORK_TYPE_FLASH
  • ARTWORK_TYPE_HTML5
  • ARTWORK_TYPE_IMAGE
  • ARTWORK_TYPE_MIXED
creativeAssets[].assetIdentifier nested object 对应素材资源的标识符。此标识符与广告素材资源插入操作期间返回的标识符相同。此字段是必填字段。适用于除以下广告素材类型之外的所有广告素材类型:所有 REDIRECTTRACKING_TEXT
creativeAssets[].assetIdentifier.name string 广告素材资源的名称。插入素材资源时,此字段是必填字段。插入后,此 assetIdentifier 用于标识已上传的素材资源。名称中的字符必须是字母数字或“.-_ ”中的一个字符。可以使用空格。
creativeAssets[].assetIdentifier.type string 要上传的素材资源的类型。此字段是必填字段。对于新的上传,FLASHIMAGE 不再受支持。所有图片素材资源都应使用 HTML_IMAGE

可接受的值包括:
  • AUDIO
  • FLASH
  • HTML
  • HTML_IMAGE
  • IMAGE
  • VIDEO
creativeAssets[].audioBitRate integer 音频流比特率(以 kbps 为单位)。此字段是只读字段。适用于以下广告素材类型:INSTREAM_AUDIOINSTREAM_VIDEO 和所有 VPAID
creativeAssets[].audioSampleRate integer 音频采样率(以赫兹为单位)。此字段是只读字段。适用于以下广告素材类型:INSTREAM_AUDIOINSTREAM_VIDEO 和所有 VPAID
creativeAssets[].backupImageExit nested object 为备用图片配置的退出事件。适用于以下广告素材类型:所有 RICH_MEDIA
creativeAssets[].backupImageExit.advertiserCustomEventId long 报表和数据传输所用对应事件的唯一 ID。此字段是只读字段。
creativeAssets[].backupImageExit.advertiserCustomEventName string 此事件的用户输入的名称。
creativeAssets[].backupImageExit.advertiserCustomEventType string 事件的类型。此字段是只读字段。

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

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

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

可接受的值包括:
  • TARGET_BLANK
  • TARGET_PARENT
  • TARGET_POPUP
  • TARGET_SELF
  • TARGET_TOP
creativeAssets[].backupImageExit.videoReportingId string 视频报表 ID,用于区分单个广告素材中的多个视频。此字段是只读字段。
creativeAssets[].bitRate integer 检测到的音频/视频资源的比特率。此字段是只读字段。适用于以下广告素材类型:INSTREAM_AUDIOINSTREAM_VIDEO 和所有 VPAID
creativeAssets[].childAssetType string 富媒体子素材资源类型。此字段是只读字段。适用于以下广告素材类型:所有 VPAID

可接受的值包括:
  • CHILD_ASSET_TYPE_DATA
  • CHILD_ASSET_TYPE_FLASH
  • CHILD_ASSET_TYPE_IMAGE
  • CHILD_ASSET_TYPE_VIDEO
creativeAssets[].collapsedSize nested object 素材资源处于合拢状态时的尺寸。此字段是只读字段。适用于以下广告素材类型:所有 RICH_MEDIA 和所有 VPAID。此外,还适用于其 displayType 设为 ASSET_DISPLAY_TYPE_EXPANDINGASSET_DISPLAY_TYPE_PEEL_DOWN 的素材资源。
creativeAssets[].companionCreativeIds[] list 罗列向插播视频广告素材资源分配的随播广告素材。可接受的值包括现有 Flash 广告素材和图片广告素材的 ID。适用于 dynamicAssetSelection 设为 true 的 INSTREAM_VIDEO 广告素材类型。
creativeAssets[].customStartTimeValue integer 让素材资源显示的自定义开始时间(以秒为单位)。适用于以下广告素材类型:所有 RICH_MEDIA。值必须大于或等于 0
creativeAssets[].detectedFeatures[] list 罗列 Campaign Manager 为广告素材资源检测到的关联功能。关联功能是指浏览器为了能够正常呈现 HTML5 广告素材而必须支持的功能。此字段是自动生成的只读字段。适用于以下广告素材类型:HTML5_BANNER。当主素材资源类型不是 HTML_IMAGE 时,适用于 DISPLAY
creativeAssets[].displayType string 富媒体资源的类型。此字段是只读字段。适用于以下广告素材类型:所有 RICH_MEDIA

可接受的值包括:
  • 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 素材资源的展示时长(以秒为单位)。适用于以下广告素材类型:INSTREAM_AUDIOINSTREAM_VIDEOVPAID_LINEAR_VIDEO。值必须大于或等于 1
creativeAssets[].durationType string 素材资源的展示时长类型。适用于以下广告素材类型:所有 RICH_MEDIA

可接受的值包括:
  • ASSET_DURATION_TYPE_AUTO
  • ASSET_DURATION_TYPE_CUSTOM
  • ASSET_DURATION_TYPE_NONE
creativeAssets[].expandedDimension nested object 检测到的视频资源展开后尺寸。此字段是只读字段。适用于以下广告素材类型:INSTREAM_VIDEO 和所有 VPAID
creativeAssets[].fileSize long 与对应广告素材资源相关联的文件大小。此字段是只读字段。适用于除以下广告素材类型之外的所有广告素材类型:所有 REDIRECTTRACKING_TEXT
creativeAssets[].flashVersion integer 素材资源的 Flash 版本。此字段是只读字段。适用于以下广告素材类型:FLASH_INPAGE、所有 RICH_MEDIA 和所有 VPAID。当主素材资源类型不是 HTML_IMAGE 时,适用于 DISPLAY
creativeAssets[].frameRate float 视频资源的视频帧速率(以每秒帧数为单位)。此字段是只读字段。适用于以下广告素材类型:INSTREAM_VIDEO 和所有 VPAID
creativeAssets[].hideFlashObjects boolean 用于指明是否隐藏素材资源的 Flash 对象标记。适用于以下广告素材类型:所有 RICH_MEDIA
creativeAssets[].hideSelectionBoxes boolean 用于指明是否隐藏素材资源的选择框标记。适用于以下广告素材类型:所有 RICH_MEDIA
creativeAssets[].horizontallyLocked boolean 用于指明素材资源是否处于水平锁定状态。此字段是只读字段。适用于以下广告素材类型:所有 RICH_MEDIA
creativeAssets[].id long 对应广告素材资源的数字 ID。此字段是必填字段,且不应被修改。适用于除以下广告素材类型之外的所有广告素材类型:所有 REDIRECTTRACKING_TEXT
creativeAssets[].idDimensionValue nested object 素材资源 ID 的维度值。此字段是自动生成的只读字段。
creativeAssets[].mediaDuration float 检测到的音频/视频资源的时长。此字段是只读字段。适用于以下广告素材类型:INSTREAM_AUDIOINSTREAM_VIDEO 和所有 VPAID
creativeAssets[].mimeType string 检测到的音频/视频资源的 MIME 类型。此字段是只读字段。适用于以下广告素材类型:INSTREAM_AUDIOINSTREAM_VIDEO 和所有 VPAID
creativeAssets[].offset nested object 素材资源在合拢模式下的偏移位置。此字段是只读字段。适用于以下广告素材类型:所有 RICH_MEDIA 和所有 VPAID。此外,仅适用于其 displayType 设为 ASSET_DISPLAY_TYPE_EXPANDINGASSET_DISPLAY_TYPE_PEEL_DOWN 的素材资源。
creativeAssets[].offset.left integer 相对于素材资源或窗口左边缘的偏移距离。
creativeAssets[].offset.top integer 相对于素材资源或窗口上边缘的偏移距离。
creativeAssets[].orientation string 视频资源的方向。此字段是自动生成的只读字段。

可接受的值包括:
  • LANDSCAPE
  • PORTRAIT
  • SQUARE
creativeAssets[].originalBackup boolean 用于指明 Campaign Manager 中的备用素材资源是原始素材资源还是经过用户更改后的素材资源。适用于以下广告素材类型:所有 RICH_MEDIA
creativeAssets[].politeLoad boolean 用于指明对应素材资源是否用作礼让加载素材资源。
creativeAssets[].position nested object 素材资源的偏移位置。适用于以下广告素材类型:所有 RICH_MEDIA
creativeAssets[].position.left integer 相对于素材资源或窗口左边缘的偏移距离。
creativeAssets[].position.top integer 相对于素材资源或窗口上边缘的偏移距离。
creativeAssets[].positionLeftUnit string 素材资源的左侧偏移量单位。此字段是只读字段。适用于以下广告素材类型:所有 RICH_MEDIA

可接受的值包括:
  • OFFSET_UNIT_PERCENT
  • OFFSET_UNIT_PIXEL
  • OFFSET_UNIT_PIXEL_FROM_CENTER
creativeAssets[].positionTopUnit string 素材资源的顶部偏移量单位。如果素材资源的 displayType 设为 ASSET_DISPLAY_TYPE_OVERLAY,该字段是只读字段。适用于以下广告素材类型:所有 RICH_MEDIA

可接受的值包括:
  • OFFSET_UNIT_PERCENT
  • OFFSET_UNIT_PIXEL
  • OFFSET_UNIT_PIXEL_FROM_CENTER
creativeAssets[].progressiveServingUrl string 视频资源的视频优先播放网址。此字段是只读字段。适用于以下广告素材类型:INSTREAM_VIDEO 和所有 VPAID
creativeAssets[].pushdown boolean 用于指明素材资源是否下推其他内容。适用于以下广告素材类型:所有 RICH_MEDIA。此外,仅适用于素材资源偏移量为 0、collapsedSize.widthsize.width 一致且 collapsedSize.height 小于 size.height 这种情况。
creativeAssets[].pushdownDuration float 素材资源的下推持续时间(以秒为单位)。适用于以下广告素材类型:所有 RICH_MEDIA。此外,仅适用于素材资源下推字段设为 true、偏移量为 0、collapsedSize.widthsize.width 一致且collapsedSize.height 小于 size.height 这种情况。可接受的值介于 0(含)到 9.99(含)之间。
creativeAssets[].role string 素材资源在广告素材中的角色。适用于除以下广告素材类型之外的所有广告素材类型:所有 REDIRECTTRACKING_TEXT。此字段是必填字段。

PRIMARY 适用于 DISPLAYFLASH_INPAGEHTML5_BANNERIMAGEDISPLAY_IMAGE_GALLERY、所有 RICH_MEDIA(可能含有多个主素材资源)和所有 VPAID 广告素材。

BACKUP_IMAGE 适用于 FLASH_INPAGEHTML5_BANNERall RICH_MEDIA 和所有 VPAID 广告素材。当主素材资源类型不是 HTML_IMAGE 时,适用于 DISPLAY

ADDITIONAL_IMAGEADDITIONAL_FLASH 适用于 FLASH_INPAGE 广告素材。

OTHER 是指来自 Campaign Manager 以外来源的素材资源(例如通过 Studio 上传的素材资源),适用于所有 RICH_MEDIA 和所有 VPAID 广告素材。

PARENT_VIDEO 是指用户在 Campaign Manager 中上传的视频,适用于 INSTREAM_VIDEOVPAID_LINEAR_VIDEO 广告素材。

TRANSCODED_VIDEO 是指 Campaign Manager 从 PARENT_VIDEO 素材资源转码而来的视频,适用于 INSTREAM_VIDEOVPAID_LINEAR_VIDEO 广告素材。

ALTERNATE_VIDEO 是指 Studio 中的子素材资源视频在 Campaign Manager 中的表示形式,适用于 VPAID_LINEAR_VIDEO 广告素材。无法在 Campaign Manager 中添加或移除这些属性。

对于 VPAID_LINEAR_VIDEO 广告素材,当 VPAID 广告素材无法投放时,系统会将标记为 activePARENT_VIDEOTRANSCODED_VIDEOALTERNATE_VIDEO 素材资源用作备用素材资源。对于 INSTREAM_VIDEOVPAID_LINEAR_VIDEO 广告素材,只能添加或移除 PARENT_VIDEO 素材资源。

PARENT_AUDIO 是指用户在 Campaign Manager 中上传的音频,适用于 INSTREAM_AUDIO 广告素材。

TRANSCODED_AUDIO 是指 Campaign Manager 从 PARENT_AUDIO 素材资源转码而来的音频,适用于 INSTREAM_AUDIO 广告素材。



可接受的值包括:
  • ADDITIONAL_FLASH
  • ADDITIONAL_IMAGE
  • ALTERNATE_VIDEO
  • BACKUP_IMAGE
  • OTHER
  • PARENT_AUDIO
  • PARENT_VIDEO
  • PRIMARY
  • TRANSCODED_AUDIO
  • TRANSCODED_VIDEO
creativeAssets[].size nested object 与对应广告素材资源相关联的尺寸。在适用情况下,此字段为必填字段。不过,对于 IMAGEFLASH_INPAGE,如果广告素材留空,系统会使用关联图片素材资源的实际尺寸自动设置此字段。适用于以下广告素材类型:DISPLAY_IMAGE_GALLERYFLASH_INPAGEHTML5_BANNERIMAGE 和所有 RICH_MEDIA。当主素材资源类型不是 HTML_IMAGE 时,适用于 DISPLAY
creativeAssets[].sslCompliant boolean 用于指明素材资源是否符合 SSL 协议。此字段是只读字段。适用于除以下广告素材类型之外的所有广告素材类型:所有 REDIRECTTRACKING_TEXT
creativeAssets[].startTimeType string 为了让素材资源显示而需要的初次等待时间所属的类型。适用于以下广告素材类型:所有 RICH_MEDIA

可接受的值包括:
  • ASSET_START_TIME_TYPE_CUSTOM
  • ASSET_START_TIME_TYPE_NONE
creativeAssets[].streamingServingUrl string 视频资源的流式传输网址。此字段是只读字段。适用于以下广告素材类型:INSTREAM_VIDEO 和所有 VPAID
creativeAssets[].transparency boolean 用于指明素材资源是否透明。适用于以下广告素材类型:所有 RICH_MEDIA。此外,仅适用于 HTML5 素材资源。
creativeAssets[].verticallyLocked boolean 用于指明素材资源是否处于垂直锁定状态。此字段是只读字段。适用于以下广告素材类型:所有 RICH_MEDIA
creativeAssets[].windowMode string Flash 素材资源的窗口模式选项。适用于以下广告素材类型:FLASH_INPAGERICH_MEDIA_DISPLAY_EXPANDINGRICH_MEDIA_IM_EXPANDRICH_MEDIA_DISPLAY_BANNERRICH_MEDIA_INPAGE_FLOATING

可接受的值包括:
  • OPAQUE
  • TRANSPARENT
  • WINDOW
creativeAssets[].zIndex integer 素材资源的 zIndex 值。适用于以下广告素材类型:所有 RICH_MEDIA。此外,仅适用于其 displayType 未设为以下任一类型的素材资源:ASSET_DISPLAY_TYPE_INPAGEASSET_DISPLAY_TYPE_OVERLAY。可接受的值介于 -999999999(含)到 999999999(含)之间。
creativeAssets[].zipFilename string zip 文件的文件名。此字段是只读字段。适用于以下广告素材类型:HTML5_BANNER
creativeAssets[].zipFilesize string zip 文件的大小。此字段是只读字段。适用于以下广告素材类型:HTML5_BANNER
creativeFieldAssignments[] list 对应广告素材的广告素材字段分配。适用于所有广告素材类型。
creativeFieldAssignments[].creativeFieldId long 广告素材字段的 ID。
creativeFieldAssignments[].creativeFieldValueId long 广告素材字段值的 ID。
customKeyValues[] list 用于富媒体广告素材的自定义键值对。您可以使用键值对来自定义您网站上投放的富媒体广告的广告素材设置,而不必与广告客户联系。您可以使用键值对动态更改广告素材的外观或功能。适用于以下广告素材类型:所有 RICH_MEDIA 和所有 VPAID
dynamicAssetSelection boolean 如果将此字段设为 true,即可启用规则来定位对应广告素材中的各个素材资源。当此字段设为 true 时,必须设置 creativeAssetSelection。此外,该字段还可控制素材资源级随播广告素材。在这种情况下,应将随播广告素材分配给广告素材资源。了解详情。适用于 INSTREAM_VIDEO 广告素材。
exitCustomEvents[] list 罗列为广告素材配置的退出事件。对于 DISPLAYDISPLAY_IMAGE_GALLERY 广告素材,这些会是从 clickTags 中自动生成的只读事件。对于 DISPLAY,还会从 backupImageReportingLabel 中生成一个事件。适用于以下广告素材类型:DISPLAY_IMAGE_GALLERY、所有 RICH_MEDIA 和所有 VPAID。当主素材资源类型不是 HTML_IMAGE 时,适用于 DISPLAY
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,用于区分单个广告素材中的多个视频。此字段是只读字段。
fsCommand nested object 对应广告素材的 OpenWindow FSCommand。此字段可用于让 SWF 文件与 Flash Player 或托管 Flash Player 的程序(如网络浏览器)进行通信。只有当 allowScriptAccess 字段设为 true 时,才会触发此命令。适用于以下广告素材类型:FLASH_INPAGE
fsCommand.left integer 与浏览器左侧的距离。当 positionOption 设为 DISTANCE_FROM_TOP_LEFT_CORNER 时,适用此字段。
fsCommand.positionOption string 在浏览器中用于打开窗口的位置。

可接受的值包括:
  • CENTERED
  • DISTANCE_FROM_TOP_LEFT_CORNER
fsCommand.top integer 与浏览器顶部的距离。当 positionOption 设为 DISTANCE_FROM_TOP_LEFT_CORNER 时,适用此字段。
fsCommand.windowHeight integer 窗口高度。
fsCommand.windowWidth integer 窗口的宽度。
htmlCode string 广告素材的 HTML 代码。在适用情况下,此字段为必填字段。如果 htmlCodeLocked 设为 true,则忽略此字段。适用于以下广告素材类型:所有 CUSTOMFLASH_INPAGEHTML5_BANNER 和所有 RICH_MEDIA
htmlCodeLocked boolean 用于指明 HTML 代码是由 Campaign Manager 生成还是手动输入。如果设为 true,则可忽略对 htmlCode 的更改。适用于以下广告素材类型:FLASH_INPAGEHTML5_BANNER
id long 对应广告素材的 ID。此字段是自动生成的只读字段。适用于所有广告素材类型。
idDimensionValue nested object 对应广告素材 ID 的维度值。此字段是只读字段。适用于所有广告素材类型。
kind string 标识所属资源种类。值:固定字符串 "dfareporting#creative"
lastModifiedInfo nested object 广告素材上次修改信息。此字段是只读字段。适用于所有广告素材类型。
lastModifiedInfo.time long 上次更改的时间戳(以毫秒为单位,自纪元开始的时间算起)。
latestTraffickedCreativeId long 通过 Studio 进行投放管理且与富媒体广告素材和 VPAID 广告素材相关联的最新广告素材 ID。此字段是只读字段。适用于以下广告素材类型:所有 RICH_MEDIA 和所有 VPAID
mediaDescription string 音频或视频广告的广告内容描述。适用于以下类型的广告素材:所有 INSTREAM_VIDEOINSTREAM_AUDIO 和所有 VPAID
mediaDuration float 广告素材音频/视频的时长(以秒为单位)。此字段是只读字段。适用于以下广告素材类型:INSTREAM_VIDEOINSTREAM_AUDIO、所有 RICH_MEDIA 和所有 VPAID
name string 广告素材的名称。此字段是必填字段,且长度必须少于 256 个字符。适用于所有广告素材类型。
obaIcon nested object 要添加到广告素材中的在线行为广告图标 (OBA)。适用于以下广告素材类型:所有 INSTREAM_VIDEO
obaIcon.iconClickThroughUrl string 点击 OBA 图标后重定向到的网址。
obaIcon.iconClickTrackingUrl string 用于在点击 OBA 图标后跟踪点击的网址。
obaIcon.iconViewTrackingUrl string 用于在点击 OBA 图标后跟踪浏览的网址。
obaIcon.program string 指明相关图标支持的业界规范。例如,AdChoices。
obaIcon.resourceUrl string OBA 图标资源网址。Campaign Manager 仅支持图片和 JavaScript 图标。了解详情
obaIcon.size nested object OBA 图标的尺寸。
obaIcon.xPosition string OBA 图标在 x 坐标的位置。可接受的值为“left”或“right”。
obaIcon.yPosition string OBA 图标在 y 坐标的位置。接受的值为:top(顶部)或 bottom(底部)。
overrideCss string 富媒体广告素材的 CSS 替换值。适用于以下广告素材类型:所有 RICH_MEDIA
progressOffset nested object 为了统计一次观看而需要的视频播放时长。适用于以下广告素材类型:所有 INSTREAM_VIDEO
progressOffset.offsetPercentage integer 时长(百分比形式的视频时长)。如果已设置 offsetSeconds,请勿设置此字段。可接受的值介于 0(含)到 100(含)之间。
progressOffset.offsetSeconds integer 时长(以秒为单位)。如果已设置 offsetPercentage,请勿设置此字段。可接受的值介于 0(含)到 86399(含)之间。
redirectUrl string 托管图片/视频或另一广告代码的网址。对于 INSTREAM_VIDEO_REDIRECT 广告素材,此网址是插播视频广告素材的重定向网址。VAST(视频广告服务模板)广告响应的标准允许重定向链接到其他 VAST 2.0 或 3.0 调用。在适用情况下,此字段为必填字段。适用于以下广告素材类型:DISPLAY_REDIRECTINTERNAL_REDIRECTINTERSTITIAL_INTERNAL_REDIRECTINSTREAM_VIDEO_REDIRECT
renderingId long 当前呈现版本的 ID。此字段是只读字段。适用于所有广告素材类型。
renderingIdDimensionValue nested object 对应广告素材呈现 ID 的维度值。此字段是只读字段。适用于所有广告素材类型。
requiredFlashPluginVersion string 对应广告素材所需的 Flash 插件最低版本。例如:11.2.202.235。此字段是只读字段。适用于以下广告素材类型:所有 RICH_MEDIA 和所有 VPAID
requiredFlashVersion integer 对应广告素材的内部 Flash 版本(由 Studio 计算得出)。此字段是只读字段。适用于以下广告素材类型:FLASH_INPAGE、所有 RICH_MEDIA 和所有 VPAID。当主素材资源类型不是 HTML_IMAGE 时,适用于 DISPLAY
size nested object 与对应广告素材相关联的尺寸。在插入或更新广告素材时,既可以使用尺寸的 ID 字段,也可以结合使用尺寸的宽度和高度字段。在适用情况下,此字段为必填字段。不过,对于 IMAGEFLASH_INPAGE 广告素材,以及主素材资源类型为 HTML_IMAGEDISPLAY 广告素材,如果留空,系统会使用关联图片素材资源的实际尺寸自动设置此字段。适用于以下广告素材类型:DISPLAYDISPLAY_IMAGE_GALLERYFLASH_INPAGEHTML5_BANNERIMAGE 和所有 RICH_MEDIA
skipOffset nested object 为了让“跳过”按钮出现而需要的视频播放时长。适用于以下广告素材类型:所有 INSTREAM_VIDEO
skipOffset.offsetPercentage integer 时长(百分比形式的视频时长)。如果已设置 offsetSeconds,请勿设置此字段。可接受的值介于 0(含)到 100(含)之间。
skipOffset.offsetSeconds integer 时长(以秒为单位)。如果已设置 offsetPercentage,请勿设置此字段。可接受的值介于 0(含)到 86399(含)之间。
skippable boolean 用于指明用户能否选择跳过广告素材。适用于以下广告素材类型:所有 INSTREAM_VIDEO 和所有 VPAID
sslCompliant boolean 用于指明广告素材是否符合 SSL 协议。此字段是只读字段。适用于所有广告素材类型。
sslOverride boolean 用于指明广告素材是否应被视为符合 SSL 协议,哪怕系统扫描结果显示其不符合 SSL 协议。适用于所有广告素材类型。
studioAdvertiserId long 与富媒体广告素材和 VPAID 广告素材相关联的 Studio 广告客户 ID。此字段是只读字段。适用于以下广告素材类型:所有 RICH_MEDIA 和所有 VPAID
studioCreativeId long 与富媒体广告素材和 VPAID 广告素材相关联的 Studio 广告素材 ID。此字段是只读字段。适用于以下广告素材类型:所有 RICH_MEDIA 和所有 VPAID
studioTraffickedCreativeId long 通过 Studio 进行投放管理且与富媒体广告素材和 VPAID 广告素材相关联的广告素材 ID。此字段是只读字段。适用于以下广告素材类型:所有 RICH_MEDIA 和所有 VPAID
subaccountId long 对应广告素材的子帐号 ID。如未设置,系统会针对插入和更新这两项操作自动生成此字段。适用于所有广告素材类型。
thirdPartyBackupImageImpressionsUrl string 用于记录备用图片展示次数的第三方网址。适用于以下广告素材类型:所有 RICH_MEDIA
thirdPartyRichMediaImpressionsUrl string 用于记录富媒体展示次数的第三方网址。适用于以下广告素材类型:所有 RICH_MEDIA
thirdPartyUrls[] list 用于跟踪插播视频广告素材事件的第三方网址。适用于以下广告素材类型:所有 INSTREAM_VIDEO、所有 INSTREAM_AUDIO 和所有 VPAID
thirdPartyUrls[].thirdPartyUrlType string 插播视频广告素材和插播音频广告素材的第三方网址类型。

可接受的值包括:
  • 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 指定的第三方网址类型的网址。
timerCustomEvents[] list 罗列为广告素材配置的计时器事件。对于 DISPLAY_IMAGE_GALLERY 广告素材,这些会是从 clickTags 中自动生成的只读事件。适用于以下广告素材类型:DISPLAY_IMAGE_GALLERY、所有 RICH_MEDIA 和所有 VPAID。当主素材资源不是 HTML_IMAGE 时,适用于 DISPLAY
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,用于区分单个广告素材中的多个视频。此字段是只读字段。
totalFileSize long 所有广告素材资源的合计大小。此字段是只读字段。适用于以下广告素材类型:所有 RICH_MEDIA 和所有 VPAID
type string 对应广告素材的类型。此字段是必填字段。适用于所有广告素材类型。

注意FLASH_INPAGEHTML5_BANNERIMAGE 仅用于现有的广告素材。新广告素材应使用 DISPLAY 来代替这些类型。

可接受的值包括:
  • BRAND_SAFE_DEFAULT_INSTREAM_VIDEO
  • CUSTOM_DISPLAY
  • CUSTOM_DISPLAY_INTERSTITIAL
  • DISPLAY
  • DISPLAY_IMAGE_GALLERY
  • DISPLAY_REDIRECT
  • FLASH_INPAGE
  • HTML5_BANNER
  • IMAGE
  • INSTREAM_AUDIO
  • 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 根据 VAST 4.0 规范的通用广告 ID。适用于以下广告素材类型:INSTREAM_AUDIOINSTREAM_VIDEOVPAID
universalAdId.registry string 用于广告 ID 值的注册表。

可接受的值包括:
  • AD_ID.ORG
  • CLEARCAST
  • DCM
  • OTHER
universalAdId.value string 对应广告素材的 ID 值。只有字母数字字符和下列符号属于有效字符:_/\-。长度上限为 64 个字符。当 registry 设为 DCM 时,此字段为只读字段。
version integer 版本号有助于您在报表中跟踪广告素材的多个版本。系统在插入操作期间一律自动生成版本号,从 1 开始。对于跟踪广告素材,版本无法递增,将始终保持为 1。对于其他所有广告素材类型,在更新操作期间,版本只能递增 1。此外,在富媒体广告素材合并过程中,版本会自动递增 1。适用于所有广告素材类型。

方法

get
根据 ID 获取一个广告素材。
insert
插入新广告素材。
list
检索广告素材列表,可能是过滤后的。此方法支持分页
patch
更新现有广告素材。此方法支持修补语义
update
更新现有广告素材。