Требуется область OAuth 2.0chat.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 принимает только значения из поля historyStatespace ресурса.
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 — Обозначает время создания пространства.
Токен, который можно использовать для получения следующей страницы. Если это поле пустое, последующих страниц нет.
totalSize
integer
Общее количество пробелов, соответствующих запросу, на всех страницах. Если результат превышает 10 000 пробелов, это значение является приблизительным.
[[["Прост для понимания","easyToUnderstand","thumb-up"],["Помог мне решить мою проблему","solvedMyProblem","thumb-up"],["Другое","otherUp","thumb-up"]],[["Отсутствует нужная мне информация","missingTheInformationINeed","thumb-down"],["Слишком сложен/слишком много шагов","tooComplicatedTooManySteps","thumb-down"],["Устарел","outOfDate","thumb-down"],["Проблема с переводом текста","translationIssue","thumb-down"],["Проблемы образцов/кода","samplesCodeIssue","thumb-down"],["Другое","otherDown","thumb-down"]],["Последнее обновление: 2025-01-24 UTC."],[[["Returns a paginated list of Google Workspace spaces based on an administrator's search criteria, including parameters like displayName, createTime, and spaceType."],["Requires administrator privileges and the `useAdminAccess` parameter set to `true` in the request."],["Utilizes the `GET https://chat.googleapis.com/v1/spaces:search` HTTP request with query parameters for customization."],["Needs authorization with either the `chat.admin.spaces` or `chat.admin.spaces.readonly` OAuth scope."],["Response body includes an array of spaces, a token for pagination, and an estimate of the total number of matching spaces."]]],["To search for Google Workspace spaces, send a `GET` request to `https://chat.googleapis.com/v1/spaces:search`, ensuring admin privileges and setting `useAdminAccess` to `true`. Define the search using query parameters, including a required `query` to filter spaces (by `customer`, `displayName`, etc.), optional `pageSize` and `pageToken` for pagination, and optional `orderBy` for sorting. You must have one of the authorization scopes: `chat.admin.spaces` or `chat.admin.spaces.readonly`. The response will list spaces matching the query.\n"]]
