将自定义视频缩略图上传到 YouTube 并为视频设置该缩略图。
此方法支持媒体上传。 上传的文件必须符合以下限制条件:
- 文件大小上限: 50MB
- 接受的媒体 MIME 类型:
image/jpeg、image/png、application/octet-stream
配额影响: 调用此方法的配额费用约为 50 个单位。
常见应用场景
请求
HTTP 请求
POST https://www.googleapis.com/upload/youtube/v3/thumbnails/set
授权
此请求需要获得以下至少一个范围的授权(详细了解身份验证和授权)。
| 范围 |
|---|
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 |
参数
下表列出了此查询支持的参数。列出的所有参数都是查询参数。
| 参数 | ||
|---|---|---|
| 必需参数 | ||
videoId |
stringvideoId 参数用于指定要为其提供自定义视频缩略图的 YouTube 视频 ID。 |
|
| 可选参数 | ||
onBehalfOfContentOwner |
string注意: 此参数仅供 YouTube 内容合作伙伴使用。 The onBehalfOfContentOwner 参数表示请求的授权凭据标识的是代表参数值中指定的内容所有者行事的 YouTube 内容管理系统 (CMS) 用户。此参数适用于拥有和管理许多不同 YouTube 频道的 YouTube 内容合作伙伴。它允许内容所有者进行一次身份验证,即可访问其所有视频和频道数据,而无需为每个频道提供身份验证凭据。用户进行身份验证时使用的实际 CMS 账号必须与指定的 YouTube 内容所有者相关联。 |
|
请求正文
请求的正文包含您要上传的缩略图图片。请求正文不包含 thumbnail 资源。
响应
如果成功,此方法将返回采用以下结构的响应正文:
{
"kind": "youtube#thumbnailSetResponse",
"etag": etag,
"items": [
thumbnail resource
]
}属性
下表定义了此资源中显示的属性:
| 属性 | |
|---|---|
kind |
string标识 API 资源的类型。该值将为 youtube#thumbnailSetResponse。 |
etag |
etag此资源的 ETag。 |
items[] |
list缩略图列表。 |
错误
下表列出了 API 在响应对此方法的调用时可能会返回的出错提示。如需了解详情,请参阅错误消息文档。
| 错误类型 | 错误详情 | 说明 |
|---|---|---|
badRequest (400) |
invalidImage |
提供的图片内容无效。 |
badRequest (400) |
mediaBodyRequired |
请求不包含图片内容。 |
forbidden (403) |
forbidden |
无法为指定的视频设置缩略图。请求可能未获得适当授权。 |
forbidden (403) |
forbidden |
经过身份验证的用户无权上传和设置自定义视频缩略图。 |
notFound (404) |
videoNotFound |
找不到您尝试为其插入缩略图图片的视频。检查请求的 videoId 参数的值,确保其正确无误。 |
tooManyRequests (429) |
uploadRateLimitExceeded |
该频道最近上传的缩略图过多。请稍后重试该请求。 |
试试看!
使用 APIs Explorer 调用此 API,查看 API 请求和响应。