LiveBroadcasts: update

更新广播。例如，您可以修改 liveBroadcast 资源的 contentDetails 对象中定义的广播设置。

常见使用场景

请求

HTTP 请求

PUT https://www.googleapis.com/youtube/v3/liveBroadcasts

授权

此请求需要获得以下至少一个范围的授权。要详细了解身份验证和授权，请参阅实现 OAuth 2.0 授权。

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

参数

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

参数
必需参数
part string
part 参数在此操作中有两个用途。它标识写入操作将设置的属性以及 API 响应将包含的属性。

您可以在参数值中包含的 part 属性包括 id、snippet、contentDetails、monetizationDetails 和 status。

请注意，此方法将替换参数值指定的任何部分中所包含的所有可变属性的现有值。例如，广播的隐私状态在 status 部分定义。因此，如果您的请求要更新私享或不公开的广播，并且请求的 part 参数值包含 status 部分，则广播的隐私设置将更新为请求正文指定的任何值。如果请求正文未指定值，则现有隐私设置将被移除，且广播将还原为默认隐私设置。
可选参数
onBehalfOfContentOwner string
此参数只能在适当授权的请求中使用。
注意：此参数专用于 YouTube 内容合作伙伴。

onBehalfOfContentOwner 参数用于指明请求的授权凭据可标识代表参数值中指定的内容所有者的 YouTube 内容管理系统 (CMS) 用户。此参数适用于拥有和管理多个不同 YouTube 频道的 YouTube 内容合作伙伴。有了它，内容所有者只需验证一次身份，即可访问自己所有的视频和频道数据，而无需为每个频道提供身份验证凭据。用户进行身份验证时使用的内容管理系统账号必须与指定的 YouTube 内容所有者相关联。
onBehalfOfContentOwnerChannel string
此参数只能在适当授权的请求中使用。
注意：此参数仅适用于 YouTube 内容合作伙伴。

onBehalfOfContentOwnerChannel 参数用于指定视频的目标频道的 YouTube 频道 ID。如果请求指定了 onBehalfOfContentOwner 参数的值，则此参数是必需的，只能与该参数结合使用。此外，该请求必须使用与 onBehalfOfContentOwner 参数指定的内容所有者相关联的 CMS 账号进行授权。最后，onBehalfOfContentOwnerChannel 参数值指定的频道必须与 onBehalfOfContentOwner 参数指定的内容所有者相关联。

此参数适用于拥有和管理多个不同 YouTube 频道的 YouTube 内容合作伙伴。通过该方法，内容所有者只需进行身份验证一次，即可代表参数值中指定的频道执行操作，而无需为每个单独的频道提供身份验证凭据。

请求正文

在请求正文中提供 liveBroadcast 资源。 对于该资源：

  • 您必须为以下属性指定一个值：

    • id
    • snippet.scheduledStartTime
    • contentDetails.monitorStream.enableMonitorStream
    • contentDetails.monitorStream.broadcastStreamDelayMs

  • 您可以为以下属性设置值：

    • snippet.title
    • snippet.description
    • snippet.scheduledStartTime
    • snippet.scheduledEndTime
    • status.privacyStatus
    • contentDetails.monitorStream.enableMonitorStream
    • contentDetails.monitorStream.broadcastStreamDelayMs
    • contentDetails.enableAutoStart
    • contentDetails.enableAutoStop
    • contentDetails.enableClosedCaptions
    • contentDetails.enableDvr
    • contentDetails.enableEmbed
    • contentDetails.recordFromStart
    • monetizationDetails.cuepointSchedule.pauseAdsUntil

    如果您要提交更新请求，而您的请求没有为已具有值的媒体资源指定值，则该属性的现有值将被删除。

响应

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

错误

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

错误类型 错误详情 说明
forbidden (403) closedCaptionsTypeModificationNotAllowed 只有在广播处于 created 或 ready 状态时，才能修改 contentDetails.closedCaptionsType 值。
forbidden (403) enabledModificationNotAllowed enabled 字段是只读字段。
forbidden (403) scheduleStrategyModificationNotAllowed scheduleStrategy 字段是只读字段。
forbidden (403) repeatIntervalSecsModificationNotAllowed repeatIntervalSecs 字段是只读字段。
forbidden (403) pauseAdsUntilModificationNotAllowed 无法修改“pauseAdsUntil”字段。 出现此错误的原因可能如下：
  • monetizationDetails.cuepointSchedule.enabled 字段未设置为 true。此字段只能通过 YouTube 工作室进行设置。
  • 直播活动未进行。
forbidden (403) enableAutoStartModificationNotAllowed 只有当视频流处于非活动状态且广播处于 created 或 ready 状态时，才能修改 contentDetails.enableAutoStart 值。
forbidden (403) enableClosedCaptionsModificationNotAllowed 只有在广播的状态为 created 或 ready 时，才能修改 contentDetails.enableClosedCaptions 值。
forbidden (403) enableDvrModificationNotAllowed 仅当广播的状态为 created 或 ready 时，才能修改 contentDetails.enableDvr 值。
forbidden (403) enableMonitorStreamModificationNotAllowed 仅当广播的状态为 created 或 ready 时，才能修改 contentDetails.monitorStream.enableMonitorStream 值。
forbidden (403) recordFromStartModificationNotAllowed 仅当广播的状态为 created 或 ready 时，才能修改 contentDetails.recordFromStart 值。
insufficientPermissions insufficientLivePermissions 该请求无权更新指定的直播。有关详情，请参阅实现 OAuth2 身份验证。
insufficientPermissions liveStreamingNotEnabled 对请求进行授权的用户无法在 YouTube 上直播视频。用户可在 https://www.youtube.com/features 上找到更多信息。
invalidValue (400) invalidAutoStart liveBroadcast 资源 包含无效的 contentDetails.enableAutoStart 属性值。 您无法修改持久性广播的 enableAutoStart 设置。
invalidValue (400) invalidAutoStop liveBroadcast 资源 包含无效的 contentDetails.enableAutoStop 属性值。您 无法修改持久性广播的 enableAutoStop 设置。
invalidValue (400) invalidDescription liveBroadcast 资源没有为 snippet.description 属性指定有效值。snippet.description 最多可包含 5000 个字符。
invalidValue (400) invalidEmbedSetting liveBroadcast 资源的 contentDetails.enable_embed 属性值无效。你无法嵌入此直播。
invalidValue (400) invalidEnableClosedCaptions 在 liveBroadcast 资源中，contentDetails.enableClosedCaptions 属性的值与 contentDetails.closedCaptionType 设置的值不兼容。请修改资源，使其仅包含两个属性中的一个，然后重新提交请求。
invalidValue (400) invalidLatencyPreferenceOptions liveBroadcast 资源 包含无效的 contentDetails.latencyPreference 属性值。 此延迟时间偏好设置并不支持所有设置。
invalidValue (400) invalidPauseAdsUntil liveBroadcast 资源 包含无效的 monetizationDetails.cuepointSchedule.pauseAdsUntil 属性。 出现此错误的原因可能如下：
  • 未以 ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) 格式指定 monetizationDetails.cuepointSchedule.pauseAdsUntil 值。
  • monetizationDetails.cuepointSchedule.pauseAdsUntil 值不是将来的时间。
  • monetizationDetails.cuepointSchedule.pauseAdsUntil 值与当前时间相差超过 10 分钟。
invalidValue (400) invalidPrivacyStatus liveBroadcast 资源未指定有效的隐私状态。请参阅有效的 privacyStatus 值。
invalidValue (400) invalidProjection liveBroadcast 资源的 contentDetails.projection 属性值无效。持久广播的投影不能设置为 360 度全景。
invalidValue (400) invalidScheduledEndTime liveBroadcast 资源的 snippet.scheduledEndTime 属性值无效。预定的结束时间必须与预定的开始时间一致。
invalidValue (400) invalidScheduledStartTime liveBroadcast 资源的 snippet.scheduledStartTime 属性值无效。安排的开始时间必须是将来的时间。
invalidValue (400) invalidTitle liveBroadcast 资源没有为 snippet.title 属性指定有效值。snippet.title的长度必须介于 1 到 100 个字符之间。
notFound (404) liveBroadcastNotFound liveBroadcast 资源中指定的 id 属性无法识别直播。
required (400) broadcastStreamDelayMsRequired liveBroadcast 资源未指定 contentDetails.monitorStream.broadcastStreamDelayMs 属性。
required (400) enableMonitorStreamRequired liveBroadcast 资源未指定 contentDetails.monitorStream.enableMonitorStream 属性。
required (400) idRequired liveBroadcast 资源必须包含 id 属性并为其指定一个值。
required (400) scheduledEndTimeRequired liveBroadcast 资源未指定 snippet.scheduledEndTime 属性。
required (400) scheduledStartTimeRequired liveBroadcast 资源未指定 snippet.scheduledStartTime 属性。

试试看！

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