Watermarks

watermark リソースは、指定されたチャンネルの動画の再生中に表示される画像を識別します。画像のリンク先ターゲット チャンネルや、動画の再生中に透かしを表示するタイミングとその長さを指定することもできます。

メソッド

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

set
透かし画像を YouTube にアップロードし、チャンネルに設定します。
未設定
チャンネルの透かし画像を削除します。今すぐ試す

リソース表現

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

{
  "timing": {
    "type": string,
    "offsetMs": unsigned long,
    "durationMs": unsigned long
  },
  "position": {
    "type": string,
    "cornerPosition": string
  },
  "imageUrl": string,
  "imageBytes": bytes,
  "targetChannelId": string
}

プロパティ

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

プロパティ
timing object
timing オブジェクトは、チャンネルの透かし画像が表示される動画再生中の時間に関する情報をカプセル化します。このオブジェクトは、watermarks.set を呼び出すときに必要です。
timing.type string
動画の再生中に透かし画像を表示するタイミングを決定するタイミング メソッド。このプロパティは、watermarks.set を呼び出す場合に必須です。

有効な値は次のとおりです。
  • offsetFromStart: offsetMs フィールドは動画の先頭からのオフセットを表します。
  • offsetFromEnd: offsetMs フィールドは動画の末尾からのオフセットを表します。
timing.offsetMs unsigned long
動画の再生中にプロモーション アイテムが表示されるタイミングを決定する時間オフセット（ミリ秒単位で指定）。このプロパティは、watermarks.set を呼び出すときに必要です。type が offsetFromEnd の場合、offsetMs は 1000 ミリ秒以上にする必要があります。
timing.durationMs unsigned long
ウォーターマーク画像を表示する時間（ミリ秒単位）。このプロパティは省略可能です。指定した場合、最小期間は 1000 ミリ秒です。type が offsetFromEnd の場合、durationMs は offsetMs を超えてはなりません。
position object
非推奨: position オブジェクトは非推奨であり、YouTube によって無視されます。透かしは常に動画プレーヤーの右上に表示されます。
imageUrl string
チャンネルの透かし画像の URL。YouTube はこの URL を生成し、watermark.set リクエストに対する API レスポンスで返します。
imageBytes bytes
透かし画像のサイズ（バイト単位）。
targetChannelId string
透かし画像がリンクするチャンネルの YouTube チャンネル ID。