下载字幕轨道。除非请求指定了 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 内容管理系统用户。此参数适用于拥有和管理众多不同 YouTube 频道的 YouTube 内容合作伙伴。它可让内容所有者在一次身份验证后获得访问其所有视频和频道数据的权限,而无需为每个频道提供身份验证凭据。用户用于进行身份验证的实际 CMS 账号必须与指定的 YouTube 内容所有者相关联。 |
|
tfmt |
string tfmt 参数指定应以特定格式返回字幕轨道。如果请求中未包含该参数,则系统会以原始格式返回曲目。支持的值包括:
|
|
tlang |
string tlang 参数指定 API 响应应返回指定字幕轨道的翻译。此参数值是两个字母的 ISO 639-1 语言代码,用于标识所需的字幕语言。译文由机器翻译(例如谷歌翻译)生成。 |
请求正文
调用此方法时,请勿提供请求正文。
响应
如果成功,此方法将返回一个二进制文件。响应的 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 请求和响应。