使用 Video Stitcher API 时,您可以在每次开始播放直播时创建一个实时会话,在该直播中,Google Ad Manager 投放的广告会在广告插播期间进行动态拼接。响应会指定实时会话的播放网址和配置。
本文档介绍了如何创建和管理实时会话。如需了解详情,请参阅 REST 文档。
准备工作
- 创建实时配置。为了与 Google Ad Manager 集成,请确保已设置
gamLiveConfig
对象。 - 如果您要指定可选广告,请确保在您注册的可选广告上设置
gamSlate
对象。
创建实时会话
如需直接使用 API 创建实时会话,请使用 projects.locations.liveSessions.create
方法。
liveConfig
字段是 JSON 正文中唯一的必填字段。您可以为每个实时会话设置或替换以下可选参数(如以下 REST 示例所示):
manifestOptions
:指定在拼接视频清单中生成哪些视频呈现方式以及呈现顺序;请参阅清单选项文档adTracking
:选择客户端广告跟踪或服务器端广告跟踪;这会替换会话实时配置中的值targetingParameters
:Google Ad Manager 广告代码可以包含可根据会话更新的定位参数;请在此字段中提供映射(例如,要将[my_key]
宏替换为字符串my_value
,请参阅 REST 示例)
REST
在使用任何请求数据之前,请先进行以下替换:
PROJECT_NUMBER
:您的 Google Cloud 项目编号(位于 IAM 设置页面的项目编号字段中)LOCATION
:要在其中创建会话的位置;请使用某个受支持的区域显示位置us-central1
us-east1
us-west1
asia-east1
asia-south1
asia-southeast1
europe-west1
southamerica-east1
LIVE_CONFIG_ID
:实时配置的用户定义标识符
如需发送您的请求,请展开以下选项之一:
您应该收到类似以下内容的 JSON 响应:
{ "name": "projects/PROJECT_NUMBER/locations/LOCATION/liveSessions/SESSION_ID", "playUri": "PLAY_URI", "manifestOptions": { "includeRenditions": [ { "bitrateBps": 150000, "codecs": "hvc1.1.4.L126.B0" }, { "bitrateBps": 440000, "codecs": "hvc1.1.4.L126.B0" } ], "bitrateOrder": "DESCENDING" }, "gamSettings": { "streamId": "STREAM_ID" }, "liveConfig": "projects/PROJECT_NUMBER/locations/LOCATION/liveConfigs/LIVE_CONFIG_ID", "adTracking": "SERVER" }
C#
在试用此示例之前,请按照 Video Stitcher API 快速入门:使用客户端库中的 C# 设置说明进行操作。 如需了解详情,请参阅 Video Stitcher API C# API 参考文档。
如需向 Video Stitcher API 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Go
在试用此示例之前,请按照 Video Stitcher API 快速入门:使用客户端库中的 Go 设置说明进行操作。 如需了解详情,请参阅 Video Stitcher API Go API 参考文档。
如需向 Video Stitcher API 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Java
在试用此示例之前,请按照 Video Stitcher API 快速入门:使用客户端库中的 Java 设置说明进行操作。 如需了解详情,请参阅 Video Stitcher API Java API 参考文档。
如需向 Video Stitcher API 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Node.js
在试用此示例之前,请按照 Video Stitcher API 快速入门:使用客户端库中的 Node.js 设置说明进行操作。 如需了解详情,请参阅 Video Stitcher API Node.js API 参考文档。
如需向 Video Stitcher API 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
PHP
在试用此示例之前,请按照 Video Stitcher API 快速入门:使用客户端库中的 PHP 设置说明进行操作。 如需了解详情,请参阅 Video Stitcher API PHP API 参考文档。
如需向 Video Stitcher API 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Python
在试用此示例之前,请按照 Video Stitcher API 快速入门:使用客户端库中的 Python 设置说明进行操作。 如需了解详情,请参阅 Video Stitcher API Python API 参考文档。
如需向 Video Stitcher API 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Ruby
在试用此示例之前,请按照 Video Stitcher API 快速入门:使用客户端库中的 Ruby 设置说明进行操作。 如需了解详情,请参阅 Video Stitcher API Ruby API 参考文档。
如需向 Video Stitcher API 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Video Stitcher API 会为每个请求生成唯一的会话 ID。如果过去 5 分钟内未请求 playUri
,会话将过期。
您可以使用返回的 STREAM_ID
来检查实时会话。
检查 Google Ad Manager 启用的实时会话
若要查看会话的广告代码详情,请使用 Ad Manager 中的视频流活动监控工具来查看有关广告请求的详细信息。您可以使用 STREAM_ID
调试流会话。如需查找直播会话的 STREAM_ID
,请参阅获取会话。