此页面由 Cloud Translation API 翻译。

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 范围的授权令牌。此外，如果多频道网络决定接受或拒绝频道，或是在令牌发放日期后的两周内，则撤消使用该范围的令牌。

参数

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

参数
必需参数
`part`	`string` `part` 参数用于指定 API 响应将包含的一个或多个 `channel` 资源属性的英文逗号分隔列表。如果该参数标识了一个包含子媒体资源的属性，则子媒体资源将包含在响应中。例如，在 `channel` 资源中，`contentDetails` 属性包含 `uploads` 等其他属性。因此，如果您设置了 `part=contentDetails`，API 响应还将包含所有这些嵌套属性。以下列表包含可在参数值中包含的 `part` 名称： `auditDetails` `brandingSettings` `contentDetails` `contentOwnerDetails` `id` `localizations` `snippet` `statistics` `status` `topicDetails`
过滤器（请准确指定以下参数之一）
`categoryId`	`string` 此参数已被弃用。 `categoryId` 参数指定了 YouTube 导视类别，可用于请求与该类别关联的 YouTube 频道。
`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`（含 0 和 5000）。默认值为 `5`。
`onBehalfOfContentOwner`	`string` 此参数只能在正确的授权请求中使用。注意：此参数专供 YouTube 内容合作伙伴使用。 `onBehalfOfContentOwner` 参数表示请求的授权凭据用于标识代表参数值中指定的内容所有者执行操作的 YouTube CMS 用户。此参数适用于拥有和管理许多不同 YouTube 频道的 YouTube 内容合作伙伴。内容所有者只需进行一次身份验证，即可访问自己所有的视频和频道数据，而无需为每个频道提供身份验证凭据。用户身份验证所用的 CMS 帐号必须与指定的 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` `pageInfo` 对象用于封装结果集的分页信息。
`pageInfo.totalResults`	`integer` 结果集中的结果总数。
`pageInfo.resultsPerPage`	`integer` API 响应中包含的结果数。
`items[]`	`list` 与请求条件匹配的频道列表。

错误

下表列出了该 API 为响应对此方法的调用可能返回的错误消息。如需了解详情，请参阅错误消息文档。

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

试试看！

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