Method: spaces.findGroupChats

返回所有具有 spaceType == GROUP_CHAT 的聊天室，这些聊天室的人员成员中仅包含调用用户和 FindGroupChatsRequest.memberships 中指定的用户。

如果调用用户屏蔽了某些用户或被某些用户屏蔽，并且找不到包含指定的所有用户的聊天室，此方法会返回不包含被屏蔽用户或屏蔽用户的聊天室。

指定的用户集必须仅包含人工（非应用）成员。包含非人类用户的请求不会返回任何会议室。

需要使用以下某个授权范围进行用户身份验证：

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

HTTP 请求

GET https://chat.googleapis.com/v1/spaces:findGroupChats

网址采用 gRPC 转码语法。

查询参数

参数
user[]

string

群组聊天中所有人类用户的资源名称，包括调用用户。聊天应用不能包含在请求中。

格式：users/{user}，其中 {user} 是 People API 中人员的 id，或 Directory API 中用户的 id。例如，如需查找包含通话用户和另外两名用户（People API 个人资料 ID 为 123456789 和 987654321）的所有群组聊天，您可以使用 users/123456789 和 users/987654321。您还可以将该电子邮件地址用作 {user} 的别名。例如，users/example@gmail.com，其中 example@gmail.com 是 Google Chat 用户的电子邮件地址。

如果调用用户是 Google Workspace 用户，则所有请求的用户都必须与调用用户属于同一 Google Workspace 组织。
pageSize

integer

可选。要返回的空间数量上限。服务返回的设备层级配置数量可能小于此值。

如果未指定，则最多返回 100 个空间。

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

负值会返回 INVALID_ARGUMENT 错误。
pageToken

string

可选。从之前对查找群聊的调用接收的页面令牌。提供此参数以检索后续页面。

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

enum (SpaceView)

所请求的聊天室视图类型。如果未设置，则默认为 SPACE_VIEW_RESOURCE_NAME_ONLY。指定 SPACE_VIEW_EXPANDED 的请求必须包含允许读取聊天室数据的范围，例如 https://www.googleapis.com/auth/chat.spaces 或 https://www.googleapis.com/auth/chat.spaces.readonly。

请求正文

请求正文必须为空。

响应正文

包含群组聊天室的响应，其中仅包含调用用户和所请求的用户。

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

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

object (Space)

所请求页面（或第一个页面）中的聊天室列表。
nextPageToken

string

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

授权范围

需要以下 OAuth 范围之一：

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

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

SpaceView

一种视图，用于指定应在 Space 资源中填充哪些字段。为确保与未来版本兼容，我们建议您的代码考虑其他值。

枚举
SPACE_VIEW_UNSPECIFIED 默认值 / 未设置的值。
SPACE_VIEW_RESOURCE_NAME_ONLY 仅填充空间资源名称。
SPACE_VIEW_EXPANDED 填充聊天室资源字段。注意：permissionSettings 字段将不会填充任何内容。指定 SPACE_VIEW_EXPANDED 的请求必须包含允许读取聊天室数据的范围，例如 https://www.googleapis.com/auth/chat.spaces 或 https://www.googleapis.com/auth/chat.spaces.readonly。