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

В URL-адресе используется синтаксис транскодирования gRPC .

Параметры запроса

Параметры
user[]

string

Имена ресурсов всех пользователей, участвующих в групповом чате с вызывающим пользователем. Приложения для чата в запрос не включаются.

Формат: users/{user} , где {user} — это либо id пользователя из People API, либо id пользователя в Directory API. Например, чтобы найти все групповые чаты с вызывающим пользователем и двумя другими пользователями, имеющими идентификаторы профилей People API 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.
SPACE_VIEW_EXPANDED Заполняет поля ресурса Space. Примечание: поле permissionSettings заполняться не будет. Запросы, указывающие SPACE_VIEW_EXPANDED, должны включать области действия, разрешающие чтение данных Space, например, https://www.googleapis.com/auth/chat.spaces или https://www.googleapis.com/auth/chat.spaces.readonly .