Channels: list

注意 ：channel 资源的 statistics.subscriberCount 属性值 已更新，以反映影响订阅人数 显示方式的 YouTube 政策变更。如需了解详情，请参阅 修订历史记录或 YouTube 帮助中心。

返回与请求条件匹配的零个或多个 channel 资源的集合。

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

常见应用场景

请求

HTTP 请求

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

授权

如需检索 channel 资源的 auditDetails 部分，请求必须提供包含 https://www.googleapis.com/auth/youtubepartner-channel-audit 范围的授权令牌。此外，当 MCN 决定接受或拒绝频道时，或者在令牌签发日期后的两周内，必须撤消使用该范围的所有令牌。

参数

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

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

如果该参数标识的属性包含子属性，则子属性将包含在响应中。例如，在 channel 资源中，contentDetails 属性包含其他属性，例如 uploads 属性。因此，如果您设置 part=contentDetails，API 响应也会包含所有这些嵌套属性。

以下列表包含您可以包含在 part 参数值中的名称：
  • auditDetails
  • brandingSettings
  • contentDetails
  • contentOwnerDetails
  • id
  • localizations
  • snippet
  • statistics
  • status
  • topicDetails
过滤条件 （准确指定以下参数之一）
categoryId string
此参数已被弃用。 categoryId 参数指定了 YouTube 指南类别，可用于 请求与该类别关联的 YouTube 频道。
forHandle string
forHandle 参数指定了 YouTube 标识名，从而请求 与该标识名关联的频道。参数值可以以 @ 符号开头。例如，如需检索“Google for Developers”频道的资源，请将 forHandle 参数值设置为 GoogleDevelopers 或 @GoogleDevelopers。
forUsername string
forUsername 参数指定了 YouTube 用户名，从而请求与该用户名关联的频道。
id string
id 参数指定了要检索的资源的 YouTube 频道 ID 的英文逗号分隔列表。在 channel 资源中，id 属性指定了频道的 YouTube 频道 ID。
managedByMe boolean
此参数只能在经过适当授权的请求中使用。

注意：此参数仅供 YouTube 内容合作伙伴使用。

将此参数的值设置为 true，以指示 API 仅返回由 onBehalfOfContentOwner 参数指定的内容所有者管理的频道。用户必须通过与指定内容所有者关联的 CMS 账号进行身份验证，并且必须提供 onBehalfOfContentOwner。
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 内容合作伙伴。它允许内容所有者进行一次身份验证，即可访问其所有视频和频道数据，而无需为每个频道提供身份验证凭据。用户进行身份验证时使用的内容管理系统账号必须与指定的 YouTube 内容所有者相关联。
pageToken string
pageToken 参数用于标识结果集中应返回的特定页面。在 API 响应中，nextPageToken 和 prevPageToken 属性用于标识可以检索的其他页面。

请求正文

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

响应

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

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

属性

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

属性
kind string
标识 API 资源的类型。该值将为 youtube#channelListResponse。
etag etag
此资源的 ETag。
nextPageToken string
可用作 pageToken 参数值的令牌，用于检索结果集中的下一页。
prevPageToken string
可用作 pageToken 参数值的令牌，用于检索 结果集中的上一页。请注意，如果相应的 API 请求将 managedByMe 参数设置为 true，则 API 响应中不会包含此属性。
pageInfo object
The pageInfo 对象封装了结果集的分页信息。
pageInfo.totalResults integer
结果集中的结果总数。
pageInfo.resultsPerPage integer
API 响应中包含的结果数。
items[] list
与请求条件匹配的频道列表。

错误

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

错误类型 错误详情 说明
badRequest (400) invalidCriteria 最多可以指定以下过滤条件之一：id、categoryId、mine、managedByMe、forHandle、forUsername。如果通过 onBehalfOfContentOwner 参数进行内容所有者身份验证，则只能指定 id 或 managedByMe。
forbidden (403) channelForbidden id 参数指定的频道不支持该请求，或者该请求未获得适当授权。
notFound (404) categoryNotFound 找不到 categoryId 参数标识的类别。请使用 guideCategories.list 方法检索有效值列表。
notFound (404) channelNotFound 找不到 id 参数中指定的频道。

试试看！

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