返回与指定视频相关联的字幕轨道列表。请注意,API 响应不包含实际字幕,并且 captions.download 方法能够检索字幕轨道。
配额影响: 调用此方法的配额费用为 50 个单位。
常见应用场景
请求
HTTP 请求
GET https://www.googleapis.com/youtube/v3/captions
授权
此请求需要获得以下至少一个范围的授权(详细了解身份验证和授权)。
| 范围 |
|---|
https://www.googleapis.com/auth/youtube.force-ssl |
https://www.googleapis.com/auth/youtubepartner |
参数
下表列出了此查询支持的参数。列出的所有参数都是查询参数。
| 参数 | ||
|---|---|---|
| 必需参数 | ||
part |
stringpart 参数用于指定 API 响应将包含的 caption 资源部分。以下列表包含您可以在参数值中包含的 part 名称:
|
|
videoId |
stringvideoId 参数用于指定 API 应为其返回字幕轨道的视频的 YouTube 视频 ID。 |
|
| 可选参数 | ||
id |
stringid 参数用于指定一个逗号分隔列表的 ID,这些 ID 用于标识应检索的 caption 资源。每个 ID 都必须标识与指定视频相关联的字幕轨道。 |
|
onBehalfOfContentOwner |
string此参数只能在经过适当授权的请求中使用。注意: 此参数仅供 YouTube 内容合作伙伴使用。 onBehalfOfContentOwner 参数表示请求的授权凭据标识的是一个 YouTube 内容管理系统 用户,该用户代表参数值中指定的内容所有者行事。此参数适用于拥有和管理许多不同 YouTube 频道的 YouTube 内容合作伙伴。它允许内容所有者进行一次身份验证,即可访问其所有视频和频道数据,而无需为每个频道提供身份验证凭据。用户进行身份验证时使用的实际 CMS 账号必须与指定的 YouTube 内容所有者相关联。 |
|
请求正文
调用此方法时,请勿提供请求正文。
响应
如果成功,此方法将返回采用以下结构的响应正文:
{
"kind": "youtube#captionListResponse",
"etag": etag,
"items": [
caption Resource
]
}属性
下表定义了此资源中显示的属性:
| 属性 | |
|---|---|
kind |
string标识 API 资源的类型。该值将为 youtube#captionListResponse。 |
etag |
etag此资源的 ETag。 |
items[] |
list与请求条件匹配的字幕列表。 |
错误
下表列出了 API 在响应对此方法的调用时可能会返回的出错提示。如需了解详情,请参阅错误消息文档。
| 错误类型 | 错误详情 | 说明 |
|---|---|---|
forbidden (403) |
forbidden |
由于与请求关联的权限不足以检索所请求的资源,因此无法检索一个或多个字幕轨道。该请求可能未获得适当授权。 |
notFound (404) |
captionNotFound |
找不到一个或多个指定的字幕轨道。如果 videoId 参数标识的是实际视频,但 id 参数标识的是不存在的字幕轨道 ID 或与其他视频相关联的轨道 ID,则会发生此错误。检查请求的 id 和 videoId 参数的值,确保它们正确无误。 |
notFound (404) |
videoNotFound |
找不到由 videoId 参数标识的视频。 |
试试看!
使用 APIs Explorer 调用此 API,并查看 API 请求和响应。