Method: spaces.findGroupChats

返回 spaceType == GROUP_CHAT 的所有聊天室，这些聊天室的人类成员资格恰好包含调用用户和 FindGroupChatsRequest.users 中指定的用户。仅支持已加入对话的成员。如需查看示例，请参阅查找群组聊天。

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

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

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

  • 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 转码语法。

查询参数

参数
users[]

string

可选。与调用用户进行群聊的所有人类用户的资源名称。聊天应用不能包含在请求中。

单个请求中可指定的最大用户数为 49。

格式：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 用户的电子邮件地址。
pageSize

integer

可选。要返回的聊天室数量上限。服务可能会返回小于此值的结果。

如果未指定，则最多返回 10 个聊天室。

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

负值会返回 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。