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（含端点值）。默认值为 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
The 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 个，则会发生此错误。