Method: spaces.search

Возвращает список пространств в организации 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

boolean

Если true , метод запускается с использованием прав администратора Google Workspace пользователя.

Вызывающий пользователь должен быть администратором Google Workspace с привилегией управления чатами и беседами в пространствах .

Требуется область действия OAuth 2.0 chat.admin.spaces.readonly или chat.admin.spaces .

В настоящее время этот метод поддерживает только доступ администратора, поэтому для этого поля принимается только true .

pageSize

integer

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

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

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

pageToken

string

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

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

query

string

Обязательно. Поисковый запрос.

Вы можете осуществлять поиск, используя следующие параметры:

  • createTime
  • customer
  • displayName
  • externalUserAllowed
  • lastActiveTime
  • spaceHistoryState
  • spaceType

createTime и lastActiveTime принимают временную метку в формате RFC-3339, а поддерживаемые операторы сравнения: = , < , > , <= , >= .

customer является обязательным и используется для указания, у какого клиента следует извлекать пробелы. Поддерживается только одно значение: customers/my_customer

displayName принимает только оператор HAS ( : ). Сопоставляемый текст сначала разбивается на токены, и каждый токен сопоставляется с префиксом независимо и без учёта регистра как подстрока в любом месте displayName пространства. Например, Fun Eve соответствует Fun event или The evening was fun , но не notFun event или even .

externalUserAllowed принимает значения true или false .

spaceHistoryState принимает только значения из поля historyState ресурса space .

spaceType является обязательным и единственное допустимое значение — SPACE .

Для разных полей поддерживаются только операторы AND Допустимый пример: spaceType = "SPACE" AND displayName:"Hello" , а недопустимый пример: spaceType = "SPACE" OR displayName:"Hello" .

В пределах одного поля spaceType не поддерживает операторы AND и OR . displayName , 'spaceHistoryState' и 'externalUserAllowed' поддерживают только операторы OR . lastActiveTime и createTime поддерживают как операторы AND , так и OR . AND можно использовать только для представления интервала, например, lastActiveTime < "2022-01-01T00:00:00+00:00" AND lastActiveTime > "2023-01-01T00:00:00+00:00" .

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

customer = "customers/my_customer" AND spaceType = "SPACE"

customer = "customers/my_customer" AND spaceType = "SPACE" AND
displayName:"Hello World"

customer = "customers/my_customer" AND spaceType = "SPACE" AND
(lastActiveTime < "2020-01-01T00:00:00+00:00" OR lastActiveTime >
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND spaceType = "SPACE" AND
(displayName:"Hello World" OR displayName:"Fun event") AND
(lastActiveTime > "2020-01-01T00:00:00+00:00" AND lastActiveTime <
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND spaceType = "SPACE" AND
(createTime > "2019-01-01T00:00:00+00:00" AND createTime <
"2020-01-01T00:00:00+00:00") AND (externalUserAllowed = "true") AND
(spaceHistoryState = "HISTORY_ON" OR spaceHistoryState = "HISTORY_OFF")
orderBy

string

Необязательно. Как упорядочен список пространств.

Поддерживаемые атрибуты для сортировки:

  • membershipCount.joined_direct_human_user_count — Обозначает количество пользователей-людей, которые напрямую присоединились к пространству.
  • lastActiveTime — Обозначает время добавления последнего подходящего элемента в любую тему этого пространства.
  • createTime — Обозначает время создания пространства.

Допустимые значения операции упорядочивания:

  • ASC по возрастанию. Значение по умолчанию.

  • DESC по убыванию.

Поддерживаемый синтаксис:

  • membershipCount.joined_direct_human_user_count DESC
  • membershipCount.joined_direct_human_user_count ASC
  • lastActiveTime DESC
  • lastActiveTime ASC
  • createTime DESC
  • createTime ASC

Текст запроса

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

Тело ответа

Ответ со списком пространств, соответствующих запросу поисковых пространств.

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

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

object ( Space )

Страница запрошенных мест.

nextPageToken

string

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

totalSize

integer

Общее количество пробелов, соответствующих запросу, на всех страницах. Если результат превышает 10 000 пробелов, это значение является приблизительным.

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

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

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

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