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 |
objecttiming 对象封装了有关频道水印图片在视频播放期间的显示时间的信息。调用 watermarks.set 时,此对象是必需的。 |
timing.type |
string一种时间安排方法,用于确定水印图片在视频播放期间的显示时间。调用 watermarks.set 时,必须提供此属性。有效值为:
|
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频道的视频水印图片的网址。YouTube 将生成此网址,并在对 watermark.set 请求的 API 响应中返回该网址。 |
imageBytes |
bytes水印图片的大小(以字节为单位)。 |
targetChannelId |
string水印图片所链接到的频道的 YouTube 频道 ID。 |