字幕トラックをダウンロードします。リクエストで 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 |
stringid パラメータは、取得する字幕トラックを指定します。値は、caption リソースの id プロパティによって識別される字幕トラック ID です。 |
|
| オプション パラメータ | ||
onBehalfOfContentOwner |
stringこのパラメータは、適切に承認されたリクエストでのみ使用できます。注: このパラメータは YouTube コンテンツ パートナー専用です。 onBehalfOfContentOwner パラメータは、リクエストの認証情報が、パラメータ値で指定されたコンテンツ所有者の代理である YouTube CMS ユーザーを識別することを示します。このパラメータは、複数の YouTube チャンネルを所有、管理している YouTube コンテンツ パートナーを対象にしています。このパラメータを使用すると、コンテンツ所有者は一度認証されれば、すべての動画やチャンネル データにアクセスできるようになります。チャンネルごとに認証情報を指定する必要はありません。ユーザー認証に使用する実際の CMS アカウントは、指定された YouTube コンテンツ所有者にリンクされていなければなりません。 |
|
tfmt |
stringtfmt パラメータは、字幕トラックを特定の形式で返す必要があることを指定します。リクエストにパラメータが含まれていない場合、トラックは元の形式で返されます。サポートされている値は次のとおりです。
|
|
tlang |
stringtlang パラメータは、指定した字幕トラックの翻訳を 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 のリクエストとレスポンスを確認します。