此页面由 Cloud Translation API 翻译。

LiveBroadcasts: control

注意：liveBroadcasts.control 方法已被弃用，并将在 2020 年 10 月 1 日或之后停止运行。在该日期之后，对此方法的所有调用都将返回“禁止 (403)”错误，系统随后将彻底移除该方法。

客户仍然可以通过向发送到 YouTube 提取服务器的视频添加叠加层来实施自己的调度。请参阅弃用公告。

控制可在直播视频流中显示的可选广告的设置。

常见使用场景

请求

HTTP 请求

POST https://www.googleapis.com/youtube/v3/liveBroadcasts/control

授权

此请求需要获得以下至少一个范围的授权（详细了解身份验证和授权）。

范围
`https://www.googleapis.com/auth/youtube`
`https://www.googleapis.com/auth/youtube.force-ssl`

参数

下表列出了此查询支持的参数。列出的所有参数都是查询参数。

参数
必需参数
`id`	`string` `id` 参数用于指定 YouTube 直播 ID，该 ID 可唯一标识正在更新可选广告的直播。
`part`	`string` `part` 参数用于指定 API 响应将包含的一个或多个 `liveBroadcast` 资源属性的英文逗号分隔列表。您可以在参数值中添加的 `part` 名称为 `id`、`snippet`、`contentDetails` 和 `status`。
可选参数
`displaySlate`	`boolean` `displaySlate` 参数用于指定是启用还是停用可选广告。
`offsetTimeMs`	`unsigned long` `offsetTimeMs` 参数用于指定在发生指定的可选广告更改时的时间偏移。该值从广播的监控视频流开始（以毫秒为单位，即广播的测试阶段的开始时间）开始计算，以毫秒为单位。尽管该值以毫秒为单位指定，但实际上是近似值，YouTube 会尽可能在当时完成所请求的操作。如果您没有为此参数指定值，YouTube 会尽快执行相应操作。如需了解详情，请参阅入门指南。重要提示：只有在直播延迟时，才应指定此参数的值。
`onBehalfOfContentOwner`	`string` 此参数只能在正确的授权请求中使用。注意：此参数专供 YouTube 内容合作伙伴使用。 `onBehalfOfContentOwner` 参数表示请求的授权凭据用于标识代表参数值中指定的内容所有者执行操作的 YouTube CMS 用户。此参数适用于拥有和管理许多不同 YouTube 频道的 YouTube 内容合作伙伴。内容所有者只需进行一次身份验证，即可访问自己所有的视频和频道数据，而无需为每个频道提供身份验证凭据。用户身份验证所用的 CMS 帐号必须与指定的 YouTube 内容所有者相关联。
`onBehalfOfContentOwnerChannel`	`string` 此参数只能在正确的授权请求中使用。此参数只能在适当的授权请求中使用。注意：此参数仅适用于 YouTube 内容合作伙伴。 `onBehalfOfContentOwnerChannel` 参数用于指定要添加视频的频道的 YouTube 频道 ID。当请求为 `onBehalfOfContentOwner` 参数指定值时，必须提供此参数，并且该参数只能与该参数结合使用。此外，必须使用与 `onBehalfOfContentOwner` 参数指定的内容所有者相关联的 CMS 帐号对请求进行授权。最后，`onBehalfOfContentOwnerChannel` 参数值指定的频道必须与 `onBehalfOfContentOwner` 参数指定的内容所有者相关联。此参数适用于拥有和管理许多不同 YouTube 频道的 YouTube 内容合作伙伴。使用 Content ID，内容所有者只需进行一次身份验证，即可代表参数值中指定的频道执行操作，而无需为每个单独的频道提供身份验证凭据。
`walltime`	`datetime` `walltime` 参数用于指定发生指定的可选广告变化时的壁钟时间。该值采用 ISO 8601 (`YYYY-MM-DDThh:mm:ss.sZ`) 格式指定。

请求正文

调用此方法时请勿提供请求正文。

响应

如果成功，此方法将在响应正文中返回 liveBroadcast 资源。

错误

下表列出了该 API 为响应对此方法的调用可能返回的错误消息。如需了解详情，请参阅错误消息文档。

错误类型	错误详情	说明
`backendError`	`errorDisplaySlate`	执行请求的操作时出错。
`forbidden (403)`	`liveBroadcastControlNotAllowed`	仅当广播状态为 `live` 时，才允许请求的操作。
`insufficientPermissions`	`insufficientLivePermissions`	该用户无权执行所请求的操作，原因可能是该用户无权进行直播。
`insufficientPermissions`	`liveStreamingNotEnabled`	授权请求的用户无法在 YouTube 上直播视频。用户可以访问 https://www.youtube.com/features 查找更多信息。
`invalidValue (400)`	`conflictingTimeFields`	只能指定 `offsetTimeMs` 和 `walltime` 中的一个。
`invalidValue (400)`	`invalidOffsetTimeMs`	`offsetTimeMs` 参数的值无效。此参数值必须为正数，但只有在启用广播的监控流后才能指定此参数。
`invalidValue (400)`	`invalidWalltime`	`walltime` 参数的值无效。
`notFound (404)`	`liveBroadcastNotFound`	“`id`”参数指定的广播不存在。
`required (400)`	`actionRequired`	API 请求需要指定至少一项操作。目前，唯一支持的操作是启用或停用可选广告。
`required (400)`	`idRequired`	必需的 `id` 参数必须标识正在更新的广播。

试试看！

使用 APIs Explorer 调用此 API，并查看 API 请求和响应。