watermark
リソースは、指定されたチャンネルの動画の再生中に表示される画像を識別します。画像のリンク先ターゲット チャンネルや、動画の再生中に透かしを表示するタイミングとその長さを指定することもできます。
メソッド
この API は、watermarks
リソースに対して次のメソッドをサポートしています。
リソース表現
次の 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 動画プレーヤーでプロモーション アイテムが配置される方法。 このプロパティの有効な値は次のとおりです。
|
position.cornerPosition |
string プロモーション アイテムが表示されるプレーヤーの隅。アイテムは常にプレーヤーの右上隅に表示されます。 このプロパティの有効な値は次のとおりです。
|
imageUrl |
string チャンネルの透かし画像の URL。YouTube はこの URL を生成し、 watermark.set リクエストに対する API レスポンスで返します。 |
imageBytes |
bytes 透かし画像のサイズ(バイト単位)。 |
targetChannelId |
string 透かし画像がリンクするチャンネルの YouTube チャンネル ID。 |