REST Resource: advertisers.creatives

资源：Creative

单个广告素材。

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,
  "syntheticContentAttestationStatus": enum (SyntheticContentAttestationStatus)
}
字段
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)

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

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不进行“Z”归一化处理的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
createTime

string (Timestamp format)

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

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不进行“Z”归一化处理的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
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)

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

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

这些转码文件可为发布商的系统提供更多选择，以便为视频的每次展示选择最合适的文件，并确保根据观看者的网络连接和屏幕大小投放合适的文件。

此字段仅在以下 creativeType中受支持：

  • CREATIVE_TYPE_VIDEO
  • CREATIVE_TYPE_NATIVE_VIDEO
  • CREATIVE_TYPE_AUDIO
trackerUrls[]

string

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

此类网址必须以 https: 开头（无需符合 SSL 规定的广告资源除外）。如果想在此类网址中使用宏，请仅使用 Display & 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
syntheticContentAttestationStatus

enum (SyntheticContentAttestationStatus)

可选。在有本地 AI 标签法规的地区投放时，是否为广告素材添加标签，指明其由 AI 创建或修改。

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)
    }
  ]
}
字段
approvalStatus

enum (ApprovalStatus)

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

enum (ReviewStatus)

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

enum (ReviewStatus)

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

object (ExchangeReviewStatus)

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

审批状态

可能的审批状态类型。它是 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)

广告交易平台审核状态。

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 应用商店中的购买价格（例如 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

iOS 应用在 Apple 应用商店中的 ID。

此 ID 编号可在 Apple 应用商店网址中找到，即紧跟在“id”后面的数字字符串。例如，在 https://apps.apple.com/us/app/gmail-email-by-google/id422689480 中，ID 为 422689480。

此角色的资产为只读。
ASSET_ROLE_RATING

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

请注意，此值不会自动与商店中的实际评分同步。它始终是保存广告素材时提供的那个。

此角色的资产为只读。
ASSET_ROLE_ICON

广告素材的图标。

只有以下 creativeType 支持且需要此角色：

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
ASSET_ROLE_COVER_IMAGE

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

只有以下 creativeType 支持且需要此角色：

  • CREATIVE_TYPE_VIDEO
ASSET_ROLE_BACKGROUND_COLOR

广告素材中使用的主要颜色。

只有以下 creativeType 支持且需要此角色：

  • CREATIVE_TYPE_ASSET_BASED_CREATIVE
ASSET_ROLE_ACCENT_COLOR

广告素材中使用的强调色。

只有以下 creativeType 支持且需要此角色：

  • CREATIVE_TYPE_ASSET_BASED_CREATIVE
ASSET_ROLE_REQUIRE_IMAGE

广告素材是否必须使用图片素材资源。

只有以下 creativeType 支持且需要此角色：

  • CREATIVE_TYPE_ASSET_BASED_CREATIVE
ASSET_ROLE_ENABLE_ASSET_ENHANCEMENTS

是否可以对广告素材应用素材资源自动美化功能。

只有以下 creativeType 支持且需要此角色：

  • CREATIVE_TYPE_ASSET_BASED_CREATIVE

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 表示法 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "percentage": string,
  "seconds": string
  // End of mutually exclusive fields.
}
字段
偏移量的值。以下是互斥字段的列表。在响应中，最多只能设置其中一个字段：
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 使用 Ad-ID 提供通用广告 ID。
UNIVERSAL_AD_REGISTRY_CLEARCAST 使用 clearcast.co.uk 提供通用广告 ID。
UNIVERSAL_AD_REGISTRY_DV360 使用 Display & 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)

可选。转码视频的转码比特率，以 kbps 为单位。
frameRate

number

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

string (int64 format)

可选。转码后视频的音频串流比特率，或转码后音频的比特率（以 kbps 为单位）。
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 图标的着陆页网址。

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

  • https://info.evidon.com
  • https://l.betrad.com
clickTrackingUrl

string

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

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

  • https://info.evidon.com
  • https://l.betrad.com
viewTrackingUrl

string

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

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

  • https://info.evidon.com
  • https://l.betrad.com

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

 更新现有广告素材。