Watermarks

watermark 资源用于标识在指定频道的视频播放期间显示的图片。您还可以指定图片将链接到的目标频道,以及确定水印在视频播放过程中何时显示以及显示时间长度的具体时间信息。

方法

该 API 支持 watermarks 资源的以下方法:

设置
将水印图片上传到 YouTube 并为其设置频道。
unset
删除频道的水印图片。 立即试用

资源表示法

下面的 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
播放器中显示要宣传的商品的一角。该项始终显示在播放器的右上角。

此属性的有效值包括:
  • topRight
imageUrl string
频道水印图片的网址。YouTube 将生成此网址,并在针对 watermark.set 请求的 API 响应中返回此网址。
imageBytes bytes
水印图片的大小(以字节为单位)。
targetChannelId string
水印图片所关联的频道的 YouTube 频道 ID。