カスタム動画サムネイルを YouTube にアップロードして、動画に設定します。
このメソッドはメディア アップロードをサポートしています。アップロードされるファイルには、以下の制約が適用されます。
- 最大ファイル サイズ: 2 MB
- 使用可能な MIME タイプ:
image/jpeg
、image/png
、application/octet-stream
割り当ての影響: このメソッドを呼び出すと、約 50 単位の割り当てコストが発生します。
一般的なユースケース
リクエスト
HTTP リクエスト
POST https://www.googleapis.com/upload/youtube/v3/thumbnails/set
認証
このリクエストは、少なくとも次のうち 1 つのスコープでの承認が必要です(認証と承認の詳細をご確認ください)。
スコープ |
---|
https://www.googleapis.com/auth/youtubepartner |
https://www.googleapis.com/auth/youtube.upload |
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
パラメータ
次の表に、このクエリでサポートされているパラメータを示します。このリストのパラメータはすべてクエリ パラメータです。
パラメータ | ||
---|---|---|
必須パラメータ | ||
videoId |
string videoId パラメータでは、カスタム動画のサムネイルを指定する YouTube 動画 ID を指定します。 |
|
オプション パラメータ | ||
onBehalfOfContentOwner |
string 注: このパラメータは YouTube コンテンツ パートナー専用です。 onBehalfOfContentOwner パラメータは、パラメータ値で指定されたコンテンツ所有者の代理として操作する YouTube CMS ユーザーをリクエストの認可認証情報が識別することを示します。このパラメータは、複数の YouTube チャンネルを所有、管理している YouTube コンテンツ パートナーを対象にしています。このパラメータを使用すると、コンテンツ所有者は一度認証されれば、すべての動画やチャンネル データにアクセスできるようになります。チャンネルごとに認証情報を指定する必要はありません。ユーザー認証に使用する実際の CMS アカウントは、指定された YouTube コンテンツ所有者にリンクされていなければなりません。 |
リクエスト本文
リクエストの本文には、アップロードするサムネイル画像が含まれます。リクエストの本文に thumbnail
リソースが含まれていません。
レスポンス
成功すると、このメソッドは次の構造を含むレスポンスの本文を返します。
{ "kind": "youtube#thumbnailSetResponse", "etag": etag, "items": [ thumbnail resource ] }
プロパティ
次の表は、このリソースで使用されているプロパティの定義を示したものです。
プロパティ | |
---|---|
kind |
string API リソースのタイプを示します。値は youtube#thumbnailSetResponse です。 |
etag |
etag このリソースの ETag。 |
items[] |
list サムネイルのリスト。 |
エラー
次の表に、このメソッドを呼び出す際に API が返すエラー メッセージを示します。詳細については、エラー メッセージのドキュメントを参照してください。
エラーのタイプ | エラーの詳細 | 説明 |
---|---|---|
badRequest (400) |
invalidImage |
指定された画像のコンテンツは無効です。 |
badRequest (400) |
mediaBodyRequired |
リクエストに画像コンテンツが含まれていません。 |
forbidden (403) |
forbidden |
指定された動画には、サムネイルを設定できません。リクエストが適切に認証されない可能性があります。 |
forbidden (403) |
forbidden |
この認証済みユーザーには、カスタムの動画のサムネイルをアップロードし、設定する権限がありません。 |
notFound (404) |
videoNotFound |
サムネイル画像の挿入先動画が見つかりません。リクエストの videoId パラメータの値が正しいことを確認してください。 |
tooManyRequests (429) |
uploadRateLimitExceeded |
チャンネルに最近アップロードしたサムネイルが多すぎる。しばらくしてからもう一度お試しください。 |
実習
APIs Explorer を使用してこの API を呼び出し、API リクエストとレスポンスを確認します。