Watermarks

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

メソッド

この API では、watermarks リソースについて以下のメソッドがサポートされています。

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

リソース表現

下記の JSON の構造体は、watermarks リソースの形式を示したものです。

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

プロパティ

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

targetChannelId.valuestring 透かし画像のリンク先チャンネルの YouTube チャンネル ID。
プロパティ
timing object
timing オブジェクトは、動画の再生中にチャンネルの透かし画像を表示するタイミングに関する情報をカプセル化します。
timing.type string
動画の再生中に透かし画像を表示する時期を決定するタイミング メソッド。値が offsetFromStart の場合、offsetMs フィールドは、動画の先頭からのオフセットを表します。値が offsetFromEnd の場合、offsetMs フィールドは動画の末尾からのオフセットを表します。
timing.offsetMs unsigned long
動画の再生中にプロモート アイテムが表示されるタイミングを決定するタイム オフセット。ミリ秒単位で指定します。type プロパティの値により、オフセットを動画の先頭と末尾のどちらから測定するかが決定されます。
timing.durationMs unsigned long
透かし画像の表示時間(ミリ秒単位)。
position object
position オブジェクトは、透かし画像が表示される動画内の空間的な位置に関する情報をカプセル化します。
position.type string
動画プレーヤーにプロモート アイテムを配置する方法。

このプロパティで有効な値は以下のとおりです。
  • corner
position.cornerPosition string
プロモート アイテムが表示されるプレーヤーのコーナー。

このプロパティで有効な値は以下のとおりです。
  • bottomLeft
  • bottomRight
  • topLeft
  • topRight
imageUrl string
チャンネルの透かし画像の URL。この URL は YouTube が生成し、watermark.set リクエストに対する API レスポンスで返します。
imageBytes bytes
透かし画像のサイズ(バイト単位)。
targetChannelId object
targetChannelId オブジェクトは、透かし画像のリンク先チャンネルに関する情報をカプセル化します。