Method: spaces.search

boolean

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

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

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

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

integer

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

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

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

string

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

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

string

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

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

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

Когда useAdminAccess установлен в false :

• displayName
• externalUserAllowed

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

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

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

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

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

spaceType является обязательным, если useAdminAccess установлен в true , и единственно допустимое значение — 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" .

Следующие примеры запросов являются допустимыми, если useAdminAccess установлен в true :

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

Следующие примеры запросов являются допустимыми, если useAdminAccess установлен в false :

displayName:"Hello World"

(displayName:"Hello" OR displayName:"Fun")

(externalUserAllowed = "true") // Returns an empty response.

(externalUserAllowed = "true" AND displayName:"Hello")

string

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

Для сортировки поддерживаются следующие атрибуты:

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

Если useAdminAccess имеет false , для сортировки поддерживаются только поля createTime и relevance . В поиске без прав администратора для этих полей поддерживается только порядок DESC .

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

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

• DESC означает «нисходящий».

Поддерживаемый синтаксис — это когда useAdminAccess установлен в true :

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

Когда useAdminAccess установлен в false :

• createTime DESC
• relevance DESC

object ( Space )

Только вывод. Совпадающий пробел.