Captions: download

下载字幕轨道。除非请求为 tfmt 参数指定了值,否则字幕轨道将以其原始格式返回;除非请求为 tlang 参数指定了值,否则字幕轨道将以其原始语言返回。

配额影响: 调用此方法的配额费用为 200 个单位。

此方法要求用户拥有修改视频的权限。

常见应用场景

请求

HTTP 请求

GET https://www.googleapis.com/youtube/v3/captions/id

授权

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

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

参数

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

参数
必需参数
id string
id 参数用于标识要检索的字幕轨道。该值是 caption 资源中 id 属性标识的字幕轨道 ID。
可选参数
onBehalfOfContentOwner string
此参数只能在经过适当授权的请求中使用。注意: 此参数仅供 YouTube 内容合作伙伴使用。

onBehalfOfContentOwner 参数表示请求的授权凭据标识的是代表参数值中指定的内容所有者行事的 YouTube 内容管理系统 (CMS) 用户。此参数适用于拥有和管理许多不同 YouTube 频道的 YouTube 内容合作伙伴。它允许内容所有者进行一次身份验证,即可访问其所有视频和频道数据,而无需为每个频道提供身份验证凭据。用户进行身份验证时使用的实际 CMS 账号必须与指定的 YouTube 内容所有者相关联。
tfmt string
tfmt 参数用于指定应以特定格式返回字幕轨道。如果请求中未包含此参数,则轨道将以其原始格式返回。

支持的值包括:
  • sbv - SubViewer 字幕
  • scc - Scenarist 字幕格式
  • srt - SubRip 字幕
  • ttml - 时序文本标记语言字幕
  • vtt - Web Video Text Tracks 字幕
tlang string
tlang 参数用于指定 API 响应应返回指定字幕轨道的翻译。此参数值是 ISO 639-1 双字母语言代码,用于标识所需的字幕语言。翻译是使用机器翻译(例如 Google 翻译)生成的。

请求正文

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

响应

如果成功,此方法将返回一个二进制文件。响应的 Content-Type 标头为 application/octet-stream。

错误

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

错误类型 错误详情 说明
forbidden (403) forbidden 与请求关联的权限不足以下载字幕轨道。请求可能未获得适当授权。
invalidValue (400) couldNotConvert 字幕轨道数据无法转换为请求的语言和/或格式。请确保请求的 tfmt 和 tlang 值有效,并且请求的字幕轨道的 snippet.status 不是 failed。
notFound (404) captionNotFound 找不到字幕轨道。请检查请求的 id 参数的值,确保其正确无误。

试试看!

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