Method: spaces.search

Возвращает список пространств в организации Google Workspace на основе поиска администратора.

Требуется аутентификация пользователя с правами администратора . В запросе установите для useAdminAccess значение true .

HTTP-запрос

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

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

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

Параметры
use Admin Access

boolean

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

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

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

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

page Size

integer

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

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

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

page Token

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")
order By

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 )

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

next Page Token

string

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

total Size

integer

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

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

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

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

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