Captions: update

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

このメソッドはメディア アップロードをサポートしています。アップロードするファイルには、以下の制約が適用されます。

  • 最大ファイルサイズ: 100 MB
  • 使用できるメディアの MIME タイプ: text/xml、application/octet-stream、*/*

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

一般的なユースケース

リクエスト

HTTP リクエスト

PUT https://www.googleapis.com/upload/youtube/v3/captions

承認

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

範囲
https://www.googleapis.com/auth/youtube.force-ssl
https://www.googleapis.com/auth/youtubepartner

パラメータ

次の表に、このクエリでサポートされているパラメータを示します。このリストのパラメータはすべてクエリ パラメータです。

パラメータ
必須パラメータ
part string
この操作では、part パラメータは 2 つの目的を果たします。書き込み操作で設定されるプロパティと、API レスポンスに含まれるプロパティを指定します。トラックのドラフト ステータスを更新する場合は、プロパティの値を snippet に設定します。それ以外の場合は、プロパティの値を id に設定します。

次のリストは、パラメータ値に含めることができる part 名を示しています。
  • id
  • snippet
オプション パラメータ
onBehalfOfContentOwner string
このパラメータは、適切に承認されたリクエストでのみ使用できます。注: このパラメータは YouTube コンテンツ パートナー専用です。

onBehalfOfContentOwner パラメータは、リクエストの認証情報が、パラメータ値で指定されたコンテンツ所有者の代理である YouTube CMS ユーザーを識別することを示します。このパラメータは、複数の YouTube チャンネルを所有、管理している YouTube コンテンツ パートナーを対象にしています。このパラメータを使用すると、コンテンツ所有者は一度認証されれば、すべての動画やチャンネル データにアクセスできるようになります。チャンネルごとに認証情報を指定する必要はありません。ユーザー認証に使用する実際の CMS アカウントは、指定された YouTube コンテンツ所有者にリンクされていなければなりません。
sync boolean
このパラメータは非推奨になりました。 注: API サーバーは、リクエストに更新された字幕ファイルが含まれている場合にのみ、パラメータ値を処理します。

sync パラメータは、字幕ファイルを動画の音声トラックと自動的に同期させるかどうかを示します。値を true に設定すると、YouTube は字幕トラックと音声トラックを自動的に同期します。

リクエスト本文

リクエストの本文には字幕リソースを指定します。このリソースについて:

  • 以下のプロパティの値を指定する必要があります。

    • id

  • 以下のプロパティの値を指定することができます。

    • snippet.isDraft

    更新リクエストを送信する場合、既に値が設定されているプロパティの値を指定していないと、そのプロパティの既存の値が削除されます。

レスポンス

成功すると、このメソッドはレスポンスの本文で字幕リソースを返します。

エラー

次の表に、このメソッドの呼び出しに対して API から返されるエラー メッセージを示します。詳細については、エラー メッセージのドキュメントを参照してください。

エラーのタイプ エラーの詳細 説明
badRequest (400) contentRequired 更新済みの字幕ファイルがリクエストによってアップロードされませんでした。sync パラメータが true に設定されている場合、実際のトラック コンテンツが必要です。
forbidden (403) forbidden リクエストに関連付けられている権限では、字幕トラックを更新できません。リクエストが適切に認証されない可能性があります。
notFound (404) captionNotFound 指定された字幕トラックが見つかりませんでした。リクエストの id プロパティの値が正しいことを確認してください。

試してみよう:

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