Method: spaces.members.list

列出聊天室中的成员资格。如需查看示例,请参阅列出成员资格。使用应用身份验证列出成员资格时,系统会列出 Chat 应用有权访问的聊天室中的成员资格,但不包括 Chat 应用成员资格(包括其自身的成员资格)。使用用户身份验证列出成员资格后,系统会列出经过身份验证的用户有权访问的聊天室中的成员资格。

需要身份验证。完全支持服务帐号身份验证用户身份验证用户身份验证需要 chat.membershipschat.memberships.readonly 授权范围。

HTTP 请求

GET https://chat.googleapis.com/v1/{parent=spaces/*}/members

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

必需。要提取成员资格列表的聊天室的资源名称。

格式:空格/{空格}

查询参数

参数
pageSize

integer

要返回的成员资格数量上限。服务返回的值可能会低于此值。

如果未指定,则最多返回 100 个成员资格。

最大值为 1,000。如果您使用的值大于 1,000,则会自动更改为 1,000。

负值会返回 INVALID_ARGUMENT 错误。

pageToken

string

从上一次对列出成员资格的调用中获得的网页令牌。提供此参数以检索后续页面。

进行分页时,提供的所有其他参数都应与提供页面令牌的调用匹配。向其他参数传递不同的值可能会导致意外结果。

filter

string

可选。查询过滤条件。

您可以按成员的角色 (role) 和类型 (member.type) 过滤成员资格。

如需按角色过滤,请将 role 设置为 ROLE_MEMBERROLE_MANAGER

如需按类型过滤,请将 member.type 设置为 HUMANBOT

如需同时按角色和类型过滤,请使用 AND 运算符。如需按角色或类型过滤,请使用 OR 运算符。

例如,以下查询有效:

role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
member.type = "HUMAN" AND role = "ROLE_MANAGER"

以下查询无效:

member.type = "HUMAN" AND member.type = "BOT"
role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"

无效查询会被服务器拒绝并出现 INVALID_ARGUMENT 错误。

showInvited

boolean

可选。当 true 时,除了其他类型的成员资格外,还会返回与 invited 成员关联的成员资格。如果您设置了过滤条件,则系统不会返回与过滤条件不匹配的 invited 成员资格。

目前,您需要进行用户身份验证

请求正文

请求正文必须为空。

响应正文

如果成功,响应正文将包含结构如下的数据:

JSON 表示法
{
  "memberships": [
    {
      object (Membership)
    }
  ],
  "nextPageToken": string
}
字段
memberships[]

object (Membership)

所请求的(或第一个)页面中的成员列表。

nextPageToken

string

可以作为 pageToken 发送的令牌,用于检索下一页结果的令牌。如果为空,则不存在后续页面。

授权范围

需要以下 OAuth 范围之一:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

如需了解详情,请参阅授权指南