Method: spaces.list

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

Требует аутентификации . Поддерживает аутентификацию приложений и аутентификацию пользователей .

Перечисляет пространства, видимые вызывающему абоненту или аутентифицированному пользователю. Групповые чаты и личные сообщения не отображаются в списке до тех пор, пока не будет отправлено первое сообщение.

Чтобы получить список всех именованных пространств по организациям Google Workspace, используйте вместо этого метод spaces.search() с правами администратора Workspace.

HTTP-запрос

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

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

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

Параметры
pageSize

integer

Необязательный. Максимальное количество возвращаемых пробелов. Служба может вернуть меньше этого значения.

Если не указано, возвращается не более 100 пробелов.

Максимальное значение — 1000. Если вы используете значение больше 1000, оно автоматически изменится на 1000.

Отрицательные значения возвращают ошибку INVALID_ARGUMENT .

pageToken

string

Необязательный. Токен страницы, полученный в результате предыдущего вызова пространств списка. Укажите этот параметр, чтобы получить следующую страницу.

При разбиении на страницы значение фильтра должно соответствовать вызову, который предоставил токен страницы. Передача другого значения может привести к неожиданным результатам.

filter

string

Необязательный. Фильтр запроса.

Вы можете фильтровать пространства по типу пространства ( spaceType ).

Для фильтрации по типу пространства необходимо указать допустимое значение перечисления, например SPACE или GROUP_CHAT ( spaceType не может быть SPACE_TYPE_UNSPECIFIED ). Чтобы запросить несколько типов пространств, используйте оператор OR .

Например, допустимы следующие запросы:

spaceType = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

Недействительные запросы отклоняются сервером с ошибкой INVALID_ARGUMENT .

Тело запроса

Тело запроса должно быть пустым.

Тело ответа

Ответ на запрос пространства списка.

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление
{
  "spaces": [
    {
      object (Space)
    }
  ],
  "nextPageToken": string
}
Поля
spaces[]

object ( Space )

Список мест на запрошенной (или первой) странице.

nextPageToken

string

Вы можете отправить токен как pageToken , чтобы получить следующую страницу результатов. Если пусто, последующих страниц нет.

Области авторизации

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

Дополнительную информацию см. в руководстве по авторизации .