返回与 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 | stringid参数用于指定一个逗号分隔列表,其中包含一个或多个唯一的播放列表图片 ID。 | |
| playlistId | stringplaylistId参数用于指定要检索播放列表映像的播放列表的唯一 ID。请注意,虽然这是一个可选参数,但每次检索播放列表图片的请求都必须为id参数或playlistId参数指定一个值。 | |
| 可选参数 | ||
| maxResults | unsigned integermaxResults参数用于指定结果集中应返回的图片数量上限。可接受的值为0到50(含)。默认值为5。 | |
| onBehalfOfContentOwner | string此参数只能在经过适当授权的请求中使用。注意:此参数仅供 YouTube 内容合作伙伴使用。 onBehalfOfContentOwner参数表示请求的授权凭据标识的是一位 YouTube 内容管理系统用户,该用户代表参数值中指定的内容所有者行事。此参数适用于拥有和管理许多不同 YouTube 频道的 YouTube 内容合作伙伴。这样一来,内容所有者只需进行一次身份验证,即可访问其所有视频和频道数据,而无需为每个频道提供身份验证凭据。用户进行身份验证时使用的内容管理系统账号必须与指定的 YouTube 内容所有者相关联。 | |
| onBehalfOfContentOwnerChannel | string此参数只能在经过适当授权的请求中使用。注意:此参数仅供 YouTube 内容合作伙伴使用。 onBehalfOfContentOwnerChannel参数用于指定要向哪个频道添加视频的 YouTube 频道 ID。如果请求为onBehalfOfContentOwner参数指定了值,则必须提供此参数,并且此参数只能与onBehalfOfContentOwner参数搭配使用。此外,必须使用与onBehalfOfContentOwner参数指定的内容所有者相关联的 CMS 账号对请求进行授权。最后,onBehalfOfContentOwnerChannel参数值指定的频道必须与onBehalfOfContentOwner参数指定的内容所有者相关联。此参数适用于拥有和管理许多不同 YouTube 频道的 YouTube 内容合作伙伴。这样一来,内容所有者只需进行一次身份验证,即可代表参数值中指定的频道执行操作,而无需为每个单独的频道提供身份验证凭据。 | |
| pageToken | stringpageToken参数用于标识应返回的结果集中的特定网页。在 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 | objectpageInfo对象封装了结果集的分页信息。 | 
| pageInfo.totalResults | integer结果集中的结果总数。 | 
| pageInfo.resultsPerPage | integerAPI 响应中包含的结果数。 | 
| items[] | list符合请求条件的播放列表图片列表。 |