Captions: update

更新字幕轨道。更新字幕轨道时，您可以更改轨道的草稿状态和/或上传新的字幕文件。

此方法支持媒体上传。上传的文件必须符合以下限制条件：

  • 文件大小上限：100MB
  • 接受的媒体 MIME 类型：text/xml、application/octet-stream、*/*

对配额的影响：调用此方法会产生 450 个单元的配额费用。

常见使用场景

请求

HTTP 请求

PUT https://www.googleapis.com/upload/youtube/v3/captions

授权

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

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

参数

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

参数
必需参数
part string
part 参数在此操作中有两种用途。它标识写入操作要设置的属性，以及 API 响应将包含的属性。如果您要更新轨道的草稿状态，请将属性值设为 snippet。否则，请将属性值设为 id。

以下列表包含您可以包含在参数值中的 part 名称：
  • id
  • snippet
可选参数
onBehalfOfContentOwner string
此参数只能在正确授权的请求中使用。注意：此参数仅适用于 YouTube 内容合作伙伴。

onBehalfOfContentOwner 参数用于指明该请求的授权凭据会标识代表参数值中指定的内容所有者执行操作的 YouTube 内容管理系统用户。此参数适用于拥有和管理众多不同 YouTube 频道的 YouTube 内容合作伙伴。它可让内容所有者在一次身份验证后获得访问其所有视频和频道数据的权限，而无需为每个频道提供身份验证凭据。用户用于进行身份验证的实际 CMS 账号必须与指定的 YouTube 内容所有者相关联。
sync boolean
此参数已弃用。 注意：只有当请求中包含更新后的字幕文件时，API 服务器才会处理此参数值。

sync 参数用于指明 YouTube 是否应自动将字幕文件与视频的音轨同步。如果您将该值设置为 true，YouTube 会自动将字幕轨道与音轨同步。

请求正文

在请求正文中提供字幕资源。 针对该资源：

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

    • id

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

    • snippet.isDraft

    如果您要提交更新请求，但您的请求没有为已经包含某个值的属性值指定值，则该属性的现有值将被删除。

响应

如果成功，此方法会在响应正文中返回字幕资源。

错误

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

错误类型 错误详情 说明
badRequest (400) contentRequired 此请求未上传更新后的字幕文件。如果 sync 参数设为 true，则需要实际轨道内容。
forbidden (403) forbidden 与该请求关联的权限不足以更新字幕轨道。请求可能未获得适当授权。
notFound (404) captionNotFound 找不到指定的字幕轨道。检查请求的 id 属性的值，确保其正确无误。

试试看！

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