REST Resource: advertisers.creatives

资源：广告素材

一个广告素材。

JSON 表示法 
{
  "name": string,
  "advertiserId": string,
  "creativeId": string,
  "cmPlacementId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "createTime": string,
  "creativeType": enum (CreativeType),
  "hostingSource": enum (HostingSource),
  "dynamic": boolean,
  "dimensions": {
    object (Dimensions)
  },
  "additionalDimensions": [
    {
      object (Dimensions)
    }
  ],
  "mediaDuration": string,
  "creativeAttributes": [
    enum (CreativeAttribute)
  ],
  "reviewStatus": {
    object (ReviewStatusInfo)
  },
  "assets": [
    {
      object (AssetAssociation)
    }
  ],
  "exitEvents": [
    {
      object (ExitEvent)
    }
  ],
  "timerEvents": [
    {
      object (TimerEvent)
    }
  ],
  "counterEvents": [
    {
      object (CounterEvent)
    }
  ],
  "appendedTag": string,
  "integrationCode": string,
  "notes": string,
  "iasCampaignMonitoring": boolean,
  "companionCreativeIds": [
    string
  ],
  "skippable": boolean,
  "skipOffset": {
    object (AudioVideoOffset)
  },
  "progressOffset": {
    object (AudioVideoOffset)
  },
  "universalAdId": {
    object (UniversalAdId)
  },
  "thirdPartyUrls": [
    {
      object (ThirdPartyUrl)
    }
  ],
  "transcodes": [
    {
      object (Transcode)
    }
  ],
  "trackerUrls": [
    string
  ],
  "jsTrackerUrl": string,
  "cmTrackingAd": {
    object (CmTrackingAd)
  },
  "obaIcon": {
    object (ObaIcon)
  },
  "thirdPartyTag": string,
  "requireMraid": boolean,
  "requireHtml5": boolean,
  "requirePingForAttribution": boolean,
  "expandingDirection": enum (ExpandingDirection),
  "expandOnHover": boolean,
  "vastTagUrl": string,
  "vpaid": boolean,
  "html5Video": boolean,
  "lineItemIds": [
    string
  ],
  "mp3Audio": boolean,
  "oggAudio": boolean
}
字段
name

string

仅限输出。广告素材的资源名称。
advertiserId

string (int64 format)

仅限输出。广告素材所属广告客户的唯一 ID。
creativeId

string (int64 format)

仅限输出。广告素材的唯一 ID。由系统分配。
cmPlacementId

string (int64 format)

仅限输出。与广告素材相关联的 Campaign Manager 360 展示位置的唯一 ID。此字段仅适用于从 Campaign Manager 同步过来的广告素材。
displayName

string

必需。广告素材的显示名称。

必须采用 UTF-8 编码，大小不超过 240 个字节。
entityStatus

enum (EntityStatus)

必需。控制能否投放此广告素材。

接受的值包括：

  • ENTITY_STATUS_ACTIVE
  • ENTITY_STATUS_ARCHIVED
  • ENTITY_STATUS_PAUSED
updateTime

string (Timestamp format)

仅限输出。上次更新广告素材时的时间戳，由用户或系统（如广告素材审核）更新。由系统分配。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
createTime

string (Timestamp format)

仅限输出。创建广告素材时的时间戳。由系统分配。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
creativeType

enum (CreativeType)

必需。不可变。广告素材的类型。
hostingSource

enum (HostingSource)

必需。指明广告素材的托管位置。
dynamic

boolean

仅限输出。指明广告素材是否为动态广告素材。
dimensions

object (Dimensions)

必需。广告素材的主要尺寸。适用于所有广告素材类型。当 creativeType 为以下项之一时，widthPixels 和 heightPixels 的值默认为 0：

  • CREATIVE_TYPE_VIDEO
  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_NATIVE_VIDEO
additionalDimensions[]

object (Dimensions)

其他维度。当 creativeType 为以下项之一时，适用此字段：

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE
  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_LIGHTBOX
  • CREATIVE_TYPE_PUBLISHER_HOSTED

如果指定此字段，则 widthPixels 和 heightPixels 均为必填字段，并且必须大于或等于 0。
mediaDuration

string (Duration format)

仅限输出。广告素材的媒体时长。当 creativeType 为以下项之一时，适用此字段：

  • CREATIVE_TYPE_VIDEO
  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_NATIVE_VIDEO
  • CREATIVE_TYPE_PUBLISHER_HOSTED

该时长以秒为单位，最多包含九个小数位，以“s”结尾。示例："3.5s"。
creativeAttributes[]

enum (CreativeAttribute)

仅限输出。系统生成的广告素材属性列表。
reviewStatus

object (ReviewStatusInfo)

仅限输出。广告素材审核流程的当前状态。
assets[]

object (AssetAssociation)

必需。与对应广告素材相关联的资源。
exitEvents[]

object (ExitEvent)

必需。此广告素材的退出事件。退出（也称为点击代码）是指广告素材中可供用户点击或点按以打开广告客户着陆页的任意区域。每个广告素材都必须包含至少一个退出。您可以通过以下任一方式向广告素材添加退出：

  • 使用 Google Web Designer 的点按区域。
  • 定义一个名为“clickTag”的 JavaScript 变量。
  • 使用启动器 (Enabler.exit()) 跟踪富媒体格式的退出。
timerEvents[]

object (TimerEvent)

为富媒体广告素材设置计时器自定义事件。计时器会跟踪用户查看富媒体广告素材并与之互动的时间。一个广告素材可以有多个单独计时的计时器事件。对于仅包含图片素材资源的广告素材，请将此字段留空或未设置。
counterEvents[]

object (CounterEvent)

富媒体广告素材的计数器事件。计数器以特定方式（鼠标悬停、鼠标移开、点击、点按、数据加载、键盘输入等）与富媒体广告素材的任何部分进行互动的次数。可将广告素材中捕获的任何事件记录为计数器事件。对于仅包含图片素材资源的广告素材，请将此字段留空或未设置。
appendedTag

string

要附加到广告素材代码的第三方 HTML 跟踪代码。
integrationCode

string

用于将该广告素材关联到外部系统的 ID 信息。必须采用 UTF-8 编码，长度不得超过 10,000 个字符。
notes

string

此广告素材的用户备注。必须采用 UTF-8 编码，长度不得超过 20,000 个字符。
iasCampaignMonitoring

boolean

指明是否已启用 Integral Ad Science (IAS) 广告系列监测功能。要为广告素材启用此功能，请确保 Advertiser.creative_config.ias_client_id 已设置为您的 IAS 客户 ID。
companionCreativeIds[]

string (int64 format)

视频广告素材的随播广告素材的 ID。

您可以分配现有的展示广告素材（包含图片或 HTML5 素材资源），以便在发布商的视频播放器周围投放。随播广告会在视频播放时在视频播放器周围展示，并在视频播完后继续展示。

包含“additional dimensions”的广告素材不能作为随播广告素材。

只有以下 creativeType 支持此字段：

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_VIDEO
skippable

boolean

用户能否选择跳过视频广告素材。

只有以下 creativeType 支持此字段：

  • CREATIVE_TYPE_VIDEO
skipOffset

object (AudioVideoOffset)

在“跳过”按钮出现之前，视频的播放时长。

当 skippable 为 true 时，此字段是必填字段。

只有以下 creativeType 支持此字段：

  • CREATIVE_TYPE_VIDEO
progressOffset

object (AudioVideoOffset)

视频播放多长时间后计为一次观看。

当 skippable 为 true 时，此字段是必填字段。

只有以下 creativeType 支持此字段：

  • CREATIVE_TYPE_VIDEO
universalAdId

object (UniversalAdId)

可选。由注册机构提供的可选广告素材标识符，该标识符在所有平台上具有唯一性。

通用广告 ID 是 VAST 4.0 标准的一部分。您可以在创建广告素材后对其进行修改。

只有以下 creativeType 支持此字段：

  • CREATIVE_TYPE_VIDEO
thirdPartyUrls[]

object (ThirdPartyUrl)

使用跟踪网址来跟踪第三方的互动情况，以便跟踪用户与视频广告素材的互动情况。

只有以下 creativeType 支持此字段：

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_VIDEO
  • CREATIVE_TYPE_NATIVE_VIDEO
transcodes[]

object (Transcode)

仅限输出。音频/视频转码。

展示广告与Video 360 会将主素材资源转码为多个使用不同文件格式或具有不同属性（分辨率、音频比特率和视频比特率）的备用版本，各个版本分别适用于特定的视频播放器或带宽。

这些转码为发布商的系统在每次展示您的视频时提供了更多的选择，并确保根据观看者的网络连接状况和屏幕尺寸投放适当的文件。

只有以下 creativeType 支持此字段：

  • CREATIVE_TYPE_VIDEO
  • CREATIVE_TYPE_NATIVE_VIDEO
  • CREATIVE_TYPE_AUDIO
trackerUrls[]

string

分析服务提供商或第三方广告技术供应商的跟踪网址。

这些网址必须以 https 开头（不要求符合 SSL 规定的广告资源除外）。如果要在网址中使用宏，请仅使用 Display &Video 360 支持的宏Video 360。

仅限标准网址，不支持 IMG 或 SCRIPT 代码。

此字段只能在以下 creativeType 中写入：

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
jsTrackerUrl

string

受支持的第三方验证服务提供商（ComScore、DoubleVerify、IAS、Moat）提供的 JavaScript 衡量网址。不支持 HTML 脚本代码。

此字段只能在以下 creativeType 中写入：

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
cmTrackingAd

object (CmTrackingAd)

与广告素材相关联的 Campaign Manager 360 跟踪广告。

如果由同时使用 Campaign Manager 360 和第三方广告投放技术的广告客户创建，则以下 creativeType 是可选的：

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE

仅在其他情况下输出。
obaIcon

object (ObaIcon)

指定视频广告素材的 OBA 图标。

只有以下 creativeType 支持此字段：

  • CREATIVE_TYPE_VIDEO
thirdPartyTag

string

可选。广告素材使用的原始第三方代码。

必需且仅对第三方代码广告素材有效。

第三方代码广告素材是指具有以下 hostingSource 的广告素材：

  • HOSTING_SOURCE_THIRD_PARTY

与以下 creativeType 结合使用：

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE
requireMraid

boolean

可选。指明广告素材需要 MRAID（移动富媒体广告界面定义系统）。

如果广告素材依赖移动手势（例如滑动或点按）进行互动，请设置该属性。

可选且仅对第三方代码广告素材有效。

第三方代码广告素材是指具有以下 hostingSource 的广告素材：

  • HOSTING_SOURCE_THIRD_PARTY

与以下 creativeType 结合使用：

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE
requireHtml5

boolean

可选。表示广告素材需要依靠 HTML5 才能正常呈现。

可选且仅对第三方代码广告素材有效。第三方代码广告素材是指具有以下 hostingSource 的广告素材：

  • HOSTING_SOURCE_THIRD_PARTY

与以下 creativeType 结合使用：

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE
requirePingForAttribution

boolean

可选。表示广告素材将等待返回 ping 进行归因。

仅在将 Campaign Manager 360 跟踪广告与第三方广告服务器参数和 ${DC_DBM_TOKEN} 宏搭配使用时才有效。

可选且仅对第三方代码广告素材或第三方 VAST 代码广告素材有效。

第三方代码广告素材是指具有以下 hostingSource 的广告素材：

  • HOSTING_SOURCE_THIRD_PARTY

与以下 creativeType 结合使用：

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE

第三方 VAST 代码广告素材是指具有以下 hostingSource 的广告素材：

  • HOSTING_SOURCE_THIRD_PARTY

与以下 creativeType 结合使用：

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_VIDEO
expandingDirection

enum (ExpandingDirection)

可选。指定广告素材的展开方向。

必需且仅对第三方展开式广告有效。

第三方展开式广告是指采用以下托管来源的广告素材：

  • HOSTING_SOURCE_THIRD_PARTY

与以下 creativeType 结合使用：

  • CREATIVE_TYPE_EXPANDABLE
expandOnHover

boolean

可选。表示广告素材在悬停时自动展开。

可选且仅对第三方展开式广告有效。第三方展开式广告是指采用以下托管来源的广告素材：

  • HOSTING_SOURCE_THIRD_PARTY

与以下 creativeType 结合使用：

  • CREATIVE_TYPE_EXPANDABLE
vastTagUrl

string

可选。第三方 VAST 代码广告素材的 VAST 代码网址。

必需且仅对第三方 VAST 代码广告素材有效。

第三方 VAST 代码广告素材是指具有以下 hostingSource 的广告素材：

  • HOSTING_SOURCE_THIRD_PARTY

与以下 creativeType 结合使用：

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_VIDEO
vpaid

boolean

仅限输出。表示第三方 VAST 代码广告素材需要 VPAID（数字视频播放器-广告接口）。

仅输出且仅对第三方 VAST 代码广告素材有效。

第三方 VAST 代码广告素材是指具有以下 hostingSource 的广告素材：

  • HOSTING_SOURCE_THIRD_PARTY

与以下 creativeType 结合使用：

  • CREATIVE_TYPE_VIDEO
html5Video

boolean

仅限输出。表示第三方 VAST 代码广告素材需要 HTML5 视频支持。

仅输出且仅对第三方 VAST 代码广告素材有效。

第三方 VAST 代码广告素材是指具有以下 hostingSource 的广告素材：

  • HOSTING_SOURCE_THIRD_PARTY

与以下 creativeType 结合使用：

  • CREATIVE_TYPE_VIDEO
lineItemIds[]

string (int64 format)

仅限输出。与此广告素材相关联的订单项的 ID。

要将广告素材与订单项相关联，请改用 LineItem.creative_ids。
mp3Audio

boolean

仅限输出。表示第三方音频广告素材支持 MP3。

仅限输出且仅对第三方音频广告素材有效。

第三方音频广告素材是指具有以下hostingSource的广告素材：

  • HOSTING_SOURCE_THIRD_PARTY

与以下 creativeType 结合使用：

  • CREATIVE_TYPE_AUDIO
oggAudio

boolean

仅限输出。表示第三方音频广告素材支持 OGG。

仅限输出且仅对第三方音频广告素材有效。

第三方音频广告素材是指具有以下hostingSource的广告素材：

  • HOSTING_SOURCE_THIRD_PARTY

与以下 creativeType 结合使用：

  • CREATIVE_TYPE_AUDIO

HostingSource

广告素材的可能托管来源。表示广告素材的创建和托管位置。

枚举
HOSTING_SOURCE_UNSPECIFIED 未指定或此版本中的托管来源未知。
HOSTING_SOURCE_CM

从 Campaign Manager 360 同步过来的广告素材。

此托管类型不支持创建和更新方法。
HOSTING_SOURCE_THIRD_PARTY

由第三方广告服务器 (3PAS) 托管的广告素材。

如果 creativeType 为以下类型之一，则此托管类型支持创建和更新方法：

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_EXPANDABLE
  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO
HOSTING_SOURCE_HOSTED

在 DV360 中创建并由 Campaign Manager 360 托管的广告素材。

如果 creativeType 为以下类型之一，则此托管类型支持创建和更新方法：

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO
HOSTING_SOURCE_RICH_MEDIA

一种富媒体广告素材，在 Studio 中创建并由 Campaign Manager 360 托管。

此托管类型不支持创建和更新方法。

CreativeAttribute

广告素材的可能属性。

枚举
CREATIVE_ATTRIBUTE_UNSPECIFIED 此版本中的广告素材属性未指定或未知。
CREATIVE_ATTRIBUTE_VAST 该广告素材是一个 VAST 广告素材。
CREATIVE_ATTRIBUTE_VPAID_LINEAR 该广告素材是线性 VPAID 广告素材。
CREATIVE_ATTRIBUTE_VPAID_NON_LINEAR 该广告素材是非线性 VPAID 广告素材。

ReviewStatusInfo

广告素材的审核状态。

JSON 表示法 
{
  "approvalStatus": enum (ApprovalStatus),
  "creativeAndLandingPageReviewStatus": enum (ReviewStatus),
  "contentAndPolicyReviewStatus": enum (ReviewStatus),
  "exchangeReviewStatuses": [
    {
      object (ExchangeReviewStatus)
    }
  ],
  "publisherReviewStatuses": [
    {
      object (PublisherReviewStatus)
    }
  ]
}
字段
approvalStatus

enum (ApprovalStatus)

表示广告素材开始投放所需的基本审批。creativeAndLandingPageReviewStatus 和 contentAndPolicyReviewStatus 的摘要。
creativeAndLandingPageReviewStatus

enum (ReviewStatus)

广告素材的广告素材和着陆页审核状态。
contentAndPolicyReviewStatus

enum (ReviewStatus)

广告素材的内容和政策审核状态。
exchangeReviewStatuses[]

object (ExchangeReviewStatus)

广告素材的广告交易平台审核状态。
publisherReviewStatuses[]

object (PublisherReviewStatus)

广告素材的发布商审核状态。

审批状态

可能的审批状态类型。它是 creativeAndLandingPageReviewStatus 和 contentAndPolicyReviewStatus 的摘要。

枚举
APPROVAL_STATUS_UNSPECIFIED 未指定类型值或此版本中的类型值未知。
APPROVAL_STATUS_PENDING_NOT_SERVABLE 广告素材仍处于审核中，无法投放。
APPROVAL_STATUS_PENDING_SERVABLE 广告素材已通过广告素材传递，并且可投放，但正在等待附加内容和政策审核。
APPROVAL_STATUS_APPROVED_SERVABLE 既有创意，着陆页审核和内容政策审核的批准。广告素材可以投放。
APPROVAL_STATUS_REJECTED_NOT_SERVABLE 广告素材存在问题，您必须先解决此问题，然后才能投放。

ReviewStatus

可能的审核状态类型。

枚举
REVIEW_STATUS_UNSPECIFIED 未指定类型值或此版本中的类型值未知。
REVIEW_STATUS_APPROVED 广告素材已获批准。
REVIEW_STATUS_REJECTED 相应广告素材已被拒。
REVIEW_STATUS_PENDING 广告素材正在等待审核。

ExchangeReviewStatus

广告素材的广告交易平台审核状态。

JSON 表示法 
{
  "exchange": enum (Exchange),
  "status": enum (ReviewStatus)
}
字段
exchange

enum (Exchange)

负责审核广告素材的广告交易平台。
status

enum (ReviewStatus)

广告交易平台审核的状态。

PublisherReviewStatus

广告素材的发布商审核状态。

JSON 表示法 
{
  "publisherName": string,
  "status": enum (ReviewStatus)
}
字段
publisherName

string

审核广告素材的发布商。
status

enum (ReviewStatus)

发布商审核的状态。

AssetAssociation

广告素材的素材资源关联。

JSON 表示法 
{
  "asset": {
    object (Asset)
  },
  "role": enum (AssetRole)
}
字段
asset

object (Asset)

关联的资源。
role

enum (AssetRole)

此资源对广告素材的角色。

素材资源

一项资产。

JSON 表示法 
{
  "mediaId": string,
  "content": string
}
字段
mediaId

string (int64 format)

所上传素材资源的媒体 ID。这是资产的唯一标识符。此 ID 可以传递给其他 API 调用，例如creatives.create，可将素材资源与广告素材相关联。

“媒体 ID”空间已于 2023 年 4 月 5 日更新。通过从关联的广告素材资源检索新的媒体 ID 或重新上传素材资源，更新 2023 年 4 月 5 日之前缓存的媒体 ID。
content

string

资产内容。对于上传的素材资源，内容就是投放路径。

AssetRole

此资源对广告素材的角色。

枚举
ASSET_ROLE_UNSPECIFIED 资产角色未指定或在此版本中未知。
ASSET_ROLE_MAIN 素材资源是广告素材的主要素材资源。
ASSET_ROLE_BACKUP 该资源是广告素材的备用资源。
ASSET_ROLE_POLITE_LOAD 该资源是广告素材的礼让加载资源。
ASSET_ROLE_HEADLINE

原生广告素材的标题。

content 必须采用 UTF-8 编码，且长度不超过 25 个字符。

仅以下creativeType支持此角色：

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_LONG_HEADLINE

原生广告素材的长标题。

content 必须采用 UTF-8 编码，且长度不超过 50 个字符。

仅以下creativeType支持此角色：

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_BODY

原生广告素材的正文。

content 必须采用 UTF-8 编码，且长度不超过 90 个字符。

仅以下creativeType支持此角色：

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_LONG_BODY

原生广告素材的长正文。

content 必须采用 UTF-8 编码，且长度不超过 150 个字符。

仅以下creativeType支持此角色：

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_CAPTION_URL

要在广告素材中显示的简短易记的着陆页网址。此网址可让用户大致知道在点击广告素材后会进入哪个网站。

content 必须采用 UTF-8 编码，且长度不超过 30 个字符。

例如，如果着陆页网址为“http://www.example.com/page”，则图片说明网址可以是“example.com”。协议 (http://) 是可选的，但网址不能包含空格或特殊字符。

仅以下creativeType支持此角色：

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_CALL_TO_ACTION

要在原生广告素材的号召性用语按钮上使用的文字。

content 必须采用 UTF-8 编码，且长度不超过 15 个字符。

仅以下creativeType支持此角色：

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_ADVERTISER_NAME

用于标识广告客户或品牌名称的文字。

content 必须采用 UTF-8 编码，且长度不超过 25 个字符。

仅以下creativeType支持此角色：

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_PRICE

您的应用在 Google Play 商店或 iOS App Store 中的购买价格（例如 $5.99）。

请注意，该值不会自动与应用店中列出的实际值同步。保存广告素材时，系统会始终提供此名称。

content 必须采用 UTF-8 编码，且长度不超过 15 个字符。

此角色的资源是只读的。
ASSET_ROLE_ANDROID_APP_ID

Google Play 商店中 Android 应用的 ID。

您可以在应用的 Google Play 商店网址的“id”后面找到此 ID。例如，在 https://play.google.com/store/apps/details?id=com.company.appname 中，标识符为 com.company.appname。

此角色的资源是只读的。
ASSET_ROLE_IOS_APP_ID

Apple App Store 中 iOS 应用的 ID。

您可以在 Apple App Store 网址中找到此 ID 编号（其形式为“id”后面的一串数字）。例如，在 https://apps.apple.com/us/app/gmail-email-by-google/id422689480 中，ID 为 422689480。

此角色的资源是只读的。
ASSET_ROLE_RATING

Google Play 商店或 iOS App Store 中应用的评分。

请注意，该值不会自动与应用店中的实际评分同步。保存广告素材时，系统会始终提供此名称。

此角色的资源是只读的。
ASSET_ROLE_ICON

广告素材的图标。

只有以下 creativeType 才支持且必须提供此角色：

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
ASSET_ROLE_COVER_IMAGE

原生视频广告素材的封面图片。

只有以下 creativeType 才支持且必须提供此角色：

  • CREATIVE_TYPE_VIDEO

ExitEvent

广告素材的退出事件。

JSON 表示法 
{
  "type": enum (ExitEventType),
  "url": string,
  "name": string,
  "reportingName": string
}
字段
type

enum (ExitEventType)

必需。退出事件的类型。
url

string

必需。退出事件的点击后到达网址。当 type 为以下值时，此属性为必需项：

  • EXIT_EVENT_TYPE_DEFAULT
  • EXIT_EVENT_TYPE_BACKUP
name

string

退出事件的点击代码的名称。

此名称在一个广告素材中必须是唯一的。

对于仅包含图片素材资源的广告素材，请将此字段留空或未设置。
reportingName

string

在报告中用于标识此事件的名称。对于仅包含图片素材资源的广告素材，请将此字段留空或未设置。

ExitEventType

退出事件的类型。

枚举
EXIT_EVENT_TYPE_UNSPECIFIED 未指定或在此版本中未知的退出事件类型。
EXIT_EVENT_TYPE_DEFAULT 退出事件为默认事件。
EXIT_EVENT_TYPE_BACKUP 退出事件是备用退出事件。一个广告素材中可能有多个备用退出事件。

TimerEvent

广告素材的计时器事件。

JSON 表示法 
{
  "name": string,
  "reportingName": string
}
字段
name

string

必需。计时器事件的名称。
reportingName

string

必需。在报告中标识此计时器事件的名称。

CounterEvent

广告素材的计数器事件。

JSON 表示法 
{
  "name": string,
  "reportingName": string
}
字段
name

string

必需。计数器事件的名称。
reportingName

string

必需。用于在报告中标识此计数器事件的名称。

AudioVideoOffset

音频或视频的播放时长。

JSON 表示法 
{

  // Union field offset can be only one of the following:
  "percentage": string,
  "seconds": string
  // End of list of possible types for union field offset.
}
字段
联合字段 offset。偏移的值。offset 只能是下列其中一项：
percentage

string (int64 format)

音频或视频时长的偏移量（以百分比表示）。
seconds

string (int64 format)

与音频或视频开头之间的偏移量（以秒为单位）。

UniversalAdId

由注册机构提供的广告素材标识符，该标识符在所有平台上具有唯一性。这是 VAST 4.0 标准的一部分。

JSON 表示法 
{
  "id": string,
  "registry": enum (UniversalAdRegistry)
}
字段
id

string

广告素材的唯一标识符。
registry

enum (UniversalAdRegistry)

该注册机构会提供唯一广告素材标识符。

UniversalAdRegistry

该注册机构在通用广告 ID 中提供唯一的广告素材标识符。

枚举
UNIVERSAL_AD_REGISTRY_UNSPECIFIED 此版本中的通用广告注册表未指定或未知。
UNIVERSAL_AD_REGISTRY_OTHER 使用自定义提供商提供通用广告 ID。
UNIVERSAL_AD_REGISTRY_AD_ID 使用广告 ID 提供通用广告 ID。
UNIVERSAL_AD_REGISTRY_CLEARCAST 使用 clearcast.co.uk 提供通用广告 ID。
UNIVERSAL_AD_REGISTRY_DV360 使用展示广告系列和Video 360 提供通用广告 ID。
UNIVERSAL_AD_REGISTRY_CM 使用 Campaign Manager 360 提供通用广告 ID。

ThirdPartyUrl

使用跟踪网址来跟踪第三方与音频或视频广告素材的互动情况。

JSON 表示法 
{
  "type": enum (ThirdPartyUrlType),
  "url": string
}
字段
type

enum (ThirdPartyUrlType)

互动类型需要通过跟踪网址跟踪
url

string

用于跟踪互动情况的跟踪网址。

提供带有可选路径或查询字符串的网址，并以 https: 开头。例如 https://www.example.com/path

ThirdPartyUrlType

互动类型需要通过第三方跟踪网址进行跟踪。

枚举
THIRD_PARTY_URL_TYPE_UNSPECIFIED 在此版本中，第三方网址的类型未指定或未知。
THIRD_PARTY_URL_TYPE_IMPRESSION 用于在音频或视频缓冲完毕后统计广告素材的展示次数。
THIRD_PARTY_URL_TYPE_CLICK_TRACKING 用于跟踪用户对音频或视频的点击。
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_START 用于跟踪用户开始播放音频或视频的次数。
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_FIRST_QUARTILE 用于跟踪音频或视频播放到其时长的 25% 的次数。
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_MIDPOINT 用于跟踪音频或视频播放到其时长的 50% 的次数。
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_THIRD_QUARTILE 用于跟踪音频或视频播放至其时长的 75% 的次数。
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_COMPLETE 用于跟踪音频或视频完整播放的次数。
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_MUTE 用于跟踪用户将音频或视频静音的次数。
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_PAUSE 用于跟踪用户暂停音频或视频的次数。
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_REWIND 用于跟踪用户重新播放音频或视频的次数。
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_FULLSCREEN 用于跟踪用户以全屏模式播放内容的次数。
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_STOP 用于跟踪用户停止音频或视频的次数。
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_CUSTOM 用于跟踪用户执行自定义点击（例如，点击视频热点）的次数。
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_SKIP 用于跟踪用户跳过音频或视频的次数。
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_PROGRESS 用于跟踪音频或视频播放到由 progressOffset 确定的偏移量所播放的次数。

转码

表示转码的音频或视频文件的相关信息。

JSON 表示法 
{
  "name": string,
  "mimeType": string,
  "transcoded": boolean,
  "dimensions": {
    object (Dimensions)
  },
  "bitRateKbps": string,
  "frameRate": number,
  "audioBitRateKbps": string,
  "audioSampleRateHz": string,
  "fileSizeBytes": string
}
字段
name

string

已转码文件的名称。
mimeType

string

已转码文件的 MIME 类型。
transcoded

boolean

指明转码是否成功。
dimensions

object (Dimensions)

转码后的视频的尺寸。
bitRateKbps

string (int64 format)

已转码视频的转码比特率（以千比特/秒为单位）。
frameRate

number

已转码视频的帧速率（以每秒帧数为单位）。
audioBitRateKbps

string (int64 format)

已转码视频的音频流或已转码音频的比特率（单位：千比特/秒）。
audioSampleRateHz

string (int64 format)

已转码视频的音频流采样率或转码音频的采样率（以赫兹为单位）。
fileSizeBytes

string (int64 format)

已转码文件的大小（以字节为单位）。

CmTrackingAd

一个 Campaign Manager 360 跟踪广告。

JSON 表示法 
{
  "cmPlacementId": string,
  "cmCreativeId": string,
  "cmAdId": string
}
字段
cmPlacementId

string (int64 format)

Campaign Manager 360 跟踪广告的展示位置 ID。
cmCreativeId

string (int64 format)

Campaign Manager 360 跟踪广告的广告素材 ID。
cmAdId

string (int64 format)

Campaign Manager 360 跟踪广告的广告 ID。

ObaIcon

广告素材的 OBA 图标

JSON 表示法 
{
  "resourceUrl": string,
  "resourceMimeType": string,
  "position": enum (ObaIconPosition),
  "dimensions": {
    object (Dimensions)
  },
  "program": string,
  "landingPageUrl": string,
  "clickTrackingUrl": string,
  "viewTrackingUrl": string
}
字段
resourceUrl

string

OBA 图标资源的网址。
resourceMimeType

string

OBA 图标资源的 MIME 类型。
position

enum (ObaIconPosition)

OBA 图标在广告素材上的位置。
dimensions

object (Dimensions)

OBA 图标的尺寸。
program

string

OBA 图标的计划。例如：“广告选项”。
landingPageUrl

string

必需。OBA 图标的着陆页网址。

只允许使用以下网域的网址：
clickTrackingUrl

string

必需。OBA 图标的点击跟踪网址。

只允许使用以下网域的网址：
viewTrackingUrl

string

必需。OBA 图标的浏览跟踪网址。

只允许使用以下网域的网址：

ObaIconPosition

OBA 图标在广告素材上的位置。

枚举
OBA_ICON_POSITION_UNSPECIFIED 未指定 OBA 图标位置。
OBA_ICON_POSITION_UPPER_RIGHT 位于广告素材的右上方。
OBA_ICON_POSITION_UPPER_LEFT 位于广告素材的左上方。
OBA_ICON_POSITION_LOWER_RIGHT 位于广告素材的右下方。
OBA_ICON_POSITION_LOWER_LEFT 位于广告素材的左下方。

ExpandingDirection

第三方展开式广告的展开方向。

枚举
EXPANDING_DIRECTION_UNSPECIFIED 未指定展开方向。
EXPANDING_DIRECTION_NONE 不会向任何方向展开。
EXPANDING_DIRECTION_UP 可以展开。
EXPANDING_DIRECTION_DOWN 向下展开。
EXPANDING_DIRECTION_LEFT 向左展开。
EXPANDING_DIRECTION_RIGHT 向右展开。
EXPANDING_DIRECTION_UP_AND_LEFT 向上并向左展开。
EXPANDING_DIRECTION_UP_AND_RIGHT 向右侧展开。
EXPANDING_DIRECTION_DOWN_AND_LEFT 向下并向左展开。
EXPANDING_DIRECTION_DOWN_AND_RIGHT 向下并向右展开。
EXPANDING_DIRECTION_UP_OR_DOWN 向上或向下展开。
EXPANDING_DIRECTION_LEFT_OR_RIGHT 扩展到左侧或右侧。
EXPANDING_DIRECTION_ANY_DIAGONAL 可向任何对角方向展开。

方法

create

 创建新的广告素材。

delete

 删除广告素材。

get

 获取广告素材。

list

 列出某个广告客户名下的广告素材。

patch

 更新现有广告素材。