使用 Video Stitcher API 时,您需要在每次动态插入广告后,再将广告投放到客户端设备,从而创建视频点播 (VOD) 会话。创建会话后,响应会包含播放网址以及您插入视频的广告的相关信息。
本页面介绍了如何创建和管理未通过 Google Ad Manager 启用的 VOD 会话。如需详细了解这些类型的 VOD 会话,请参阅管理由 Google Ad Manager 启用的 VOD 会话。
准备工作
创建会话
如需为拼接广告的视频创建会话,请使用 projects.locations.vodSessions.create 方法。
创建 VOD 会话时,需要提供以下字段:
adTracking:确定客户端播放器是否应触发播放和活动事件,或者 Video Stitcher API 是否应代表客户端播放器触发播放事件;如需详细了解客户端广告跟踪,请参阅处理 VOD 客户端广告跟踪。本部分中的示例使用服务器端广告跟踪。
创建 VOD 会话时,以下字段是可选的:
adTagMacroMap:用于广告代码宏替换的键值对列表;请参阅广告代码宏部分manifestOptions:指定在拼接视频清单中生成哪些视频转码版本以及这些转码版本的顺序;请参阅清单选项文档
REST
在使用任何请求数据之前,请先进行以下替换:
PROJECT_NUMBER:IAM 设置页面上项目编号字段中显示的 Google Cloud 项目编号LOCATION:用于创建会话的位置;请使用某个受支持的地区显示位置us-central1us-east1us-west1asia-east1asia-south1asia-southeast1europe-west1southamerica-east1
VOD_CONFIG_ID:用户定义的视频点播配置标识符
如需发送您的请求,请展开以下选项之一:
您应该收到类似以下内容的 JSON 响应:
{
"name": "projects/PROJECT_NUMBER/locations/LOCATION/vodSessions/SESSION_ID",
"interstitials": {
"sessionContent": {
"duration": "60s"
}
},
"playUri": "PLAY_URI", # This is the ad-stitched VOD URI
"sourceUri": "VOD_URI",
"adTagUri": "AD_TAG_URI",
"assetId": "ASSET_ID",
"adTracking": "SERVER",
"vodConfig": "projects/PROJECT_NUMBER/locations/LOCATION/vodConfigs/VOD_CONFIG_ID"
}
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 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为本地开发环境设置身份验证。
Python
在试用此示例之前,请按照《Video Stitcher API 快速入门:使用客户端库》中的 Python 设置说明进行操作。 如需了解详情,请参阅 Video Stitcher API Python API 参考文档。
如需向 Video Stitcher API 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为本地开发环境设置身份验证。
Video Stitcher API 会为每个请求生成唯一的会话 ID。会话会在 4 小时后过期。
必须先对广告进行编码,然后才能将其拼接至 VOD 会话中。当您为拼接广告的视频创建会话时,Video Stitcher API 会确定广告是否已在之前的会话中编码。如果已设置,JSON 响应将指示广告插播事件。该 API 仅查找与您的 Google Cloud 项目关联的会话创建的已编码广告。如需详细了解此流程,请参阅概览。
查看 JSON 响应。此响应表示广告未缝合到会话中。如果出现这种情况,请等待 5 分钟(用于广告编码),然后重新运行创建会话命令。响应现在应类似于以下内容:
{
"name": "projects/PROJECT_NUMBER/locations/LOCATION/vodSessions/SESSION_ID",
"interstitials": {
"adBreaks": [
{
"progressEvents": [
{
"timeOffset": "0s",
"events": [
{
"type": "IMPRESSION",
"uri": "https://securepubads.g.doubleclick.net/pcs/view..."
},
{
"type": "START",
"uri": "https://pubads.g.doubleclick.net/pagead/interaction/..."
},
...
]
},
...
],
"ads": [
{
"duration": "10s",
"activityEvents": [
{
"type": "ERROR",
"uri": "https://pubads.g.doubleclick.net/pagead/interaction/..."
},
{
"type": "CLICK_THROUGH",
"uri": "https://pubads.g.doubleclick.net/pcs/click...",
"id": "GDFP"
},
...
]
}
],
"endTimeOffset": "10s",
"startTimeOffset": "0s"
}
],
"sessionContent": {
"duration": "70s"
}
},
"playUri": "PLAY_URI",
"sourceUri": "VOD_URI",
"adTagUri": "AD_TAG_URI",
"assetId": "ASSET_ID",
"adTracking": "SERVER",
"vodConfig": "projects/PROJECT_NUMBER/locations/LOCATION/vodConfigs/VOD_CONFIG_ID"
}
响应是一个 VOD 会话对象,包含以下字段:
- 一个
name字段,用于显示 VODSESSION_ID。您可以使用此 ID 获取有关会话的信息。 - 一个
interstitials对象,其中包含有关已插入广告的元数据(请参阅广告元数据概念)。 - 一个
playUri字段,用于显示客户端设备用于播放条件视频素材资源的网址。
如果您要代表客户的设备生成会话,请使用 HTTP 标头设置以下参数:
| 参数 | HTTP 标头 |
|---|---|
CLIENT_IP |
x-user-ip |
REFERRER_URL |
referer |
USER_AGENT |
user-agent |
您可以向上述 curl 请求添加以下标头:
-H "x-user-ip: CLIENT_IP" \ -H "referer: REFERRER_URL" \ -H "user-agent: USER_AGENT" \
广告代码宏
广告代码可以包含宏,这可能会导致每个会话的广告代码都不同。宏在广告代码中用方括号表示,如以下示例所示:
AD_TAG_URI¯o=[my-key]
adTagUri 在 VOD 配置中定义。
如需替换广告代码宏中的值,请在 adTagMacroMap 字段中提供映射。例如,如果您想将 [my-key] 宏替换为字符串 my-value,则需要提供以下内容:
{ ... "adTagMacroMap": { "my-key": "my-value" }, ... }
当 Video Stitcher API 请求广告元数据时,它会使用以下广告代码:
AD_TAG_URI¯o=my-value
获取会话
如需获取拼接广告的视频的会话,请使用 projects.locations.vodSessions.get 方法。
REST
在使用任何请求数据之前,请先进行以下替换:
PROJECT_NUMBER:IAM 设置页面上项目编号字段中显示的 Google Cloud 项目编号LOCATION:会话的位置;请使用某个受支持的地区显示位置us-central1us-east1us-west1asia-east1asia-south1asia-southeast1europe-west1southamerica-east1
SESSION_ID:视频点播会话的标识符
如需发送您的请求,请展开以下选项之一:
您应该收到类似以下内容的 JSON 响应:
{
"name": "projects/PROJECT_NUMBER/locations/LOCATION/vodSessions/SESSION_ID",
"interstitials": {
"adBreaks": [
{
"progressEvents": [
{
"timeOffset": "0s",
"events": [
{
"type": "IMPRESSION",
"uri": "https://securepubads.g.doubleclick.net/pcs/view..."
},
{
"type": "START",
"uri": "https://pubads.g.doubleclick.net/pagead/interaction/..."
},
...
]
},
...
],
"ads": [
{
"duration": "10s",
"activityEvents": [
{
"type": "ERROR",
"uri": "https://pubads.g.doubleclick.net/pagead/interaction/..."
},
{
"type": "CLICK_THROUGH",
"uri": "https://pubads.g.doubleclick.net/pcs/click...",
"id": "GDFP"
},
...
]
}
],
"endTimeOffset": "10s",
"startTimeOffset": "0s"
}
],
"sessionContent": {
"duration": "70s"
}
},
"playUri": "PLAY_URI",
"sourceUri": "VOD_URI",
"adTagUri": "AD_TAG_URI",
"assetId": "ASSET_ID",
"adTracking": "SERVER",
"vodConfig": "projects/PROJECT_NUMBER/locations/LOCATION/vodConfigs/VOD_CONFIG_ID"
}
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 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为本地开发环境设置身份验证。
示例插播广告的播放列表
以下内容显示了广告拼接之前的示例源 VOD 播放列表:
#EXTM3U
#EXT-X-TARGETDURATION:6
#EXT-X-VERSION:4
#EXT-X-PLAYLIST-TYPE:VOD
#EXT-X-MEDIA-SEQUENCE:0
#EXTINF:6.000,
segment_01.ts
#EXTINF:6.000,
segment_02.ts
#EXTINF:6.000,
segment_03.ts
#EXTINF:6.000,
segment_04.ts
#EXTINF:6.000,
segment_05.ts
#EXTINF:6.000,
segment_06.ts
#EXT-X-ENDLIST
以下示例展示了在拼接了前贴片广告、中贴片广告和后贴片广告后的源 VOD 播放列表:
#EXTM3U
#EXT-X-VERSION:4
#EXT-X-TARGETDURATION:6
#EXT-X-PLAYLIST-TYPE:VOD
#EXT-X-DISCONTINUITY
#EXTINF:4.000,
https://ads.us-west1.cdn.videostitcher.goog/preroll_ad/seg_01.ts
#EXTINF:4.000,
https://ads.us-west1.cdn.videostitcher.goog/preroll_ad/seg_02.ts
#EXTINF:1.990,
https://ads.us-west1.cdn.videostitcher.goog/preroll_ad/seg_03.ts
#EXT-X-DISCONTINUITY
#EXTINF:6.000,
segment_01.ts
#EXTINF:6.000,
segment_02.ts
#EXT-X-DISCONTINUITY
#EXTINF:4.000,
https://ads.us-west1.cdn.videostitcher.goog/midroll_ad/seg_01.ts
#EXTINF:0.990,
https://ads.us-west1.cdn.videostitcher.goog/midroll_ad/seg_02.ts
#EXT-X-DISCONTINUITY
#EXTINF:6.000,
segment_03.ts
#EXTINF:6.000,
segment_04.ts
#EXTINF:6.000,
segment_05.ts
#EXTINF:6.000,
segment_06.ts
#EXT-X-DISCONTINUITY
#EXTINF:4.000,
https://ads.us-west1.cdn.videostitcher.goog/postroll_ad/seg_01.ts
#EXTINF:4.000,
https://ads.us-west1.cdn.videostitcher.goog/postroll_ad/seg_02.ts
#EXTINF:1.990,
https://ads.us-west1.cdn.videostitcher.goog/postroll_ad/seg_03.ts
#EXT-X-ENDLIST
处理客户端广告跟踪
启用客户端广告跟踪后,播放器负责触发广告跟踪事件。您可以在创建 VOD 会话时返回的插播广告对象中找到客户端跟踪信息。
插页式广告对象包含从广告代码请求中解析出的随播广告的广告跟踪信息和元数据。如需检查拼接了哪些广告,请参阅检查 VOD 会话。
插页式广告
广告跟踪信息按广告插播时间分组,位于 interstitials 对象中。
广告插播可能具有进度事件,这些事件会针对已触发的每个事件指定事件 URI 和相对于插播开始时间的时间偏移量。如需详细了解进度事件,请参阅 ProgressEvent 参考文档。
广告插播时间点还可以包含活动事件和随播广告。如需详细了解随播广告,请参阅 CompanionAds 参考文档。
以下是插页式广告示例:
{
"adBreaks": [
{
"progressEvents": [
{
"timeOffset": "0s",
"events": [
{
"type": "IMPRESSION",
"uri": "https://example.com/impression"
},
{
"type": "START",
"uri": "https://example.com/start"
}
]
},
{
"timeOffset": "1.250s",
"events": [
{
"type": "FIRST_QUARTILE",
"uri": "https://example.com/firstquartile"
}
]
}
],
"ads": [
{
"duration": "5s",
"activityEvents": [
{
"type": "PAUSE",
"uri": "https://example.com/pause"
}
],
"companionAds": {
"required": "all",
"companions": [
{
"width": 200,
"height": 100,
"staticResource": {
"uri": "https://example.com/static.png",
"creativeType": "image/png"
}
}
]
}
},
{
"duration": "10s"
}
],
"startTimeOffset": "0s",
"endTimeOffset": "15.000s"
}
],
"sessionContent": {
"duration": "120.000s"
}
}
在上面的示例中,有一个前贴片广告插播时间点,其中包含两个拼接到了 VOD 资源中的广告。第一个广告的时长为 5 秒,第二个广告的时长为 10 秒。拼接视频的总时长为 120 秒,如 sessionContent 中的 duration 字段所示。
当客户端收到此对象时,应执行以下操作:
- 在广告插播时间点开始时向
https://example.com/start发出请求。 - 在广告插播开始时向
https://example.com/impression发出请求。 - 每当观看者在第一个广告播放期间暂停视频时,都向
https://example.com/pause发出请求。 - 在第一个广告播放到 1.25 秒时发出请求。
https://example.com/firstQuartile - 在第一个广告播放期间加载随播广告
https://example.com/static.png。
检查 VOD 会话
本部分介绍了如何检查指定 VOD 会话的广告代码详情和拼接详情。如需了解详情,请参阅 VodAdTagDetail 和 VodStitchDetail 的 REST 文档。
在 VOD 会话的 VOD 配置中定义的 adTagUri 字段用于指定检索广告元数据的网址。Video Stitcher API 在发出请求时还会包含用户元数据。
/vodAdTagDetails 端点包含以下信息:
- 已解析的广告代码
- 用户元数据
- 请求正文和标头
- 响应正文和标头
/vodStitchDetails 端点包含以下信息:
- 广告插播 ID
- 广告 ID
- 广告时间偏移值(以秒为单位)
- 原因(如果广告未插播)
- 广告媒体元数据
列出广告代码详情
如需列出 VOD 会话的广告代码详情,请使用 projects.locations.vodSessions.vodAdTagDetails.list 方法。
REST
在使用任何请求数据之前,请先进行以下替换:
PROJECT_NUMBER:IAM 设置页面上项目编号字段中显示的 Google Cloud 项目编号LOCATION:会话的位置;请使用某个受支持的地区显示位置us-central1us-east1us-west1asia-east1asia-south1asia-southeast1europe-west1southamerica-east1
SESSION_ID:视频点播会话的会话 ID
如需发送您的请求,请展开以下选项之一:
您应该收到类似以下内容的 JSON 响应:
{
"vodAdTagDetails" : [
{
"name": "projects/PROJECT_NUMBER/locations/LOCATION/vodSessions/SESSION_ID/vodAdTagDetails/VOD_AD_TAG_DETAILS_ID",
"adRequests": [
{
"uri": "REQUEST_URL",
"requestMetadata": "AD_TAG_REQUEST_METADATA",
"responseMetadata": "AD_TAG_RESPONSE_METADATA"
}
]
}
]
}
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 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为本地开发环境设置身份验证。
响应会返回一个 VodAdTagDetail 对象列表。每个 VodAdTagDetail 都表示广告代码的广告检索元数据,而每个 AdRequest 都表示单个广告请求的广告请求元数据。
更多结果
curl 响应可能包含 nextPageToken,可用于检索其他结果:
{ "vodAdTagDetails": [ ... ], "nextPageToken": "NEXT_PAGE_TOKEN" }
您可以发送另一个 curl 请求,其中包含 NEXT_PAGE_TOKEN 的值,以列出其他对象。将以下内容附加到上述 API 调用中的网址:
?pageToken=NEXT_PAGE_TOKEN
获取广告代码详情
如需获取 VOD 会话中单个 VodAdTagDetail 对象的详细信息,请使用 projects.locations.vodSessions.vodAdTagDetails.get 方法。
以下示例演示了如何使用之前请求返回的广告代码详情的名称来查看 VOD 会话的单个广告代码详情:
REST
在使用任何请求数据之前,请先进行以下替换:
PROJECT_NUMBER:IAM 设置页面上项目编号字段中显示的 Google Cloud 项目编号LOCATION:会话的位置;请使用某个受支持的地区显示位置us-central1us-east1us-west1asia-east1asia-south1asia-southeast1europe-west1southamerica-east1
SESSION_ID:视频点播会话的会话 IDVOD_AD_TAG_DETAILS_ID:VOD 广告代码详情的 ID
如需发送您的请求,请展开以下选项之一:
您应该收到类似以下内容的 JSON 响应:
{
"name": "projects/PROJECT_NUMBER/locations/LOCATION/vodSessions/SESSION_ID/vodAdTagDetails/VOD_AD_TAG_DETAILS_ID",
"adRequests": [
{
"uri": "REQUEST_URL",
"requestMetadata": "AD_TAG_REQUEST_METADATA",
"responseMetadata": "AD_TAG_RESPONSE_METADATA"
}
]
}
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 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为本地开发环境设置身份验证。
列出拼接详情
您可以查看有关为任何 VOD 会话拼接的广告的详细信息。
如需列出 VOD 会话的拼接详细信息,请使用 projects.locations.vodSessions.vodStitchDetails.list 方法。
REST
在使用任何请求数据之前,请先进行以下替换:
PROJECT_NUMBER:IAM 设置页面上项目编号字段中显示的 Google Cloud 项目编号LOCATION:会话的位置;请使用某个受支持的地区显示位置us-central1us-east1us-west1asia-east1asia-south1asia-southeast1europe-west1southamerica-east1
SESSION_ID:视频点播会话的会话 ID
如需发送您的请求,请展开以下选项之一:
您应该收到类似以下内容的 JSON 响应:
{
"vodStitchDetails" : [
{
"name": "projects/PROJECT_NUMBER/locations/LOCATION/vodSessions/SESSION_ID/vodStitchDetails/VOD_STITCH_DETAILS_ID",
"adStitchDetails": [
{
"adBreakId": "AD_BREAK_ID",
"adId": "AD_ID",
"adTimeOffset": "AD_TIME_OFFSET",
"skipReason": "SKIP_REASON",
"media": "MEDIA_OBJECT"
},
{
"adBreakId": "my-other-ad-break-id",
"adId": "my-other-ad-id",
"adTimeOffset": "my-other-ad-time-offset",
"skipReason": "my-other-skip-reason",
"media": "my-other-media-object"
}
]
}
]
}
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 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为本地开发环境设置身份验证。
响应会返回一个 VodStitchDetail 对象列表。每个 VodStitchDetail 都表示广告代码的拼接详细信息,而每个 adStitchDetails 对象都表示单个广告的拼接详细信息。
curl 响应可能包含 nextPageToken,可用于检索更多结果。
获取广告代码拼接详情
如需获取 VOD 会话中单个广告代码的拼接详细信息,请使用 projects.locations.vodSessions.vodStitchDetails.get 方法。
以下示例演示了如何使用之前请求返回的拼接广告代码详情的名称,查看 VOD 会话的单个广告代码拼接详情:
REST
在使用任何请求数据之前,请先进行以下替换:
PROJECT_NUMBER:IAM 设置页面上项目编号字段中显示的 Google Cloud 项目编号LOCATION:会话的位置;请使用某个受支持的地区显示位置us-central1us-east1us-west1asia-east1asia-south1asia-southeast1europe-west1southamerica-east1
SESSION_ID:视频点播会话的会话 IDVOD_STITCH_DETAILS_ID:VOD 拼接详情的 ID
如需发送您的请求,请展开以下选项之一:
您应该收到类似以下内容的 JSON 响应:
{
"name": "projects/PROJECT_NUMBER/locations/LOCATION/vodSessions/SESSION_ID/vodStitchDetails/VOD_STITCH_DETAILS_ID",
"adStitchDetails": [
{
"adBreakId": "AD_BREAK_ID",
"adId": "AD_ID",
"adTimeOffset": "AD_TIME_OFFSET",
"skipReason": "SKIP_REASON",
"media": "MEDIA_OBJECT"
}
]
}
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 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为本地开发环境设置身份验证。