Playlists: list

返回与 API 请求参数匹配的播放列表集合。例如，您可以检索经过身份验证的用户拥有的所有播放列表，也可以按唯一 ID 检索一个或多个播放列表。

配额影响： 调用此方法会消耗 1 个配额单位。

常见应用场景

请求

HTTP 请求

GET https://www.googleapis.com/youtube/v3/playlists

参数

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

参数
必需参数
part string
part 参数用于指定一个或多个 playlist 资源属性的英文逗号分隔列表，API 响应将包含这些属性。

如果该参数标识的属性包含子属性，则子属性将包含在响应中。例如，在 playlist 资源中，snippet 属性包含 author、title、description 和 timeCreated 等属性。因此，如果您设置 part=snippet，API 响应将包含所有这些属性。

以下列表包含您可以包含在参数值中的 part 名称：
  • contentDetails
  • id
  • localizations
  • player
  • snippet
  • status
过滤条件 （准确指定以下参数之一）
channelId string
此值表示 API 应仅返回指定频道的播放列表。
id string
id 参数用于指定要检索的资源的 YouTube 播放列表 ID 的英文逗号分隔列表。在 playlist 资源中，id 属性用于指定播放列表的 YouTube 播放列表 ID。
mine boolean
此参数只能在经过适当授权的请求中使用。将此参数的值设置为 true，以指示 API 仅返回经过身份验证的用户拥有的播放列表。
可选参数
hl string
hl 参数用于指示 API 检索 YouTube 网站支持的特定 应用语言的本地化资源元数据。参数值必须是 i18nLanguages.list 方法返回的列表中包含的语言代码。

如果该语言提供了本地化资源详细信息，则资源的 snippet.localized 对象将包含本地化值。但是，如果没有本地化详细信息，snippet.localized 对象将包含资源默认语言的资源详细信息。
maxResults unsigned integer
maxResults 参数用于指定结果集中应返回的项数上限。可接受的值为 0 到 50（含端点值）。默认值为 5。
onBehalfOfContentOwner string
此参数只能在经过适当授权的请求中使用。注意： 此参数仅供 YouTube 内容合作伙伴使用。

onBehalfOfContentOwner 参数表示请求的授权凭据标识的是代表参数值中指定的内容所有者行事的 YouTube 内容管理系统 用户。此参数适用于拥有和管理许多不同 YouTube 频道的 YouTube 内容合作伙伴。它允许内容所有者进行一次身份验证，即可访问其所有视频和频道数据，而无需为每个频道提供身份验证凭据。用户进行身份验证时使用的 CMS 账号必须与指定的 YouTube 内容所有者相关联。
onBehalfOfContentOwnerChannel string
此参数只能在经过适当授权的请求中使用。注意： 此参数仅供 YouTube 内容合作伙伴使用。

onBehalfOfContentOwnerChannel 参数用于指定要向其添加视频的频道的 YouTube 频道 ID。当请求为 onBehalfOfContentOwner 参数指定值时，此参数是必需的，并且只能与该参数搭配使用。此外，必须使用与 onBehalfOfContentOwner 参数指定的内容所有者相关联的 CMS 账号对请求进行授权。最后，onBehalfOfContentOwnerChannel 参数值指定的频道必须与 onBehalfOfContentOwner 参数指定的内容所有者相关联。

此参数适用于拥有和管理许多不同 YouTube 频道的 YouTube 内容合作伙伴。它允许内容所有者进行一次身份验证，即可代表参数值中指定的频道执行操作，而无需为每个单独的频道提供身份验证凭据。
pageToken string
pageToken 参数用于标识结果集中应返回的特定页面。在 API 响应中，nextPageToken 和 prevPageToken 属性用于标识可以检索的其他页面。

请求正文

调用此方法时，请勿提供请求正文。

响应

如果成功，此方法将返回采用以下结构的响应正文：

{
  "kind": "youtube#playlistListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    playlist Resource
  ]
}

属性

下表定义了此资源中显示的属性：

属性
kind string
标识 API 资源的类型。该值将为 youtube#playlistListResponse。
etag etag
此资源的 ETag。
nextPageToken string
可用作 pageToken 参数值的令牌，用于检索结果集中的下一页。
prevPageToken string
可用作 pageToken 参数值的令牌，用于检索结果集中的上一页。
pageInfo object
pageInfo 对象用于封装结果集的分页信息。
pageInfo.totalResults integer
结果集中的结果总数。
pageInfo.resultsPerPage integer
API 响应中包含的结果数。
items[] list
与请求条件匹配的播放列表的列表。

错误

下表标识了 API 在响应对此方法的调用时可能会返回的出错提示。如需了解详情，请参阅错误消息文档。

错误类型 错误详情 说明
forbidden (403) channelClosed channelId 参数中指定的频道已关闭。
forbidden (403) channelSuspended channelId 参数中指定的频道已被暂停。
forbidden (403) playlistForbidden 使用请求的 id 参数标识的播放列表不支持该请求，或者该请求未获得适当的授权。
notFound (404) channelNotFound 找不到 channelId 参数中指定的频道。
notFound (404) playlistNotFound 找不到使用请求的 id 参数标识的播放列表。
invalidValue (400) playlistOperationUnsupported API 不支持列出指定播放列表的功能。例如，您无法列出“稍后观看”播放列表。

试试看！

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