Возвращает список пространств в организации Google Workspace на основе поиска администратора. В запросе установите useAdminAccess
в true
. Пример см. в разделе Поиск и управление пространствами .
Требуется аутентификация пользователя с правами администратора и одной из следующих областей авторизации :
-
https://www.googleapis.com/auth/chat.admin.spaces.readonly
-
https://www.googleapis.com/auth/chat.admin.spaces
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
Более подробную информацию смотрите в Руководстве по авторизации .