Captions: list

返回与指定视频相关联的字幕轨道列表。请注意，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 string
part 参数指定 API 响应将包含的 caption 资源部分。

以下列表包含您可以包含在参数值中的 part 名称：
  • id
  • snippet
videoId string
videoId 参数用于指定视频的 YouTube 视频 ID，API 应为哪个视频返回字幕轨道。
可选参数
id string
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 请求和响应。