Watermarks: set

将水印图片上传到 YouTube 并为频道设置该水印。

此方法支持媒体上传。上传的文件必须符合以下限制条件:

  • 文件大小上限:10MB
  • 接受的媒体 MIME 类型image/jpegimage/pngapplication/octet-stream

配额影响:对该方法的调用会产生 50 个单位的配额费用

请求

HTTP 请求

POST https://www.googleapis.com/upload/youtube/v3/watermarks/set

授权

此请求需要获得以下至少一个范围的授权。如需详细了解身份验证和授权,请参阅实现 OAuth 2.0 授权

范围
https://www.googleapis.com/auth/youtubepartner
https://www.googleapis.com/auth/youtube.upload
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

参数

下表列出了此查询支持的参数。列出的所有参数均为查询参数。

参数
必需参数
channelId string
channelId 参数用于指定提供水印的 YouTube 频道 ID。
可选参数
onBehalfOfContentOwner string
注意:此参数仅供 YouTube 内容合作伙伴使用。

onBehalfOfContentOwner 参数表示请求的授权凭据标识的是一位 YouTube 内容管理系统用户,该用户代表参数值中指定的内容所有者行事。此参数适用于拥有和管理许多不同 YouTube 频道的 YouTube 内容合作伙伴。这样一来,内容所有者只需进行一次身份验证,即可访问其所有视频和频道数据,而无需为每个频道分别提供身份验证凭据。用户进行身份验证时使用的内容管理系统账号必须与指定的 YouTube 内容所有者相关联。

请求正文

在请求正文中提供 watermark 资源。相应资源包含以下属性:

  • timingobject,必需):封装水印显示时间。
    • timing.typestring,必需):设置为 offsetFromStartoffsetFromEnd
    • timing.offsetMsunsigned long,必需):开始偏移量(以毫秒为单位)。如果 typeoffsetFromEnd,则必须至少为 1000 毫秒。
    • timing.durationMsunsigned long,可选):可见时长(以毫秒为单位,最低为 1000 毫秒)。如果 typeoffsetFromEnd,则不得超过 offsetMs
  • targetChannelIdstring,可选):水印链接到的 YouTube 频道 ID。如果省略,则链接到 channelId 所标识的频道。
  • positionobject,已弃用):YouTube 会忽略此参数。水印始终放置在右上角。

响应

如果成功,此方法将返回 HTTP 204 No Content 状态代码。

错误

下表列出了该 API 可能会在响应对此方法的调用时返回的错误消息。如需了解详情,请参阅 YouTube Data API - 错误

错误类型 错误详情 说明
badRequest (400) imageFormatUnsupported 您提供的图片格式不受支持。
badRequest (400) imageTooTall 您提供的图片过高。
badRequest (400) imageTooWide 您提供的图片过宽。
badRequest (400) mediaBodyRequired 请求不包含图片内容。
forbidden (403) forbidden 无法为指定频道设置水印。请求可能未获得适当授权,或者 channelId 参数设置的值无效。

试试看!

使用 APIs Explorer 调用此 API,并查看 API 请求和响应。