Captions

注: YouTube は 2024 年 3 月 13 日、 の sync パラメータが非推奨になります。 captions.insert、 captions.update API エンドポイント。 字幕の自動同期は、引き続き YouTube クリエイター ツールで利用できます。詳しくは、 API 変更履歴: 詳しく見ていきます

caption リソースは、YouTube 字幕トラックを表します。字幕トラックは 1 つの YouTube 動画にのみ関連付けられます。

メソッド

この API は、captions リソースの次のメソッドをサポートしています。

list

指定した動画に関連付けられている字幕トラックのリストを取得します。なお、API レスポンスには実際の字幕は含まれず、captions.download メソッドには字幕トラックを取得する機能が用意されています。 今すぐお試しください。

insert

字幕トラックをアップロードします。

update

字幕トラックを更新します。字幕トラックを更新するときは、トラックのドラフト ステータスの変更、トラックの新しい字幕ファイルのアップロード、またはその両方を行うことができます。

delete

指定した字幕トラックを削除します。 今すぐ試す

ダウンロード

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

リソース表現

次の JSON 構造は、captions リソースの形式を示しています。

{
  "kind": "youtube#caption",
  "etag": etag,
  "id": string,
  "snippet": {
    "videoId": string,
    "lastUpdated": datetime,
    "trackKind": string,
    "language": string,
    "name": string,
    "audioTrackType": string,
    "isCC": boolean,
    "isLarge": boolean,
    "isEasyReader": boolean,
    "isDraft": boolean,
    "isAutoSynced": boolean,
    "status": string,
    "failureReason": string
  }
}

プロパティ

次の表は、このリソースで使用されているプロパティの定義を示したものです。

プロパティ
kind	string API リソースのタイプを識別します。値は youtube#caption です。
etag	etag このリソースの ETag。
id	string 字幕トラックを一意に識別するために YouTube によって使用される ID。
snippet	object snippet オブジェクトには、字幕に関する基本情報が格納されます。
snippet.videoId	string 字幕トラックに関連付けられている動画を一意に識別するために YouTube によって使用される ID。
snippet.lastUpdated	datetime 字幕トラックが最後に更新された日時。値は ISO 8601 形式で指定します。
snippet.trackKind	string 字幕トラックのタイプ。 このプロパティの有効な値は次のとおりです。 ASR – 自動音声認識を使用して生成された字幕トラック。 forced – プレーヤー内で他のトラックが選択されていないときに再生される字幕トラック。たとえば、宇宙人が外国語で話しているところを映した動画には、外国語の字幕のみを表示する強制的な字幕トラックが含まれている場合があります。 standard – 通常の字幕トラック。これがデフォルト値です。
snippet.language	string 字幕トラックの言語。プロパティ値は BCP-47 言語タグです。
snippet.name	string 字幕トラックの名前。この名前は、再生中にオプションとしてユーザーに表示することを目的としています。名前の最大長は 150 文字です。
snippet.audioTrackType	string 字幕トラックに関連付けられている音声トラックのタイプ。 このプロパティの有効な値は次のとおりです。 <ph type="x-smartling-placeholder"> </ph> commentary – 字幕トラックは、ディレクトリ コメンタリーなどのコメンタリーを含む代替音声トラックに対応します。 descriptive - 字幕トラックは、追加の説明音声を含む代替音声トラックに対応しています。 primary – 字幕トラックは、動画の主音声トラックに対応します。これは通常、動画に関連付けられる音声トラックです。 unknown – これはデフォルト値です。
snippet.isCC	boolean トラックに聴覚障がい者や難聴向けの字幕が含まれているかどうかを示します。デフォルト値は false です。
snippet.isLarge	boolean 目の不自由な方のために字幕トラックが大きなテキストを使用するかどうかを示します。デフォルト値は false です。
snippet.isEasyReader	boolean 字幕トラックが「読みやすい」形式になっているかどうかを示します。つまり、言語学習者向けの 3 年生レベルの形式になっているかどうかを示します。デフォルト値は false です。
snippet.isDraft	boolean 字幕トラックがドラフトかどうかを示します。値が true の場合、トラックは一般公開されません。デフォルト値は false です。
snippet.isAutoSynced	boolean YouTube が字幕トラックを動画内の音声トラックと同期したかどうかを示します。字幕トラックのアップロード時に同期が明示的にリクエストされた場合、値は true になります。たとえば、captions.insert または captions.update メソッドを呼び出すときに、sync パラメータを true に設定して、アップロードされたトラックを動画に同期するよう YouTube に指示できます。値が false の場合、YouTube はアップロードされた字幕トラックのタイムコードを使用して、字幕を表示するタイミングを決定します。
snippet.status	string 字幕トラックのステータス。 このプロパティの有効な値は次のとおりです。 <ph type="x-smartling-placeholder"> </ph> failed serving syncing
snippet.failureReason	string YouTube が字幕トラックを処理できなかった理由。このプロパティは、state プロパティの値が failed の場合にのみ存在します。 このプロパティの有効な値は次のとおりです。 <ph type="x-smartling-placeholder"> </ph> processingFailed – アップロードされた字幕トラックを YouTube が処理できませんでした。 unknownFormat - 字幕トラックの形式が認識されませんでした。 unsupportedFormat – 字幕トラックの形式がサポートされていません。