Method: spaces.members.list

列出聊天室中的成员资格。如需查看示例，请参阅列出聊天室中的用户和 Google Chat 应用。列出通过应用身份验证的成员资格时，系统会列出 Chat 应用有权访问的聊天室中的成员资格，但不包括 Chat 应用成员资格，包括自己的成员资格。使用用户身份验证列出会员资格会列出已通过身份验证的用户有权访问的聊天室中的会员资格。

支持以下类型的身份验证：

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

必需。要获取其成员名单的聊天室的资源名称。

格式：空格/{space}

查询参数

参数
pageSize

integer

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

如果未指定，则最多返回 100 个成员。

最大值为 1000。如果您使用的值超过 1000，系统会自动将其更改为 1000。

负值会返回 INVALID_ARGUMENT 错误。
pageToken

string

可选。从之前的列出会员资格的调用接收的页面令牌。提供此参数以检索后续页面。

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

string

可选。查询过滤条件。

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

如需按角色进行过滤，请将 role 设置为 ROLE_MEMBER 或 ROLE_MANAGER。

如需按类型进行过滤，请将 member.type 设置为 HUMAN 或 BOT。您还可以使用 != 运算符针对 member.type 进行过滤。

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

将 useAdminAccess 设置为 true 时，必须提供 member.type = "HUMAN" 或 member.type != "BOT"。其他成员类型过滤条件将被拒绝。

例如，以下查询是有效的：

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

member.type != "BOT"

以下查询无效：

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

服务器会拒绝无效查询，并返回 INVALID_ARGUMENT 错误。
showGroups

boolean

可选。如果为 true，则除了返回其他类型的成员资格之外，还会返回与 Google Group 关联的成员资格。如果设置了 filter，系统不会返回与过滤条件不匹配的 Google Group 成员资格。
showInvited

boolean

可选。如果为 true，除了其他类型的会员资格外，还会返回与 invited 会员相关联的会员资格。如果设置了过滤条件，则系统不会返回不符合过滤条件的 invited 个成员资格。

目前需要用户身份验证。
useAdminAccess

boolean

如果为 true，此方法会以用户的 Google Workspace 管理员权限运行。

发起通话的用户必须是拥有管理聊天和聊天室对话权限的 Google Workspace 管理员。

需要 chat.admin.memberships.readonly 或 chat.admin.memberships OAuth 2.0 范围。

使用管理员访问权限时，不支持在聊天室中列出应用成员资格。

请求正文

请求正文必须为空。

响应正文

对聊天室成员列表的响应。

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

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

object (Membership)

无序列表。所请求的页面（或第一页）中的成员资格列表。
nextPageToken

string

可作为 pageToken 发送以检索下一页结果的令牌。如果为空，则没有后续页面。

授权范围

需要以下 OAuth 范围之一：

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

有关详情，请参阅授权指南。