Watermarks: set

YouTube に透かし画像をアップロードし、チャンネルに設定します。

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

  • 最大ファイルサイズ: 10MB
  • 有効なメディア MIME タイプ: image/jpeg、image/png、application/octet-stream

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

リクエスト

HTTP リクエスト

POST https://www.googleapis.com/upload/youtube/v3/watermarks/set

承認

このリクエストには、少なくとも次のうち 1 つのスコープによる承認が必要です。認証と認可の詳細については、OAuth 2.0 認可の実装をご覧ください。

スコープ
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

パラメータ

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

パラメータ
必須パラメータ
channelId string
channelId パラメータは、ウォーターマークが提供される YouTube チャンネル ID を指定します。
オプション パラメータ
onBehalfOfContentOwner string
注: このパラメータは、YouTube コンテンツ パートナー専用です。

onBehalfOfContentOwner パラメータは、リクエストの認証情報が、パラメータ値で指定されたコンテンツ所有者の代理として動作する YouTube CMS ユーザーを識別することを示します。このパラメータは、複数の YouTube チャンネルを所有、管理している YouTube コンテンツ パートナーを対象にしています。このパラメータを使用すると、コンテンツ所有者は一度認証されれば、すべての動画やチャンネル データにアクセスできるようになります。チャンネルごとに認証情報を指定する必要はありません。ユーザー認証に使用する CMS アカウントは、指定された YouTube コンテンツ所有者にリンクされていなければなりません。

リクエストの本文

リクエストの本文に watermark リソースを指定します。リソースには次のプロパティが含まれています。

  • timing（object、必須）: 透かしの表示タイミングをカプセル化します。
    • timing.type（string、必須）: offsetFromStart または offsetFromEnd のいずれかに設定します。
    • timing.offsetMs（unsigned long、必須）: 開始オフセット（ミリ秒単位）。type が offsetFromEnd の場合は、1000 ミリ秒以上にする必要があります。
    • timing.durationMs（unsigned long、省略可）: 表示時間（ミリ秒単位）（最小 1000 ミリ秒）。type が offsetFromEnd の場合、offsetMs を超えてはなりません。
  • targetChannelId（string、省略可）: ウォーターマークがリンクする YouTube チャンネル ID。省略した場合、channelId で識別されるチャンネルにリンクします。
  • position（object、非推奨）: YouTube で無視されます。透かしは常に右上に配置されます。

レスポンス

成功すると、このメソッドは HTTP 204 No Content ステータス コードを返します。

エラー

次の表に、このメソッドの呼び出しに対するレスポンスとして API が返す可能性のあるエラー メッセージを示します。詳細については、YouTube Data API - エラーをご覧ください。

エラーのタイプ エラーの詳細 説明
badRequest (400) imageFormatUnsupported 指定した画像の形式はサポートされていません。
badRequest (400) imageTooTall 指定した画像の高さが高すぎます。
badRequest (400) imageTooWide 指定された画像の幅が広すぎます。
badRequest (400) mediaBodyRequired リクエストに画像コンテンツが含まれていません。
forbidden (403) forbidden 指定したチャネルには、透かしを設定できません。リクエストが正しく承認されていないか、channelId パラメータが無効な値に設定されている可能性があります。

試してみよう:

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