Watermarks

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

Methods

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

設定
透かしの画像を 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 オブジェクトは、動画の再生中にチャンネルのウォーターマーク画像が表示される時間に関する情報をカプセル化します。
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
プロモーション対象アイテムが表示されるプレーヤーの角。アイテムは常にプレーヤーの右上に表示されます。

このプロパティの有効な値は次のとおりです。
  • topRight
imageUrl string
チャンネルの透かし画像の URL。YouTube はこの URL を生成し、watermark.set リクエストに対する API レスポンスで返します。
imageBytes bytes
透かし画像のサイズ(バイト単位)。
targetChannelId string
透かし画像とリンクしているチャンネルの YouTube チャンネル ID。