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 пользователя из API People, либо id пользователя из API Directory. Например, чтобы найти все групповые чаты с вызывающим пользователем и двумя другими пользователями с идентификаторами профилей API People 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 .