Method: spaces.members.list

列出聊天室中的会员。如需查看示例，请参阅列出聊天室中的用户和 Google Chat 应用。使用 app 身份验证列出成员时，会列出 Chat 应用有权访问的聊天室中的成员，但会排除 Chat 应用成员（包括其自身）。列出具有用户身份验证的会员资格会列出经过身份验证的用户有权访问的会议室中的会员资格。

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

  • 应用身份验证，并具有以下授权范围之一：

    • https://www.googleapis.com/auth/chat.bot
    • https://www.googleapis.com/auth/chat.app.memberships（需要管理员审批）

  • 使用以下授权范围之一进行用户身份验证：

    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.import（仅限“导入模式聊天室”）
    • 当管理员账号通过身份验证、useAdminAccess 为 true 且使用以下授权范围之一时，用户身份验证会授予管理员权限：
      • https://www.googleapis.com/auth/chat.admin.memberships.readonly
      • https://www.googleapis.com/auth/chat.admin.memberships

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

必需。要获取其会员列表的会议室的资源名称。

格式：spaces/{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.app.memberships
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

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