Возвращает список пространств в организации Google Workspace на основе поиска администратора.
Требуется аутентификация пользователя с правами администратора . В запросе установите для useAdminAccess
значение true
.
HTTP-запрос
GET https://chat.googleapis.com/v1/spaces:search
URL-адрес использует синтаксис транскодирования gRPC .
Параметры запроса
Параметры | |
---|---|
useAdminAccess | Если Вызывающий пользователь должен быть администратором Google Workspace с правом управления чатом и беседами в чат-группах . Требуется область действия OAuth 2.0 В настоящее время этот метод поддерживает только доступ администратора, поэтому для этого поля принимается только |
pageSize | Максимальное количество возвращаемых пробелов. Служба может возвращать меньшее значение, чем это значение. Если не указано, возвращается не более 100 пробелов. Максимальное значение — 1000. Если вы используете значение больше 1000, оно автоматически изменится на 1000. |
pageToken | Токен, полученный от предыдущего вызова пространств поиска. Укажите этот параметр, чтобы получить следующую страницу. При разбиении на страницы все остальные предоставленные параметры должны соответствовать вызову, который предоставил токен страницы. Передача других значений другим параметрам может привести к неожиданным результатам. |
query | Необходимый. Поисковый запрос. Вы можете осуществлять поиск по следующим параметрам:
В разных полях поддерживаются только операторы В том же поле Следующие примеры запросов действительны:
|
orderBy | Необязательный. Как упорядочивается список пространств. Поддерживаемые атрибуты для упорядочения:
Допустимые значения операции заказа:
Поддерживаемый синтаксис:
|
Тело запроса
Тело запроса должно быть пустым.
Тело ответа
Ответ со списком пространств, соответствующих запросу пространств поиска.
В случае успеха тело ответа содержит данные следующей структуры:
JSON-представление |
---|
{
"spaces": [
{
object ( |
Поля | |
---|---|
spaces[] | Страница запрошенных мест. |
nextPageToken | Токен, который можно использовать для получения следующей страницы. Если это поле пусто, последующих страниц нет. |
totalSize | Общее количество пробелов, соответствующих запросу, на всех страницах. Если результат превышает 10 000 пробелов, это значение является приблизительным. |
Области авторизации
Требуется одна из следующих областей OAuth:
-
https://www.googleapis.com/auth/chat.admin.spaces
-
https://www.googleapis.com/auth/chat.admin.spaces.readonly
Дополнительную информацию см. в руководстве по авторизации .