此页面由 Cloud Translation API 翻译。

Members: list

注意：此端点只能供个人创作者申请他们自己的启用了频道会员功能的 YouTube 频道。请联系您的 Google 或 YouTube 代表，请求访问权限。

列出频道的成员（以前称为“赞助商”）。该 API 请求必须由频道所有者授权。

配额影响：调用此方法的配额费用为 2 个单位。

请求

HTTP 请求

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

授权

此请求需要获得以下范围的授权：

范围
`https://www.googleapis.com/auth/youtube.channel-memberships.creator`

参数

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

参数
必需参数
`part`	`string` `part` 参数用于指定 API 响应将包含的 `member` 资源属性。将参数值设为 `snippet`。
可选参数
`mode`	`string` `mode` 参数用于指明该 API 响应中将包含哪些成员。将参数值设为以下值之一： `all_current`（默认）- 列出当前成员（从最新到最早）。如果使用此值，当 API 响应不包含 `nextPageToken` 时，系统会到达列表末尾。 `updates` - 仅列出自上次 API 调用以来加入或升级的成员。请注意，第一次调用会启动一个新的更新流，但不会实际返回任何成员。如需开始检索成员资格更新，您需要使用 `nextPageToken` 以所需的频率轮询端点。请注意，当使用此值时，API 响应始终包含 `nextPageToken`。
`maxResults`	`unsigned integer` `maxResults` 参数用于指定结果集中应返回的最大项数。可接受的值包括`0`到`1000`（含 0 和 5000）。默认值为 `5`。
`pageToken`	`string` `pageToken` 参数用于标识应返回的结果集中的特定页面。该令牌特定于原始 API 请求所使用的 `mode`，因此您无法使用一种模式检索到的页面令牌随后切换到其他模式。
`hasAccessToLevel`	`string` `hasAccessToLevel` 参数值是一个级别 ID，用于指定结果集中的成员应达到的最低级别。
`filterByMemberChannelId`	`string` `filterByMemberChannelId` 参数指定以英文逗号分隔的频道 ID 列表，可用于检查特定用户的成员资格状态。例如 `UC_1,UC_2,UC_3`。每次调用最多可以指定 100 个通道。

请求正文

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

响应

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

{
  "kind": "youtube#memberListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    member Resource
  ]
}

属性

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

属性
`kind`	`string` 标识 API 资源类型。值为 `youtube#memberListResponse`。
`etag`	`etag` 此资源的 Etag。
`nextPageToken`	`string` 可用作 `pageToken` 参数值以检索结果集中的下一页的令牌。页面令牌可能会过期，您的应用应删除此令牌并调用不带 `pageToken` 的 API 以启动新请求。
`pageInfo`	`object` `pageInfo` 对象用于封装结果集的分页信息。
`pageInfo.totalResults`	`integer` 结果集中的结果总数。
`pageInfo.resultsPerPage`	`integer` API 响应中包含的结果数。
`items[]`	`list` 符合请求条件的成员列表。

错误

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

错误类型	错误详情	说明
`badRequest (400)`	`channelMembershipsNotEnabled`	授权请求的创作者频道未启用频道会员功能。
`badRequest (400)`	`invalidMode`	`mode` 参数值无效。如果 `pageToken` 参数指定了使用与指定模式不同的模式检索的令牌，则可能会发生此错误。
`badRequest (400)`	`invalidPageToken`	`pageToken` 参数值无效。如果请求中使用的页面令牌已过期或无法识别，则可能会发生此错误。
`badRequest (400)`	`invalidHasAccessToLevel`	`hasAccessToLevel` 参数值无效。指定的 `id` 没有级别。
`badRequest (400)`	`invalidFilterByMemberChannelId`	`filterByMemberChannelId` 参数值无效。如果 `filterByMemberChannelId` 参数值指定超过 100 个通道，则会出现此错误。