动态广告插播连播投放 VOD API

借助动态广告插播 API，您可以请求和跟踪 DAI 点播流。

服务：dai.google.com

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

方法：创建数据流

此方法直接从设备创建流，返回客户端应用播放和跟踪广告以及显示界面元素所需的所有资源。

方法
create stream POST: /ondemand/pods/api/v1/network/{network_code}/stream

创建 DAI pod serving VOD 会话。

HTTP 请求

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

路径参数

参数
network_code string

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

请求正文

请求正文的类型为 application/json，并且必须包含 CreateStreamRequest 对象。

响应正文

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

方法：注册数据流

此方法会在 Google DAI 后端上注册来自设备的视频流，并返回客户端应用跟踪广告和显示界面元素所需的所有资源。与 create stream 方法不同，此方法不会返回可玩广告清单。相反，此操作是通过单独的服务器调用 decision ad pods 来实现的。

方法
register stream POST: /ondemand/pods/api/v1/network/{network_code}/stream_registration

注册 DAI pod serving VOD 会话。

HTTP 请求

POST https://dai.google.com/ondemand/pods/api/v1/network/{network_code}/stream_registration

路径参数

参数
network_code string

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

请求正文

请求正文的类型为 application/json，并且必须包含 StreamRegistrationRequest 对象。

响应正文

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

方法：检索广告连播

此方法遵循来自设备的 register stream 调用，并且是检索可播放广告清单以缝合到内容清单中所必需的。

方法
decision ad pods POST: /ondemand/pods/api/v1/network/{network_code}/streams/{stream_id}/adpods

为 DAI Pod Serving VOD 会话确定广告连播。

HTTP 请求

POST https://dai.google.com/ondemand/pods/api/v1/network/{network_code}/streams/{stream_id}/adpods

路径参数

参数
network_code string

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

stream_id string

从 stream_registration 调用接收的 stream_id。

请求正文

请求正文的类型为 application/json，并且必须包含 AdPodDecisionRequest 对象。

响应正文

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

方法：广告连播元数据

此方法会返回客户端应用跟踪广告并准确呈现相应界面元素所需的所有信息。

方法
ad pods metadata GET: /ondemand/pods/api/v1/network/.../metadata

检索特定会话的广告连播元数据。此网址在 StreamRegistrationResponse metadata_url 属性中返回。

HTTP 请求

GET: /ondemand/pods/api/v1/network/.../metadata

响应正文

如果成功，响应正文会包含一个 Ad pods metadata 对象。

数据

PodMetadata

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

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

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

按广告插播 ID 编制索引的广告插播地图。
polling_frequency number

建议的元数据网址轮询频率（以秒为单位）。 使用“按需”决策填充视频点播流。

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)。

MatchOpts

MatchOpts 用于为视频流指定严格的媒体匹配要求。
JSON 表示法
{
  "audio_channels": boolean,
  "audio_sample_rate": boolean,
}
字段
audio_channels boolean

确保内容和广告的音频通道一致。
audio_sample_rate boolean

使内容和广告的音频采样率保持一致。

CreateStreamRequest

CreateStreamRequest 用于描述向提供 VOD Pod 的 API 发送的 HTTP 请求中包含的信息。视频流创建由 VTP（视频技术合作伙伴）代表 SDK 和发布商为每位用户发起。创建的视频流会生成供 VTP 拼接的获选广告连播。 这与 StreamRegistrationRequest+AdPodDecisionRequest 流不同，后者通过多个请求注册视频流并确定广告插播时间。
JSON 表示法
{
  "encoding_profiles": [object(EncodingProfile)],
  "ad_tag": string,
  "cuepoints": [],
  "manifest_type": string,
  "enable_hls_asset_list": boolean,
  "targeting_parameters": map[string, string],
  "content_duration_seconds": number,
  "decision_timing_options": object(DecisionTimingOptions),
  "enable_inline_manifests": boolean,
  "dai_options": object(CreateStreamOptions),
}
字段
encoding_profiles [object(EncodingProfile)]

编码配置文件列表。必需。
ad_tag string

用于决策的基本广告代码。必需。
cuepoints number

提示点列表（以秒为单位）。 如果广告代码的响应使用位置时间偏移量，则必须提供此参数。
manifest_type string

有效的清单类型包括：hls 和 dash。默认值：hls。可选。
enable_hls_asset_list boolean

指示是否已启用 HLS 资源列表插页式广告。 启用后，DAI 将为每个广告插播时间返回素材资源列表网址，这些网址可用于 HLS 插播广告。
targeting_parameters string

其他 Ad Manager 定位参数。可选。
content_duration_seconds number

ContentDurationSeconds 是内容时长（以秒为单位）。 如果广告代码的响应使用百分比时间偏移量，则必须提供此参数。
decision_timing_options object(DecisionTimingOptions)

用于指明何时应做出广告连播决策。
enable_inline_manifests boolean

指示是否应在 JSON 响应中内嵌插播广告清单。
dai_options object(CreateStreamOptions)

用于创建流的 DAIOptions。

CreateStreamOptions

CreateStreamOptions 表示一步式视频流创建工作流中可用的选项。
JSON 表示法
{
  "dash_profile": string,
  "match_options": object(MatchOpts),
  "data_sharing_policy_code": string,
  "sam_id": string,
  "session_title": string,
  "dash_inband_event_stream": boolean,
  "distinct_ad_profiles": boolean,
  "tracking_mode": string,
  "emsg_version": uint32,
}
字段
dash_profile string

要使用的 MPEG-DASH 配置文件，可以是“直播”或“点播”。
match_options object(MatchOpts)

data_sharing_policy_code string

允许发布商替换广告资源网的默认数据共享政策。
sam_id string

sam_id 是会话的 SAM 调试密钥，可选。
session_title string

session_title 是直播的 SAM 会话标题，可选。
dash_inband_event_stream boolean

dash_inband_event_stream 表示 DAI 使用 InbandEventStream 元素将 ID3 消息作为带内事件（媒体内）插入，而不是作为 EventStream 元素（清单内）插入。
distinct_ad_profiles boolean

如果设置为 true，则表示服务器在匹配所请求的编码配置文件时，最多会使用一次任何可用的广告配置文件。
tracking_mode string

tracking_mode 是要用于视频流的广告跟踪类型，可选。 有效值包括：'ad_media'、'server'、'client'。
emsg_version uint32

emsg_version 会强制使用特定的 emsg 版本来处理媒体内 ID3。 仅当 dash_inband_event_stream 为 true 时受支持。

StreamRegistrationRequest

StreamRegistrationRequest 用于注册来自设备的视频流，以供日后进行广告插播决策。这与 CreateStreamRequest 不同，后者可在单个请求中创建视频流并确定广告插播时间。
JSON 表示法
{
  "targeting_parameters": map[string, string],
  "dai_options": object(StreamRegistrationOptions),
}
字段
targeting_parameters string

其他 Ad Manager 定位参数。可选。
dai_options object(StreamRegistrationOptions)

用于流注册的 DAIOptions。

StreamRegistrationOptions

StreamRegistrationOptions 列出了可用于创建数据流的选项
JSON 表示法
{
  "sam_id": string,
  "tracking_mode": string,
  "emsg_version": uint32,
  "skippable_ads_supported": boolean,
}
字段
sam_id string

sam_id 是会话的 SAM 调试密钥，可选。
tracking_mode string

tracking_mode 是要用于视频流的广告跟踪类型，可选。 有效值包括：'ad_media'、'server'、'client'。
emsg_version uint32

emsg_version 会强制使用特定的 emsg 版本来处理媒体内 ID3。 仅当 dash_inband_event_stream 为 true 时受支持。
skippable_ads_supported boolean

指示是否支持可跳过的广告。

StreamRegistrationResponse

StreamRegistrationResponse 表示发送回客户端的 JSON 响应，以响应 StreamRegistrationRequest。它包含直播 ID 和设备所需的所有网址。后续的广告插播时间决策请求可以引用该视频流 ID。这与 CreateStreamResponse 不同，后者表示同时创建流和做出广告插播时间决策的响应。
JSON 表示法
{
  "stream_id": string,
  "media_verification_url": string,
  "valid_for": string,
  "valid_until": string,
  "metadata_url": string,
}
字段
stream_id string

StreamID 是相应观看者当前观看的直播的唯一标识符。
media_verification_url string

MediaVerification网址 是要在下述广告媒体验证请求中使用的网址前缀。对于客户端信标视频流，此属性不存在。
valid_for string

ValidFor 是相应直播的有效时长，采用“00h00m00s”格式。
valid_until string

ValidUntil 是相应直播的有效截止日期和时间。
metadata_url string

Metadata网址 是用于请求广告插播元数据的元数据网址。

DecisionTimingOptions

DecisionTimingOptions 用于描述为视频流做出广告插播时机决策的时机选项。
JSON 表示法
{
  "type": string,
  "on_create_breaks": [],
}
字段
type string

Type 描述了何时为视频流确定广告插播时间。 有效类型包括：on_create（默认）、on_demand。 如果类型为 on_demand，则在请求特定插播时间的清单时，系统会延迟做出广告决策。 如果类型为 on_create，则会在创建视频流时确定所有广告。
on_create_breaks string

OnCreateBreaks 是一个区分大小写的 VMAP breakID 列表，应在创建流时做出相应决策。 只有当类型为 on_demand 时，才允许使用此字段。特殊广告插播标识符“preroll”和“postroll”可用于指示应在创建流时确定前贴片广告插播或后贴片广告插播。

EncodingProfile

EncodingProfile 用于描述单个内容变体的编码。 它可以仅包含视频设置、仅包含音频设置（如果是媒体类型）、同时包含视频和音频设置，或者在字幕的情况下不包含任何设置。
JSON 表示法
{
  "profile_name": string,
  "type": string,
  "container_type": string,
  "video_settings": object(VideoSettings),
  "audio_settings": object(AudioSettings),
  "subtitle_settings": object(SubtitleSettings),
}
字段
profile_name string

发布商为配置文件提供的名称。每个信息流不得重复。必需。
type string

有效类型包括：media、iframe、subtitles。必需。
container_type string

有效类型包括：mpeg2ts、fmp4cmaf 和 hls_packed_audio。 对于媒体和 iframe 类型是必需的。
video_settings object(VideoSettings)

如果容器类型为 iframe，则必须提供视频设置。 否则，仅当个人资料包含视频时，才会显示这些按钮。
audio_settings object(AudioSettings)

如果配置文件包含音频，则会显示音频设置。 只有当容器类型为媒体时，才允许使用音频设置。
subtitle_settings object(SubtitleSettings)

“输入”字幕需要提供字幕设置。

VideoSettings

VideoSettings 用于描述编码配置文件的视频。 如果存在一个视频设置，则必须存在所有视频设置。
JSON 表示法
{
  "codec": string,
  "bitrate": int32,
  "frames_per_second": number,
  "resolution": object(Resolution),
}
字段
codec string

视频的 RFC6381 编解码器字符串。
bitrate int32

编码配置文件的最大视频比特率。
frames_per_second number

视频的每秒帧数。
resolution object(Resolution)

视频的宽度 x 高度分辨率。

AudioSettings

AudioSettings 用于描述编码配置文件的音频。 如果存在一个音频设置，则必须存在所有音频设置。
JSON 表示法
{
  "codec": string,
  "bitrate": int32,
  "channels": int32,
  "sample_rate": int64,
}
字段
codec string

音频的 RFC6381 编解码器字符串。
bitrate int32

编码配置文件的最大音频比特率。
channels int32

音频声道的数量（包括低频声道）。
sample_rate int64

音频的采样率（以赫兹为单位）。

SubtitleSettings

SubtitleSettings 用于描述编码配置文件的字幕。
JSON 表示法
{
  "format": string,
  "language": string,
}
字段
format string

字幕的格式：hls 为 webvtt，dash 为 webvtt 或 ttml。
language string

要插入到清单中的语言。

分辨率

分辨率描述的是视频的宽度 x 高度。
JSON 表示法
{
  "width": int32,
  "height": int32,
}
字段
width int32

视频的宽度，以像素为单位。必需。
height int32

视频的高度，以像素为单位。必需。

AdPodDecisionRequest

AdPodDecisionRequest 表示针对之前注册的视频流做出广告连播决策的请求。
JSON 表示法
{
  "encoding_profiles": [object(EncodingProfile)],
  "ad_tag": string,
  "cuepoints": [],
  "manifest_type": string,
  "enable_hls_asset_list": boolean,
  "targeting_parameters": map[string, string],
  "content_duration_seconds": number,
  "decision_timing_options": object(DecisionTimingOptions),
  "enable_inline_manifests": boolean,
  "dai_options": object(AdPodDecisionOptions),
}
字段
encoding_profiles [object(EncodingProfile)]

编码配置文件列表。必需。
ad_tag string

用于决策的基本广告代码。必需。
cuepoints number

提示点列表（以秒为单位）。 如果广告代码的响应使用位置时间偏移量，则必须提供此参数。
manifest_type string

有效的清单类型包括：hls 和 dash。默认值：hls。可选。
enable_hls_asset_list boolean

指示是否已启用 HLS 资源列表插页式广告。 启用后，DAI 将为每个广告插播时间返回素材资源列表网址，这些网址可用于 HLS 插播广告。
targeting_parameters string

其他 Ad Manager 定位参数。可选。
content_duration_seconds number

ContentDurationSeconds 是内容时长（以秒为单位）。 如果广告代码的响应使用百分比时间偏移量，则必须提供此参数。
decision_timing_options object(DecisionTimingOptions)

用于指明何时应做出广告连播决策。
enable_inline_manifests boolean

指示是否应在 JSON 响应中内嵌插播广告清单。
dai_options object(AdPodDecisionOptions)

用于广告连播决策的 DAIOptions。

AdPodDecisionResponse

AdPodDecisionResponse 表示对之前注册的视频流做出广告连播决策的响应。它包含相应视频流的广告连播决策列表。
JSON 表示法
{
  "valid_for": string,
  "valid_until": string,
  "ad_pods": [object(AdPod)],
}
字段
valid_for string

ValidFor 是相应直播的有效时长，采用“00h00m00s”格式。
valid_until string

ValidUntil 是相应直播的有效截止日期和时间。
ad_pods [object(AdPod)]

按插播顺序排序的广告连播列表。

CreateStreamResponse

CreateStreamResponse 表示发送回客户端的 JSON 响应，以响应 CreateStreamRequest。
JSON 表示法
{
  "valid_for": string,
  "valid_until": string,
  "ad_pods": [object(AdPod)],
  "stream_id": string,
  "media_verification_url": string,
  "pod_metadata": object(PodMetadata),
  "metadata_url": string,
}
字段
valid_for string

ValidFor 是相应直播的有效时长，采用“00h00m00s”格式。
valid_until string

ValidUntil 是相应直播的有效截止日期和时间。
ad_pods [object(AdPod)]

按插播顺序排序的广告连播列表。
stream_id string

StreamID 是相应观看者当前观看的直播的唯一标识符。
media_verification_url string

MediaVerification网址 是要在下述广告媒体验证请求中使用的网址前缀。对于客户端信标视频流，此属性不存在。
pod_metadata object(PodMetadata)

PodMetadata 包含在设备上呈现 pod 并触发验证所需的额外信息。 如动态广告插播线性 API 文档中所述。仅包含在客户端信标视频流中。
metadata_url string

Metadata网址 是用于请求广告插播元数据的元数据网址。

AdPod

AdPod 表示已做出投放决策且可供播放的广告插播时间点。
JSON 表示法
{
  "manifest_uris": map[string, string],
  "multivariant_uri": string,
  "mpd_uri": string,
  "manifests": map[string, string],
  "multivariant_manifest": string,
  "mpd_manifest": string,
  "asset_list_uri": string,
  "start": number,
  "duration": number,
  "type": string,
  "midroll_index": number,
}
字段
manifest_uris string

ManifestURIs 是一个从编码配置文件名称到 HLS 变体 manifest_uris 的映射，用于 HLS 内容。
multivariant_uri string

MultivariantURI 是 HLS 内容的多变体清单的 URI。
mpd_uri string

MPDURI 是 DASH 内容的 MPD 的 URI。
manifests string

Manifests 是一个从编码配置文件名称到 HLS 变体清单的映射。 仅当流的 enable_inline_manifests 设置为 true 时填充。
multivariant_manifest string

MultivariantManifest 是 HLS 内容的多变体清单。 仅当流的 enable_inline_manifests 设置为 true 时填充。
mpd_manifest string

MPDManifest 是 DASH 内容的 MPD 清单。 仅当流的 enable_inline_manifests 设置为 true 时填充。
asset_list_uri string

AssetListURI 是 HLS 内容的 HLS 插播广告资源列表的 URI。 仅当直播启用了 HLS 资产列表插播广告时填充。
start number

广告连播在素材资源时间轴中的开始时间（不包括前面的广告连播），以浮点秒表示。
duration number

广告连播的时长（以浮点秒为单位）。
type string

广告插播类型。
midroll_index number

视频流中贴片广告的从 1 开始的索引，基于 VMAP 广告插播 ID。 前贴片广告和后贴片广告已省略此属性。

AdPodDecisionOptions

AdPodDecisionOptions 表示视频流的其他选项。
JSON 表示法
{
  "dash_profile": string,
  "match_options": object(MatchOpts),
  "data_sharing_policy_code": string,
  "sam_id": string,
  "session_title": string,
  "dash_inband_event_stream": boolean,
  "distinct_ad_profiles": boolean,
}
字段
dash_profile string

要使用的 MPEG-DASH 配置文件，可以是“直播”或“点播”。
match_options object(MatchOpts)

data_sharing_policy_code string

允许发布商替换广告资源网的默认数据共享政策。
sam_id string

sam_id 是会话的 SAM 调试密钥，可选。
session_title string

session_title 是直播的 SAM 会话标题，可选。
dash_inband_event_stream boolean

dash_inband_event_stream 表示 DAI 使用 InbandEventStream 元素将 ID3 消息作为带内事件（媒体内）插入，而不是作为 EventStream 元素（清单内）插入。
distinct_ad_profiles boolean

如果设置为 true，则表示服务器在匹配所请求的编码配置文件时，最多会使用一次任何可用的广告配置文件。

数据流

流用于以 JSON 格式呈现新创建的流的所有资源的列表。
JSON 表示法
{
  "stream_id": string,
  "valid_for": string,
  "valid_until": string,
  "media_verification_url": string,
}
字段
stream_id string

数据流标识符。
valid_for string

有效时长，采用“00h00m00s”格式。
valid_until string

数据流的有效截止日期，采用 RFC 3339 格式。
media_verification_url string

媒体验证网址。

图标

图标包含有关 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> 节点的值。