动态广告插播广告连播投放实时 API

借助动态广告插播 API,您可以请求和跟踪 DAI 直播。

服务:dai.google.com

所有 URI 均相对于 https://dai.google.com

方法:stream

方法
stream POST /ssai/pods/api/v1/network/{network_code}/custom_asset/{custom_asset_key}/stream

注册 DAI DAI Pod Serving 直播会话。

HTTP 请求

POST https://dai.google.com/ssai/pods/api/v1/network/{network_code}/custom_asset/{custom_asset_key}/stream

路径参数

参数
network_code string

发布商的 Google Ad Manager 广告资源网代码。

custom_asset_key string

Google Ad Manager 中与此事件关联的自定义标识符。

请求正文

请求正文的类型为 application/x-www-form-urlencoded,包含以下参数:

参数
DFP 定位参数 可选 其他定位参数。
替换视频流参数 可选 替换视频流创建参数的默认值。
HMAC 身份验证 可选 使用基于 HMAC 的令牌进行身份验证。

响应正文

如果成功,响应正文将包含一个新的 Stream 对象。

开放式衡量

DAI API 在 Verifications 字段中包含 Open Measurement 验证信息。此字段包含一个或多个 Verification 元素,这些元素列出了执行第三方衡量代码所需的资源和元数据,以便验证广告素材播放情况。仅支持 JavaScriptResource。如需了解详情,请参阅 IAB Tech LabVAST 4.1 规范

方法:Pod 段

方法
pod segment GET /linear/pods/v1/seg/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}/profile/{profile_name}/{segment_number}.{segment_format}

为指定活动 ID 创建 DAI 直播。

HTTP 请求

GET https://dai.google.com/linear/pods/v1/seg/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}/profile/{profile_name}/{segment_number}.{segment_format}

路径参数

参数
network_code string

发布商的 Google Ad Manager 广告资源网代码。

custom_asset_key string

Google Ad Manager 中与此事件关联的自定义标识符。

pod_identifier

支持以下格式:

pod/{integer}

当前广告插播的数字标识符。系统会为每个广告插播事件分配一个递增的广告连播 ID,从 1 开始。

ad_break_id/{string}

当前广告插播的字符串标识符。发布商提供的广告插播时间点 ID 不受广告连播 ID 的限制。提供给该端点的任何未知广告插播 ID 都会为直播活动创建一个新的广告插播。

profile_name string

所请求的 Google Ad Manager DAI 编码配置文件名称。 编码配置文件必须是所选活动的已配置编码配置文件之一。

segment_number integer

当前广告连播中请求的广告片段的索引,从零开始。

segment_format string

与所请求的片段格式关联的文件扩展名。 接受的扩展名包括:tsmp4vttaacac3eac3

查询参数

参数
stream_id 必需 string

当前用户会话的媒体资源 ID。此值由对 stream 端点的成功请求返回。

sd required1 integer

所请求片段的时长(以毫秒为单位)。

so 可选

所请求的细分在广告连播中的偏移量(以毫秒为单位)。 如果您省略 so 参数,系统会通过将分段时长乘以分段编号来计算该参数。

pd 必需2 integer

广告连播的时长(以毫秒为单位)。

auth-token 必需 string

当前广告插播时间的签名网址编码 HMAC 令牌。

last 可选 boolean

表示广告插播时间点中的最后一个片段。对于所有其他细分,请省略此参数。

scte35 可选 string

相应广告插播时间点的 Base64 编码 SCTE-35 信号。

cust_params 可选 string

一组键值对,用于 Ad Manager 广告系列定位。这些键值对必须表示为经过网址编码的查询字符串。

示例
参数
  • section = sports
  • page = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...

脚注

  1. 初始化分段不需要 sd
  2. 对于启用了无时长广告插播的活动,无需设置 pd

示例

GET https://dai.google.com/linear/pods/v1/seg/network/sandbox_dev/custom_asset/podserving-segredirect-custom-key/ad_break_id/adbreak-2/profile/8b8888cf79ad43f0800482ffc035a1ac_ts_a/1.ts?so=0&sd=10000&pd=30000&stream_id=8e19cbc6-850b-404c-99d7-860aa4a674cb:TEST

GET https://dai.google.com/linear/pods/v1/seg/network/sandbox_dev/custom_asset/podserving-segredirect-custom-key/pod/2/profile/8b8888cf79ad43f0800482ffc035a1ac_ts_a/1.ts?so=0&sd=10000&pd=30000&stream_id=8e19cbc6-850b-404c-99d7-860aa4a674cb:TEST

响应正文

如果成功,响应正文将是可播放的视频流片段,其格式和参数与请求中指定的格式和参数一致。

方法:HLS 广告连播清单

检索已准备就绪的直播 HLS 广告连播清单,以供客户端视频播放器加载和播放。

方法
GET GET /linear/pods/v1/hls/network/{network_code}/custom_asset/{custom_asset}/{pod_identifier}.m3u8;

用于检索广告连播的 HLS 多变体播放列表的 API。

HTTP 请求

GET https://dai.google.com/linear/pods/v1/hls/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}.m3u8?stream_id={stream_id}&pd={pod_duration}

路径参数

参数
network_code string

发布商的 Google Ad Manager 广告资源网代码。

custom_asset_key string

与 Google Ad Manager 中的相应事件相关联的自定义标识符

pod_identifier

支持以下格式:

pod/{integer}

当前广告插播的数字标识符。系统会为每个广告插播事件分配一个递增的广告连播 ID,从 1 开始。

ad_break_id/{string}

当前广告插播的字符串标识符。发布商提供的广告插播时间点 ID 不受广告连播 ID 的限制。提供给该端点的任何未知广告插播 ID 都会为直播活动创建一个新的广告插播。

查询参数

参数
stream_id 必需 string

当前用户会话的媒体资源 ID。此值由对 stream 端点的成功请求返回。

pd 必需 integer

广告连播的时长(以毫秒为单位)。

scte35 可选 string

相应广告插播时间点的 Base64 编码 SCTE-35 信号。

cust_params 可选 string

一组键值对,用于 Ad Manager 广告系列定位。这些键值对必须表示为经过网址编码的查询字符串。

示例
参数
  • section = sports
  • page = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...

响应正文

如果成功,则响应正文为 HLS 多变体播放列表。

方法:DASH 广告连播清单

检索直播的 MPEG-DASH 广告连播清单,该清单已准备就绪,可供客户端视频播放器加载和播放。

方法
GET GET /linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset}/stream/{stream_id}/pod/{pod_id}/manifest.mpd

用于检索广告连播的 MPEG-DASH mpd 播放列表的 API。

HTTP 请求

GET https://dai.google.com/linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/stream/{stream_id}/pod/{pod_id}/manifest.mpd?pd={pod_duration}

路径参数

参数
network_code string

发布商的 Google Ad Manager 广告资源网代码。

custom_asset_key string

与 Google Ad Manager 中的相应事件相关联的自定义标识符

stream_id string

当前用户会话的媒体资源 ID。此值由对 stream 端点的成功请求返回。

pod_id integer

当前广告插播的数字标识符。系统会为每个广告插播事件分配一个递增的广告连播 ID,从 1 开始。

对于当前活动中观看同一广告插播的所有用户,

查询参数

参数
pd 必需 integer

广告连播的时长(以毫秒为单位)。

scte35 可选 string

相应广告插播时间点的 Base64 编码 SCTE-35 信号。

cust_params 可选 string

一组键值对,用于 Ad Manager 广告系列定位。这些键值对必须表示为经过网址编码的查询字符串。

示例
参数
  • section = sports
  • page = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...

响应正文

如果成功,响应正文将是 MPEG-DASH mpd 播放列表。

方法:DASH pod 时间段模板

方法
pods GET /linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/pods.json

从 Google Ad Manager 请求 DASH 时段模板。此模板包含您必须使用自己的数据流参数填充的宏。填充这些宏后,模板将成为您的广告插播时间段,并可缝合到您的 DASH 清单中。

HTTP 请求

GET https://dai.google.com/linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/pods.json

路径参数

参数
network_code string

发布商的 Google Ad Manager 广告资源网代码。

custom_asset_key string

Google Ad Manager 中与此事件关联的自定义标识符。

查询参数

参数
stream_id 必需 string

当前用户会话的媒体资源 ID。此值由对 stream 端点的成功请求返回。

响应正文

如果成功,响应正文将包含一个新的 PodTemplateResponse 对象。

方法:广告连播时间元数据

方法
ad pod timing metadata GET /linear/pods/v1/adv/network/{network_code}/custom_asset/{custom_asset_key}/pod.json

检索广告连播时间元数据。

HTTP 请求

GET https://dai.google.com/linear/pods/v1/adv/network/{network_code}/custom_asset/{custom_asset_key}/pod.json

路径参数

参数
network_code string

发布商的 Google Ad Manager 广告资源网代码。

custom_asset_key string

与 Google Ad Manager 中的相应直播相关联的自定义标识符。

查询参数

参数
stream_id 必需 string

来自客户端视频播放器应用的 Ad Manager 视频流 ID。

ad_break_id 必需 string

下一个即将到来的广告插播时间点 ID。

广告插播 ID 由拼接服务器或 VTP 提供,并且必须在以下各项中保持一致:广告插播提前通知、广告连播时间元数据请求以及同一广告插播的片段重定向请求。

自定义广告插播 ID 存在以下限制:

  • 长度必须介于 1 到 63 个字符之间
  • 只能包含小写字母、数字和连字符。
  • 广告插播 ID preroll 已预留,用于检索前贴片广告连播。它不能用于识别任何其他广告插播时间。
auth-token 必需 string

auth-tokenHMAC 令牌组成,包含以下参数:

  • ad_break_id
  • custom_asset_key
  • exp
  • network_code
  • custom_params
  • pd
  • scte35
timeout 可选 integer

DAI 可以阻止此请求以等待广告决策的毫秒数。对于必须在首次请求时返回填充广告的请求(例如视频广告插播时间),请使用此参数。

如果超出超时时间,请求会返回“待处理”状态。

如果包含,超时值必须介于 1000 到 15000 毫秒之间。如果省略,则不会延迟响应以等待广告决策。

final 可选 boolean

设置为 true,以向 DAI 指示这是 VTP 愿意为此广告连播发出的最后一个请求。如果广告决策在可选的超时时间内仍不可用,DAI 将针对此请求永久返回板岩。

默认为 false

广告决策参数

pd 可选 integer

广告插播时段的时长(以毫秒为单位)。也称为广告插播时长。

如果使用 EABN,pd 值必须与广告插播通知中提供的时长一致。如果时长不一致,系统将优先考虑 EABN 值。

cust_params 可选 string

广告插播时间定位的自定义参数,如 Ad Manager 帮助中心中所述。

scte35 可选 string

采用 base64 编码的 SCTE-35 信号。

如果信号无效,系统会在响应的 X-Ad-Manager-Dai-Warning HTTP 标头中发送一条消息,并且发送请求时不会包含无效的 scte35 值。

响应正文

如果成功,响应正文将包含一个新的 AdPodTimingMetadataResponse 对象。

方法:媒体验证

在播放过程中遇到广告媒体标识符后,立即使用从上述 stream 端点获取的 media_verification_url 发出请求。对于服务器端信标流(服务器会主动进行媒体验证),这些请求不是必需的。

media verification 端点的请求是幂等的。

方法
media verification GET /{media_verification_url}/{ad_media_id}

向 API 通知媒体验证事件。

HTTP 请求

GET https://{media-verification-url}/{ad-media-id}

响应正文

media verification 返回以下响应:

  • 如果媒体验证成功且所有 ping 都已发送,则为 HTTP/1.1 204 No Content
  • 如果请求因网址格式不正确或过期而无法验证媒体,则为 HTTP/1.1 404 Not Found
  • HTTP/1.1 404 Not Found 如果之前针对相应 ID 的验证请求成功完成。
  • 如果此时另一个请求已在发送 ping,则为 HTTP/1.1 409 Conflict

广告媒体 ID

广告媒体标识符将编码在单独的元数据轨道中 - HLS 传输流的定时元数据,或 MP4 文件的 emsg。广告媒体标识符始终以字符串 google_ 开头。

在发出每个广告验证请求之前,应将元数据条目的整个文本内容附加到广告验证网址。

方法:元数据

位于 metadata_url 的元数据端点会返回用于构建广告界面的信息。元数据端点不适用于服务器端信标传送视频流,在这种情况下,服务器负责启动广告媒体验证。

方法
metadata GET /{metadata_url}/{ad-media-id}

GET /{metadata_url}

检索广告元数据信息。

HTTP 请求

GET https://{metadata_url}/{ad-media-id}

GET https://{metadata_url}

响应正文

如果成功,则响应会返回一个 PodMetadata 实例。

解析元数据

元数据包含三个不同的部分:tagsads 和广告 breaks。数据的入口点是 tags 部分。然后,遍历这些标记,找到名称是视频流中找到的广告媒体 ID 的前缀的第一个条目。例如,您可能有一个如下所示的广告媒体 ID:

google_1234567890

然后,您会找到一个名为 google_12345 的标记对象。在这种情况下,它与您的广告媒体 ID 相匹配。找到正确的广告媒体前缀对象后,您可以查找广告 ID、广告插播 ID 和事件类型。然后,使用广告 ID 为 ads 对象编制索引,并使用广告插播 ID 为 breaks 对象编制索引。

响应数据

数据流

Stream 用于以 JSON 格式呈现新创建的直播的资源列表。
JSON 表示法
{
  "stream_id": string,
  "media_verification_url": string,
  "metadata_url": string,
  "session_update_url": string,
  "heartbeat_url": string,
  "polling_frequency": number,
  "pod_manifest_url": string,
  "manifest_format": string,
}
字段
stream_id string

GAM 数据流标识符。
media_verification_url string

用作跟踪播放事件的基本端点的媒体验证网址。
metadata_url string

用于轮询有关即将到来的视频广告活动的定期信息的元数据网址。
session_update_url string

用于更新相应视频流的定位参数的会话更新网址。 系统会在初始视频流创建请求期间捕获定位参数的原始值。
heartbeat_url string

心跳网址,用于保持服务器端信标流处于活动状态,必须每 {PollingFrequency} 秒进行一次 ping 操作。 针对服务器端信标视频流填充。
polling_frequency number

请求 metadata_url 或 heartbeat_url 时的轮询频率(以秒为单位)。
pod_manifest_url string

Pod 清单网址模板用于生成检索视频流的 pod 清单的网址,该网址对应于 HLS 中的多变体播放列表网址或 DASH 中的 MPD。 针对动态广告插播类型为 POD_SERVING_MANIFEST 的直播活动填充。 https://developers.google.com/ad-manager/api/reference/v202305/LiveStreamEventService.DynamicAdInsertionType
manifest_format string

清单格式是从 pod_manifest_url 检索到的清单的格式,可以是 dash 或 hls。

PodMetadata

PodMetadata 包含有关广告、广告插播时间和媒体 ID 标记的元数据信息。
JSON 表示法
{
  "tags": map[string, object(TagSegment)],
  "ads": map[string, object(Ad)],
  "ad_breaks": map[string, object(AdBreak)],
}
字段
tags map[string, object(TagSegment)]

按标记前缀索引的标记段的映射。
ads map[string, object(Ad)]

按广告 ID 编制索引的广告映射。
ad_breaks map[string, object(AdBreak)]

按广告插播 ID 编制索引的广告插播映射。

TagSegment

TagSegment 包含对广告、广告插播和事件类型的引用。 不应向广告媒体验证端点 ping 类型为“progress”的 TagSegment。
JSON 表示法
{
  "ad": string,
  "ad_break_id": string,
  "type": string,
}
字段
ad string

相应广告的 ID。
ad_break_id string

相应标记的广告插播时段的 ID。
type string

相应代码的事件类型。

AdBreak

AdBreak 描述了视频流中的单个广告插播。它包含时长、类型(中贴片/前贴片/后贴片)和广告数量。
JSON 表示法
{
  "type": string,
  "duration": number,
  "expected_duration": number,
  "ads": number,
}
字段
type string

有效的插播类型包括:pre、mid 和 post。
duration number

相应广告插播的总时长(以秒为单位)。
expected_duration number

广告插播时段的预期时长(以秒为单位),包括所有广告和任何可选广告。
ads number

广告插播时段中的广告数量。
Ad 用于描述信息流中的广告。
JSON 表示法
{
  "ad_break_id": string,
  "position": number,
  "duration": number,
  "title": string,
  "description": string,
  "advertiser": string,
  "ad_system": string,
  "ad_id": string,
  "creative_id": string,
  "creative_ad_id": string,
  "deal_id": string,
  "clickthrough_url": string,
  "click_tracking_urls": [],
  "verifications": [object(Verification)],
  "slate": boolean,
  "icons": [object(Icon)],
  "wrappers": [object(Wrapper)],
  "universal_ad_id": object(UniversalAdID),
  "extensions": [],
  "companions": [object(Companion)],
  "interactive_file": object(InteractiveFile),
}
字段
ad_break_id string

相应广告的广告插播时段的 ID。
position number

相应广告在广告插播时段中的位置,从 1 开始。
duration number

广告时长(以秒为单位)。
title string

广告的可选标题。
description string

广告的可选说明。
advertiser string

可选的广告客户标识符。
ad_system string

可选的广告系统。
ad_id string

可选的广告 ID。
creative_id string

可选的广告素材 ID。
creative_ad_id string

可选的广告素材广告 ID。
deal_id string

可选的交易 ID。
clickthrough_url string

可选的点击后到达网址。
click_tracking_urls string

可选的点击跟踪网址。
verifications [object(Verification)]

可选的开放式衡量验证条目,其中列出了执行第三方衡量代码以验证广告素材播放所需的资源和元数据。
slate boolean

可选的布尔值,用于指示当前条目是否为 Slate。
icons [object(Icon)]

图标列表,如果为空则省略。
wrappers [object(Wrapper)]

封装容器的列表,如果为空则省略。
universal_ad_id object(UniversalAdID)

可选的通用广告 ID。
extensions string

VAST 中所有 <Extension> 节点的可选列表。
companions [object(Companion)]

可能会与此广告一起展示的可选随播广告。
interactive_file object(InteractiveFile)

应在广告播放期间展示的可选互动式广告素材 (SIMID)。

PodTemplateResponse

PodTemplateResponse 表示返回给 VTP 以进行 pod 拼接的 JSON 载荷。
JSON 表示法
{
  "dash_period_template": string,
  "segment_duration_ms": int64,
}
字段
dash_period_template string

DashPeriodTemplate 是在拼接之前要填充相应数据的周期的 XML 模板。
segment_duration_ms int64

SegmentDurationMS 是周期细分的时长(以毫秒为单位)。

AdpodTimingMetadataResponse

AdpodTimingMetadataResponse 包含有关广告插播的信息以及如何为其构建分段网址。
JSON 表示法
{
  "status": string,
  "ads": [object(AdRendering)],
  "slate": object(SlateRendering),
  "dash_representations": map[string, object(DASHRepresentation)],
  "dash_adaptation_sets": map[string, object(DASHAdaptationSet)],
}
字段
status string

广告连播的决策状态。
ads [object(AdRendering)]

描述如何呈现广告片段网址的广告对象数组,索引从 0 开始。
slate object(SlateRendering)

用于描述如何呈现 Slate 细分网址的 Slate。
dash_representations map[string, object(DASHRepresentation)]

要在 DASH 清单中呈现的相应广告连播的 DASH 表示形式的列表。
dash_adaptation_sets map[string, object(DASHAdaptationSet)]

要在 DASH 清单中呈现的相应广告插播时段的 DASH 自适应集列表。

AdRendering

AdRendering 描述了如何呈现已做出决策的广告。
JSON 表示法
{
  "duration_ms": number,
  "variants": map[string, object(VariantRendering)],
}
字段
duration_ms number

广告时长(以毫秒为单位,为整数)。
variants map[string, object(VariantRendering)]

变体对象(见下文)的字典,按从界面配置的变体/配置文件 ID 进行索引。

SlateRendering

SlateRendering 描述了如何渲染 Slate 内容。
JSON 表示法
{
  "duration_ms": number,
  "variants": map[string, object(VariantRendering)],
}
字段
duration_ms number

平板电视的持续时间(以毫秒为单位,整数)。
variants map[string, object(VariantRendering)]

以变体/配置文件 ID 为索引的变体对象字典。 必须循环播放广告插片,直到达到所需的广告插片长度,并在迭代之间插入 HLS 不连续性,或者循环播放 MPEG-DASH 的新时段。

VariantRendering

VariantRendering 用于描述广告/插播中的一个变体/配置文件。
JSON 表示法
{
  "segment_extension": string,
  "segment_durations": object(SegmentDurations),
}
字段
segment_extension string

字符串,可以是以下值之一:ts、mp4、aac、ac3、ec3、m4a、m4v。 分段网址的文件扩展名部分。
segment_durations object(SegmentDurations)

SegmentDurations 对象。每个分段时长都可以转换为一个分段网址。

SegmentDurations

SegmentDurations 用于描述一系列片段的时长(以指定的时间单位表示)。
JSON 表示法
{
  "timescale": number,
  "values": [],
}
字段
timescale number

时间尺度是每秒的单位数(整数) 预期值: 对于 HLS 为 1000(毫秒) 对于 DASH 视频为 90000 (PTS) 对于 DASH 音频为音频采样率。
values number

以时间尺度单位表示的 int 型片段时长数组。

DASHRepresentation

DASHRepresentation 用于描述要在 DASH 清单中渲染的 Representation 节点。
JSON 表示法
{
  "codecs": string,
  "bandwidth": number,
  "width": number,
  "height": number,
  "frame_rate": string,
  "audio_sampling_rate": number,
  "audio_channel_config": object(SchemeIDURIAndValue),
}
字段
codecs string

相应表示形式的编解码器。
bandwidth number

相应表示形式的带宽。
width number

表示形式的宽度。
height number

表示形式的高度。
frame_rate string

相应表示的帧速率。
audio_sampling_rate number

表示形式的音频采样率。
audio_channel_config object(SchemeIDURIAndValue)

表示的音频声道配置。

DASHAdaptationSet

DASHAdaptationSet 用于描述要在 DASH 清单中呈现的 AdaptationSet 节点。
JSON 表示法
{
  "content_type": string,
  "mime_type": string,
  "role": object(SchemeIDURIAndValue),
  "inband_event_stream": object(SchemeIDURIAndValue),
  "min_frame_rate": string,
  "max_frame_rate": string,
  "scan_type": string,
  "start_with_sap": string,
  "segment_alignment": boolean,
  "representations": [],
}
字段
content_type string

适应集的 content 类型。
mime_type string

适应集的 MIME 类型。
role object(SchemeIDURIAndValue)

自适应集的角色。
inband_event_stream object(SchemeIDURIAndValue)

自适应集中的带内事件流。
min_frame_rate string

自适应集中的最低帧速率。
max_frame_rate string

自适应集的最大帧速率。
scan_type string

自适应集的扫描类型。
start_with_sap string

从自适应集的 SAP 开始。
segment_alignment boolean

自适应集的细分对齐方式。
representations string

自适应集的表示形式。

SchemeIDURIAndValue

SchemeIDURIAndValue 是一对方案 ID 及其值。
JSON 表示法
{
  "scheme_id_uri": string,
  "value": string,
}
字段
scheme_id_uri string

值的架构 ID URI。
value string

方案 ID URI 的值。

图标

图标包含有关 VAST 图标的信息。
JSON 表示法
{
  "click_data": object(ClickData),
  "creative_type": string,
  "click_fallback_images": [object(FallbackImage)],
  "height": int32,
  "width": int32,
  "resource": string,
  "type": string,
  "x_position": string,
  "y_position": string,
  "program": string,
  "alt_text": string,
}
字段
click_data object(ClickData)

creative_type string

click_fallback_images [object(FallbackImage)]

height int32

width int32

resource string

type string

x_position string

y_position string

program string

alt_text string

ClickData

ClickData 包含有关图标点击后到达页面的信息。
JSON 表示法
{
  "url": string,
}
字段
url string

FallbackImage

FallbackImage 包含有关 VAST 后备图片的信息。
JSON 表示法
{
  "creative_type": string,
  "height": int32,
  "width": int32,
  "resource": string,
  "alt_text": string,
}
字段
creative_type string

height int32

width int32

resource string

alt_text string

Wrapper

封装容器包含有关封装容器广告的信息。如果不存在交易 ID,则不包含交易 ID。
JSON 表示法
{
  "system": string,
  "ad_id": string,
  "creative_id": string,
  "creative_ad_id": string,
  "deal_id": string,
}
字段
system string

广告系统标识符。
ad_id string

用于封装广告的广告 ID。
creative_id string

用于封装容器广告的广告素材 ID。
creative_ad_id string

用于封装容器广告的广告素材广告 ID。
deal_id string

封装广告的可选交易 ID。

验证

验证包含 Open Measurement 的相关信息,有助于进行第三方可见度和验证衡量。 目前仅支持 JavaScript 资源。 请参阅 https://iabtechlab.com/standards/open-measurement-sdk/
JSON 表示法
{
  "vendor": string,
  "java_script_resources": [object(JavaScriptResource)],
  "tracking_events": [object(TrackingEvent)],
  "parameters": string,
}
字段
vendor string

验证服务供应商。
java_script_resources [object(JavaScriptResource)]

用于验证的 JavaScript 资源列表。
tracking_events [object(TrackingEvent)]

验证的跟踪事件列表。
parameters string

传递给引导加载程序验证码的不透明字符串。

JavaScriptResource

JavaScriptResource 包含通过 JavaScript 进行验证的相关信息。
JSON 表示法
{
  "script_url": string,
  "api_framework": string,
  "browser_optional": boolean,
}
字段
script_url string

指向 JavaScript 载荷的 URI。
api_framework string

APIFramework 是执行验证代码的视频框架的名称。
browser_optional boolean

此脚本是否可以在浏览器外部运行。

TrackingEvent

TrackingEvent 包含客户端应在特定情况下 ping 的网址。
JSON 表示法
{
  "event": string,
  "uri": string,
}
字段
event string

跟踪事件的类型。
uri string

要 ping 的跟踪事件。

UniversalAdID

UniversalAdID 用于提供可在各个广告系统中保持不变的唯一广告素材标识符。
JSON 表示法
{
  "id_value": string,
  "id_registry": string,
}
字段
id_value string

所选广告素材的通用广告 ID。
id_registry string

一个字符串,用于标识注册网站的网址,所选广告素材的通用广告 ID 已编入该网站的目录。

随播广告

随播广告包含可能与广告一起展示的随播广告的相关信息。
JSON 表示法
{
  "click_data": object(ClickData),
  "creative_type": string,
  "height": int32,
  "width": int32,
  "resource": string,
  "type": string,
  "ad_slot_id": string,
  "api_framework": string,
  "tracking_events": [object(TrackingEvent)],
}
字段
click_data object(ClickData)

相应随播广告的点击数据。
creative_type string

如果这是静态类型的随播广告,则为 VAST 中 <StaticResource> 节点上的 CreativeType 属性。
height int32

相应随播广告的高度(以像素为单位)。
width int32

相应随播广告的宽度(以像素为单位)。
resource string

对于静态和 iframe 随播广告,此网址将用于加载和显示。对于 HTML 随播广告,此属性将是应作为随播广告展示的 HTML 代码段。
type string

相应随播广告的类型。可以是静态、iframe 或 HTML。
ad_slot_id string

相应随播广告的 slot ID。
api_framework string

相应配套设备的 API 框架。
tracking_events [object(TrackingEvent)]

相应贴片广告的跟踪事件列表。

InteractiveFile

InteractiveFile 包含有关在广告播放期间应显示的互动式广告素材(即 SIMID)的信息。
JSON 表示法
{
  "resource": string,
  "type": string,
  "variable_duration": boolean,
  "ad_parameters": string,
}
字段
resource string

互动式广告素材的网址。
type string

作为资源提供的文件的 MIME 类型。
variable_duration boolean

相应广告素材是否可以请求延长时长。
ad_parameters string

VAST 中 <AdParameters> 节点的值。