Captions: list

指定した動画に関連付けられている字幕トラックのリストを返します。API レスポンスには実際の字幕が含まれません。また、captions.download メソッドには字幕トラックを取得する機能があることに注意してください。

割り当てへの影響: このメソッドの呼び出しにより、50 ユニットの割り当てコストが発生します。

一般的なユースケース

リクエスト

HTTP リクエスト

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

認可

このリクエストは、少なくとも次のうち 1 つのスコープでの承認が必要です（認証と承認の詳細をご確認ください）。

範囲
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 パラメータには、API が字幕トラックを返す動画の YouTube 動画 ID を指定します。
オプション パラメータ
id string
id パラメータには、取得対象の caption リソースを識別する ID のカンマ区切りのリストを指定します。各 ID は、指定した動画に関連付けられている字幕トラックを識別する必要があります。
onBehalfOfContentOwner string
このパラメータは、適切に承認されたリクエストでのみ使用できます。注: このパラメータは YouTube コンテンツ パートナー専用です。

onBehalfOfContentOwner パラメータは、リクエストの認証情報が、パラメータ値で指定されたコンテンツ所有者の代理である YouTube CMS ユーザーを識別することを示します。このパラメータは、複数の 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 リクエストに関連付けられている権限ではリクエストされたリソースを取得できないため、1 つ以上の字幕トラックを取得できませんでした。リクエストが適切に認証されない可能性があります。
notFound (404) captionNotFound 指定された 1 つ以上の字幕トラックが見つかりませんでした。このエラーは、videoId パラメータが実際の動画を識別しているのに、id パラメータが存在しない字幕トラック ID または別の動画に関連付けられているトラッキング ID を識別する場合に発生します。リクエストの id パラメータと videoId パラメータの値が正しいことを確認します。
notFound (404) videoNotFound videoId パラメータで特定される動画が見つかりませんでした。

試してみよう:

APIs Explorer を使用してこの API を呼び出し、API のリクエストとレスポンスを確認します。