Captions: download

字幕トラックをダウンロードします。字幕トラックは、リクエストで tfmt パラメータの値が指定されていない限り元の形式で、リクエストで tlang パラメータの値が指定されていない限り元の言語で返されます。

割り当てへの影響: このメソッドの呼び出しでは、200 ユニットの割り当て費用が発生します。

一般的なユースケース

リクエスト

HTTP リクエスト

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

承認

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

スコープ
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 Closed Caption 形式
  • srt - SubRip 字幕
  • ttml - Timed Text Markup Language 字幕
  • vtt - ウェブ動画のテキスト トラックのキャプション
tlang string
tlang パラメータは、API レスポンスで指定された字幕トラックの翻訳を返すことを指定します。パラメータの値は、希望する字幕の言語を識別する ISO 639-1 2 文字の言語コードです。翻訳は、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 リクエストとレスポンスを確認します。