动态广告插播 VOD API

借助 Dynamic Ad Insert API，您可以请求和跟踪 DAI 视频点播 (VOD) 在线播放。支持 HLS 和 DASH 流。

服务：dai.google.com

stream 方法的路径是 https://dai.google.com 的相对路径

方法：stream

方法
stream POST /ondemand/v1/hls/content/{content-source}/vid/{video-id}/stream

为指定的内容来源和视频 ID 创建 HLS DAI 视频流。

POST /ondemand/v1/dash/content/{content-source}/vid/{video-id}/stream

为指定的内容来源和视频 ID 创建 DASH DAI 视频流。

HTTP 请求

POST https://dai.google.com/ondemand/v1/hls/content/{content-source}/vid/{video-id}/stream

POST https://dai.google.com/ondemand/v1/dash/content/{content-source}/vid/{video-id}/stream

请求标头

参数
api‑key string

创建视频流时提供的 API 密钥 必须对发布商的广告联盟有效。

可以在请求正文中传递 API 密钥，而不是在请求正文中提供密钥。 HTTP Authorization 标头，格式如下：

Authorization: DCLKDAI key="<api-key>"

路径参数

参数
content-source string

视频流的 CMS ID。

video-id string

视频流的视频 ID。

请求正文

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

参数
dai-ssb 可选

设置为 true 可创建服务器端信标流。 默认值为 false。默认视频流的跟踪指标 由客户端启动，并在服务器端执行 ping 操作。
DFP 定位参数 可选 <ph type="x-smartling-placeholder"></ph> 其他定位参数。
替换数据流参数 可选 <ph type="x-smartling-placeholder"></ph> 替换数据流创建参数的默认值。
HMAC 身份验证 可选 <ph type="x-smartling-placeholder"></ph> 使用基于 HMAC 的令牌进行身份验证。

响应正文

如果成功，响应正文将包含一个新的 Stream。对于服务器端信标流，此 Stream 仅包含 stream_id 和 stream_manifest 字段。

开放式衡量

Verifications 字段包含 Open 针对非服务器端信标数据流的衡量验证。 Verifications 包含一个或多个 Verification 元素，用于列出资源 以及使用第三方衡量代码验证广告素材播放时所需的元数据。 仅支持 JavaScriptResource。如需更多信息 请访问 IAB Tech Lab 以及VAST 4.1 规范

方法：媒体验证

如果在播放过程中遇到广告媒体标识符，请立即 使用 stream 中的 media_verification_url 发出请求 端点。media_verification_url 是绝对路径。 服务器端信标流不需要媒体验证请求， 服务器启动媒体验证。

对 media verification 端点的请求具有幂等性。

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

向 API 发出媒体验证事件的通知。

HTTP 请求

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

响应正文

media verification 会返回以下响应：

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

广告媒体 ID (HLS)

系统将使用 TXXX 键在 HLS 定时元数据中对广告媒体标识符进行编码， 用于“用户定义的文本信息”帧。帧的内容 将不会加密，并且始终以文字 "google_" 开头。

帧的全部文本内容都应附加到 media_verification_url。

广告媒体 ID (DASH)

广告媒体标识符将通过使用 DASH 的 EventStream 元素。

每个 EventStream 的架构 ID URI 都是 urn:google:dai:2018。 这些事件将包含具有 messageData 属性的事件，其中包含 以 “google_” 开头的广告媒体 ID。messageData的全部内容 属性应附加到每个广告的 media_verification_url 中 验证请求。

响应数据

数据流

流用于为新创建的实例呈现所有资源的列表 JSON 格式的数据流 。
JSON 表示法
{
  "stream_id": string,
  "total_duration": number,
  "content_duration": number,
  "valid_for": string,
  "valid_until": string,
  "subtitles": [object(Subtitle)],
  "hls_master_playlist": string,
  "stream_manifest": string,
  "media_verification_url": string,
  "apple_tv": object(AppleTV),
  "ad_breaks": [object(AdBreak)],
}
字段
stream_id string

数据流标识符。
total_duration number

直播时长（以秒为单位）。
content_duration number

不含广告的内容的时长（以秒为单位）。
valid_for string

数据流的有效期，以“00h00m00s”为单位格式。
valid_until string

数据流的有效截止日期（采用 RFC 3339 格式）。
subtitles [object(Subtitle)]

字幕列表。为空时省略。仅限 HLS。
hls_master_playlist string

（已弃用）HLS 主播放列表网址。使用 stream_manifest。仅限 HLS。
stream_manifest string

音频流的清单。对应于 HLS 中的主播放列表和 DASH 中的 MPD。 这是除“stream_id”之外的唯一字段出现的所有情况 创建服务器端信标流。
media_verification_url string

媒体验证网址。
apple_tv object(AppleTV)

特定于 AppleTV 设备的可选信息。仅限 HLS。
ad_breaks [object(AdBreak)]

广告插播列表。为空时省略。

AppleTV

AppleTV 包含 Apple TV 设备特有的信息。
JSON 表示法
{
  "interstitials_url": string,
}
字段
interstitials_url string

插页式广告网址。

AdBreak

AdBreak 描述视频流中的单个广告插播时间点。它包含一个位置 时长、类型（中间/前/后）和广告列表。
JSON 表示法
{
  "type": string,
  "start": number,
  "duration": number,
  "ads": [object(Ad)],
}
字段
type string

有效的广告插播类型包括：插播、前置和后贴片。
start number

在信息流中，广告插播开始的位置（以秒为单位）。
duration number

广告插播时长（以秒为单位）。
ads [object(Ad)]

广告列表。为空时省略。
广告描述的是视频流中的广告。它包含广告在 广告插播时间点、广告的时长以及一些可选的元数据。
JSON 表示法
{
  "seq": number,
  "start": 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,
  "icons": [object(Icon)],
  "wrappers": [object(Wrapper)],
  "events": [object(Event)],
  "verifications": [object(Verification)],
  "universal_ad_id": object(UniversalAdID),
  "companions": [object(Companion)],
  "interactive_file": object(InteractiveFile),
  "skip_metadata": object(SkipMetadata),
}
字段
seq number

广告在广告插播时间点中的位置。
start number

在视频流中开始投放广告的位置（以秒为单位）。
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

可选的点击后到达网址。
icons [object(Icon)]

图标列表，空时省略。
wrappers [object(Wrapper)]

封装容器列表。为空时省略。
events [object(Event)]

广告中事件的列表。
verifications [object(Verification)]

（可选）列出资源的 Open Measurement 验证条目 以及执行第三方衡量代码进行验证所需的元数据 有创意的播放。
universal_ad_id object(UniversalAdID)

可选的通用广告 ID。
companions [object(Companion)]

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

应在广告播放过程中展示的可选互动式广告素材 (SIMID)。
skip_metadata object(SkipMetadata)

可跳过广告的可选元数据。如果设置了此字段，则表示此广告 可跳过，并提供了如何处理跳过界面的说明 和跟踪事件。

事件

事件包含事件类型以及事件的呈现时间。
JSON 表示法
{
  "time": number,
  "type": string,
}
字段
time number

此活动的演示时间。
type string

此事件的类型。

副标题

Subtitle 用于描述视频流的辅助信息文件字幕轨道。它存储 两种字幕格式：TTML 和 WebVTT。TTMLPath 属性包含该网址 添加到 TTML 辅助信息文件，并且 WebVTTPath 属性同样包含一个网址 WebVTT 辅助信息文件。
JSON 表示法
{
  "language": string,
  "language_name": string,
  "ttml": string,
  "webvtt": string,
}
字段
language string

语言代码，例如“en”或“de”。
language_name string

语言的描述性名称。它可以区分 如果有针对同一种语言的多个字幕集，则应提供字幕
ttml string

TTML 辅助信息文件的可选网址。
webvtt string

WebVTT 辅助信息文件（可选）的网址。

SkipMetadata

SkipMetadata 为客户端提供处理可跳过广告的跳过事件所需的信息。
JSON 表示法
{
  "offset": number,
  "tracking_url": string,
}
字段
offset number

偏移值表示播放器播放广告所花费的时间（以秒为单位） 应等待呈现“跳过”按钮。如果 VAST 中未提供，则省略。
tracking_url string

Tracking网址 包含应在发生跳过事件时对其执行 ping 操作的网址。

图标

图标包含有关 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（如果不存在）。
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

<StaticResource> 上的 CreativeType 属性节点中 这是 static 类型的随播广告。
height int32

此随播广告素材的高度（以像素为单位）。
width int32

此随播广告素材的宽度（以像素为单位）。
resource string

对于静态和 iframe 随播广告，这将成为要加载的网址， 。对于 HTML 随播广告，这将成为系统应加载的 HTML 代码段 将显示为随播广告。
type string

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

此随播广告素材的广告位 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

<AdParameters> 的值节点。