用于直播的客户端视频播放器应用

(SSAI) 的直播活动。

借助 Google DAI Pod Serving API,您可以执行由 Google Ads 提供支持的服务器端广告插播,同时保持对自有视频拼接的控制。

本指南将向您介绍如何与 Pod Serving API 互动,以及如何使用 IMA DAI SDK 实现类似的功能。如果您对支持的功能有具体疑问,请与您的 Google 客户经理联系。

Pod Serving API 支持采用 HLS 或 MPEG-DASH 流式传输协议的 Pod Serving 视频流。本指南重点介绍 HLS 流,并在特定步骤中重点说明 HLS 与 MPEG-DASH 之间的主要区别。

如需将 Pod Serving API 集成到您的应用中以用于 VOD 流,请完成以下步骤:

向 DAI Pod Serving API 发出视频流注册请求

向流注册端点发出 POST 请求。您会收到一个 JSON 响应,其中包含要发送到清单操作服务器的视频流 ID 和关联的 Pod Serving API 端点。

API 端点

POST: /ssai/pods/api/v1/network/{network_code}/custom_asset/{custom_asset}/stream
Host: dai.google.com
Content-Type: application/x-www-form-urlencoded

路径参数

{network_code} 您的 Google Ad Manager 360 广告资源网代码
{custom_asset} 与 Google AdManager 中的相应事件相关联的自定义标识符。

采用表单编码的正文参数

一组可选的采用表单编码的 定位参数

响应 JSON

media_verification_url 用于 ping 播放跟踪事件的基础网址。完整的媒体验证网址是通过将广告事件 ID 附加到此基本网址来形成的。
metadata_url 用于请求广告插播时段元数据的网址。
stream_id 用于标识当前流会话的字符串。
valid_for 当前直播会话到期前的剩余时间,以 dhms(天、小时、分钟、秒)格式表示。例如,2h0m0.000s 表示 2 小时的时长。
valid_until 当前流会话的过期时间,采用 yyyy-MM-dd'T'hh:mm:ss.sssssssss[+|-]hh:mm 格式的 ISO 8601 日期时间字符串。

请求示例 (c网址)

curl -X POST \
     -H "Content-Type: application/x-www-form-urlencoded" \
     -d "cust_params=\"section%3Dsports%26page%3Dgolf%2Ctennis\"" \
  https://dai.google.com/ssai/pods/api/v1/network/51636543/custom_asset/ext-doc-ps-redirect-hls/stream

示例响应

{
  "stream_id":"9fe8fe4f-f12e-4fed-b509-0ca269bb1668:TUL",
  "media_verification_url":"https://dai.google.com/.../media/",
  "metadata_url":"https://dai.google.com/.../metadata",
  "session_update_url":"https://dai.google.com/.../session",
  "polling_frequency":10
}

如果出现错误,系统会返回标准 HTTP 错误代码,但不包含 JSON 响应正文。

解析 JSON 响应并存储相关值。

从清单操纵器请求流清单

每个清单操纵器的请求和响应格式都不同。请与机械臂提供商联系,了解他们的具体要求。如果您要实现自己的清单操纵器,请阅读清单操纵器指南,了解此组件的要求。

一般来说,您需要将上述注册端点返回的流 ID 传递给清单操纵器,以便其构建特定于会话的清单。除非清单操纵器明确声明,否则对清单请求的响应是包含内容和广告的视频流。

请求示例 (c网址)

curl https://{manifest_manipulator}/video/1331997/stream/6e69425c-0ac5-43ef-b070-c5143ba68541:CHS/vod_manifest.m3u8

示例响应 (HLS)

#EXTM3U
#EXT-X-MEDIA:TYPE=SUBTITLES,GROUP-ID="subs0",LANGUAGE="en",NAME="English",AUTOSELECT=YES,DEFAULT=YES,URI="abcd1234_     subitles-en.vtt"
#EXT-X-STREAM-INF:BANDWIDTH=5000000,RESOLUTION=1920x1080,CODECS="avc1.42e00a,mp4a.40.2"
abcd1234_video-1080p.m3u8

播放数据流

将从清单操纵服务器收到的清单加载到视频播放器中,然后开始播放。

轮询新的 AdBreak 元数据

应用负责检索每个广告插播时间的元数据,以便了解需要触发哪些展示。为此,您需要设置一个计时器,以定期轮询 DAI API metadata_url,获取新的广告信息。轮询间隔在流注册响应的 polling_frequency 字段中指定。

作为回报,您会收到一个包含以下参数的 JSON 对象:

tags 一组键值对,包含视频流中显示的所有广告事件。键是流的定时元数据中显示的广告事件 ID 的前 17 个字符,如果是 progress 类型的事件,则为完整的广告事件 ID。

每个值都是一个包含以下参数的对象:

ad ads 对象中的某个键匹配的广告的 ID。
ad_break_id ad_breaks 对象中的某个键匹配的广告插播的 ID。
type 广告事件的类型。广告事件类型包括:
start 在广告开始时触发。
firstquartile 在第一个四分位结束时触发。
midpoint 在广告播放到一半时触发。
thirdquartile 在第三四分位结束时触发。
complete 在广告结束时触发。
progress 在整个广告播放期间定期触发,以通知应用正在播放广告插播时段。
ads 一组键值对,用于描述视频流中显示的所有广告。键是与上述 tags 对象中找到的值匹配的广告 ID。每个值都是一个包含以下参数的对象:
ad_break_id ad_breaks 对象中的某个键匹配的广告插播的 ID。
position 相应广告在广告插播时间点内的一组广告中展示的位置,以浮点秒为单位。
duration 广告时长(以浮点秒为单位)。
clickthrough_url 用户与此广告互动时应打开的网址(如果支持)。
ad_breaks 一组键值对,用于描述视频流中显示的所有广告插播时间。 键是与上述 tagsads 对象中找到的值相匹配的广告插播 ID。每个值都是一个包含以下参数的对象:
type 广告插播类型。广告插播时间点类型包括 pre(前贴片广告)、mid(中贴片广告)和 post(后贴片广告)。
duration 广告插播时长(以浮点秒为单位)。
ads 相应广告插播时间点中的广告数量。

在每次轮询后存储这些值,以便将定时元数据事件与视频流相关联。

请求示例 (c网址)

curl https://dai.google.com/.../metadata

示例响应

{
  "tags":{
    "google_5555555555":{
      "ad":"0000229834_ad1",
      "ad_break_id":"0000229834",
      "type":"firstquartile"
    },
    "google_1234567890123456789":{
      "ad":"0000229834_ad1",
      "ad_break_id":"0000229834",
      "type":"progress"
    },
    ...
  },
  "ads":{
    "0000229834_ad1":{
      "ad_break_id":"0000229834",
      "position":1,
      "duration":15,
      "clickthrough_url":"https://.../",
      ...
    },
          ...
  },
  "ad_breaks":{
    "0000229834":{
      "type":"mid",
      "duration":15,
      "ads":1
    },
    ...
  }
}

监听广告事件

通过视频播放器的音频/视频流中触发的广告事件来监听定时元数据。

对于 MPEG-TS 流,元数据以带内 ID3 v2.3 标记的形式显示。每个元数据标记都有 ID TXXX,并且值以字符串 google_ 开头,后跟一系列字符。此值是广告事件 ID

TXXX 中的 XXX 不是占位符。字符串 TXXX 是为“用户定义的文本”预留的 ID3 标记 ID。

ID3 代码示例

TXXXgoogle_1234567890123456789

对于 MP4 流,这些信息会作为带内 emsg 事件发送,以模拟 ID3 v2.3 标记。每个相关的 emsg 框的 scheme_id_uri 值均为 https://aomedia.org/emsg/ID3https://developer.apple.com/streaming/emsg-id3,且 message_data 值以 ID3TXXXgoogle_ 开头。此 message_data 值(不含 ID3TXXX 前缀)是广告事件 ID

示例 emsg box

数据结构可能会因媒体播放器库而异。

如果广告事件 ID 为 google_1234567890123456789,则响应如下所示:

{
  "scheme_id_uri": "https://developer.apple.com/streaming/emsg-id3",
  "presentation_time": 27554,
  "timescale": 1000,
  "message_data": "ID3TXXXgoogle_1234567890123456789",
  ...
}

某些媒体播放器库会自动将模拟 ID3 标记的 emsg 事件呈现为原生 ID3 标记。在这种情况下,MP4 媒体流呈现的 ID3 标记与 MPEG_TS 相同。

更新客户端视频播放器应用的界面

每个广告事件 ID 都可以与第 4 步中的 tags 对象中的某个键匹配。匹配这些值是一个两步过程:

  1. 检查 tags 对象中是否存在与完整广告事件 ID 匹配的键。如果找到匹配项,则检索事件类型及其关联的 adad_break 对象。这些事件的类型应为 progress

    如果找不到与完整广告事件 ID 匹配的项,请检查 tags 对象中是否有与广告事件 ID 的前 17 个字符匹配的键。 检索事件类型以及关联的 adad_break 对象。 这应检索类型不是 progress 的所有事件。

  2. 使用检索到的信息更新玩家的界面。例如,当您收到 start 或第一个 progress 事件时,隐藏播放器的搜索控件,并显示一个叠加层来描述当前广告在广告插播中的位置,例如:“广告 1(共 3 个)”。

示例广告事件 ID

google_1234567890123456789 // Progress event ID
google_5555555555123456789 // First Quartile event ID

示例 tags 对象

{
  "google_5555555555":{
    "ad":"0000229834_ad1",
    "ad_break_id":"0000229834",
    "type":"firstquartile"
  },
  "google_1234567890123456789":{
    "ad":"0000229834_ad1",
    "ad_break_id":"0000229834",
    "type":"progress"
  },
  ...
}

发送媒体验证 ping

每次收到类型不是 progress 的广告事件时,都必须向 Ad Manager 发送媒体验证 ping。

如需生成广告事件的完整媒体验证网址,请将完整广告事件 ID 附加到信息流注册响应中的 media_verification_url 值。

使用完整网址发出 GET 请求。如果验证请求成功,您会收到状态代码为 202 的 HTTP 响应。否则,您会收到 HTTP 错误代码 404

请求示例 (c网址)

curl https://{...}/media/google_5555555555123456789

成功响应示例

HTTP/1.1 202 Accepted

其他资源