返回与 API 请求参数匹配的播放列表图片集合。您可以检索指定播放列表的播放列表图片,也可以按唯一 ID 检索一张或多张播放列表图片。
配额影响:调用此方法将产生 1 个单位的配额费用。
请求
HTTP 请求
GET https://www.googleapis.com/youtube/v3/playlistImages
授权
此请求需要获得以下至少一个范围的授权(详细了解身份验证和授权)。
范围 |
---|
https://www.googleapis.com/auth/youtubepartner |
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
参数
下表列出了此查询支持的参数。列出的所有参数均为查询参数。
参数 | ||
---|---|---|
必需参数 | ||
part |
string
|
|
过滤条件(请仅指定以下参数之一) | ||
id |
string id 参数指定一个逗号分隔列表,其中包含一个或多个唯一的播放列表图片 ID。 |
|
playlistId |
string playlistId 参数指定要检索播放列表图片的播放列表的唯一 ID。请注意,尽管这是一个可选参数,但每个检索播放列表图片的请求都必须为 id 参数或 playlistId 参数指定一个值。 |
|
可选参数 | ||
maxResults |
unsigned integer maxResults 参数用于指定结果集中应返回的图片数量上限。可接受的值包括0 到50 (含 0 和 50000)。默认值为 5 。 |
|
onBehalfOfContentOwner |
string 此参数只能在适当授权的请求中使用。注意:此参数专用于 YouTube 内容合作伙伴。 onBehalfOfContentOwner 参数用于指明请求的授权凭据可标识代表参数值中指定的内容所有者执行操作的 YouTube 内容管理系统用户。此参数适用于拥有和管理多个不同 YouTube 频道的 YouTube 内容合作伙伴。有了它,内容所有者只需验证一次身份,即可访问自己所有的视频和频道数据,而无需为每个频道提供身份验证凭据。用户进行身份验证时使用的内容管理系统账号必须与指定的 YouTube 内容所有者相关联。 |
|
onBehalfOfContentOwnerChannel |
string 此参数只能在适当授权的请求中使用。注意:此参数仅适用于 YouTube 内容合作伙伴。 onBehalfOfContentOwnerChannel 参数
用于指定视频所面向的频道的 YouTube 频道 ID
已添加。如果请求为
onBehalfOfContentOwner 参数,且只能在
与该参数结合使用。此外,该请求必须是
使用与内容所有者的
onBehalfOfContentOwner 参数指定。最后,
onBehalfOfContentOwnerChannel 参数值的通道
指定的广告必须与内容拥有者相关联的
onBehalfOfContentOwner 参数指定的值。此 参数适用于拥有和管理许多 不同 YouTube 频道它允许内容所有者进行身份验证一次 并代表参数中指定的渠道执行操作 而无需为每个字段提供身份验证凭据 独立频道 |
|
pageToken |
string pageToken 参数用于标识结果集中应返回的特定页面。在 API 响应中,nextPageToken 和 prevPageToken 属性用于标识可检索的其他网页。 |
请求正文
调用此方法时,请勿提供请求正文。
响应
如果成功,此方法将返回采用以下结构的响应正文:
{ "kind": "youtube#playlistImageListResponse", "nextPageToken": string, "prevPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ playlistImages Resource ] }
属性
下表定义了此资源中显示的属性:
属性 | |
---|---|
kind |
string 标识 API 资源的类型。该值将为 youtube#playlistImageListResponse 。 |
nextPageToken |
string 可用作 pageToken 参数值以检索结果集中下一页的令牌。 |
prevPageToken |
string 可用作 pageToken 参数值以检索结果集中上一页的令牌。 |
pageInfo |
object pageInfo 对象可封装结果集的分页信息。 |
pageInfo.totalResults |
integer 结果集中的结果总数。 |
pageInfo.resultsPerPage |
integer API 响应中包含的结果数量。 |
items[] |
list 符合请求条件的播放列表图片列表。 |