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

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