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

借助 Dynamic Ad Insert API，您可以请求和跟踪 DAI 直播。

服务：dai.google.com

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

方法：stream

HTTP 请求

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

路径参数

请求正文

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

响应正文

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

开放式衡量

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

方法：广告连播细分

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}

路径参数

查询参数

脚注

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

响应正文

如果成功，响应正文将是一个与请求中指定的格式和参数匹配的可播放流片段。

方法：HLS 广告连播清单

检索直播的 HLS 广告连播清单，以便客户端视频播放器加载和播放。

HTTP 请求

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

路径参数

查询参数

响应正文

如果成功，响应正文将是一个 HLS 多变体播放列表。

方法：DASH 广告连播清单

检索直播的 MPEG-DASH 广告连播清单，以便客户端视频播放器加载和播放。

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}

路径参数

查询参数

响应正文

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

方法：DASH pod 时间段模板

HTTP 请求

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

路径参数

查询参数

响应正文

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

方法：媒体验证

在播放过程中遇到广告媒体标识符后，立即使用上文中从 stream 端点获取的 media_verification_url 发出请求。对于服务器端信标串流（服务器发起媒体验证），这些请求不是必需的。

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

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 的验证请求已成功）。
• HTTP/1.1 409 Conflict，如果此时有其他请求正在发送 ping。

广告媒体 ID

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

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

方法：metadata

位于 metadata_url 的元数据端点会返回用于构建广告界面的信息。元数据端点不适用于服务器端信标串流，在这种情况下，服务器负责发起广告媒体验证。

HTTP 请求

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

GET https://{metadata_url}

响应正文

如果成功，响应将返回一个 PodMetadata 实例。

解析元数据

元数据分为三个部分：tags、ads 和广告 breaks。数据的入口点是 tags 部分。然后，迭代标记，找到名称是视频串流中找到的广告媒体 ID 前缀的第一个条目。例如，您的广告媒体 ID 可能如下所示：

google_1234567890

然后，您会找到一个名为 google_12345 的标记对象。在本例中，它与您的广告媒体 ID 匹配。找到正确的广告媒体前缀对象后，您可以查找广告 ID、广告插播 ID 和事件类型。然后，广告 ID 用于为 ads 对象编制索引，广告插播 ID 用于为 breaks 对象编制索引。

响应数据

数据流

{
  "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,
}

PodMetadata

{
  "tags": map[string, object(TagSegment)],
  "ads": map[string, object(Ad)],
  "ad_breaks": map[string, object(AdBreak)],
}

TagSegment

{
  "ad": string,
  "ad_break_id": string,
  "type": string,
}

AdBreak

{
  "type": string,
  "duration": number,
  "expected_duration": number,
  "ads": number,
}

广告

{
  "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),
}

PodTemplateResponse

{
  "dash_period_template": string,
  "segment_duration_ms": int64,
}

图标

{
  "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

{
  "url": string,
}

FallbackImage

{
  "creative_type": string,
  "height": int32,
  "width": int32,
  "resource": string,
  "alt_text": string,
}

Wrapper

{
  "system": string,
  "ad_id": string,
  "creative_id": string,
  "creative_ad_id": string,
  "deal_id": string,
}

验证

{
  "vendor": string,
  "java_script_resources": [object(JavaScriptResource)],
  "tracking_events": [object(TrackingEvent)],
  "parameters": string,
}

JavaScriptResource

{
  "script_url": string,
  "api_framework": string,
  "browser_optional": boolean,
}

TrackingEvent

{
  "event": string,
  "uri": string,
}

UniversalAdID

{
  "id_value": string,
  "id_registry": string,
}

随播广告

{
  "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)],
}

InteractiveFile

{
  "resource": string,
  "type": string,
  "variable_duration": boolean,
  "ad_parameters": string,
}