Richiede l'ambito OAuth 2.0chat.admin.spaces.readonly o chat.admin.spaces.
Al momento, questo metodo supporta solo l'accesso amministrativo, pertanto per questo campo è accettato solo true.
pageSize
integer
Il numero massimo di spazi da restituire. Il servizio potrebbe restituire meno di questo valore.
Se non specificato, vengono restituiti al massimo 100 spazi.
Il valore massimo è 1000. Se utilizzi un valore superiore a 1000, questo viene modificato automaticamente in 1000.
pageToken
string
Un token, ricevuto dalla chiamata precedente agli spazi di ricerca. Specifica questo parametro per recuperare la pagina successiva.
Durante l'impaginazione, tutti gli altri parametri forniti devono corrispondere alla chiamata che ha fornito il token della pagina. Il trasferimento di valori diversi agli altri parametri potrebbe portare a risultati imprevisti.
query
string
Obbligatorio. Una query di ricerca.
Puoi eseguire ricerche utilizzando i seguenti parametri:
createTime
customer
displayName
externalUserAllowed
lastActiveTime
spaceHistoryState
spaceType
createTime e lastActiveTime accettano un timestamp nel formato RFC-3339 e gli operatori di confronto supportati sono: =, <, >, <= e >=.
customer è obbligatorio e viene utilizzato per indicare da quale cliente recuperare gli spazi. customers/my_customer è l'unico valore supportato.
displayName accetta solo l'operatore HAS (:). Il testo da associare viene prima tokenizzato in token e ciascun token viene associato al prefisso indipendentemente dalle maiuscole e minuscole come sottostringa in qualsiasi punto di displayName dello spazio. Ad esempio, Fun Eve corrisponde a Fun event o The
evening was fun, ma non a notFun event o even.
externalUserAllowed accetta true o false.
spaceHistoryState accetta solo i valori del campo historyState di una risorsa space.
spaceType è obbligatorio e l'unico valore valido è SPACE.
In diversi campi sono supportati solo gli operatori AND. Un esempio valido è spaceType = "SPACE" AND displayName:"Hello" e un esempio non valido è spaceType = "SPACE" OR displayName:"Hello".
Nello stesso campo, spaceType non supporta gli operatori AND o OR. displayName, "spaceHistoryState" e "externalUserAllowed" supporta solo gli operatori OR. lastActiveTime e createTime supportano sia gli operatori AND che OR. AND può essere utilizzato solo per rappresentare un intervallo, ad esempio lastActiveTime
< "2022-01-01T00:00:00+00:00" AND lastActiveTime >
"2023-01-01T00:00:00+00:00".
Le seguenti query di esempio sono valide:
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
(Facoltativo) Come viene ordinato l'elenco degli spazi.
Gli attributi supportati per l'ordinamento sono:
membershipCount.joined_direct_human_user_count: indica il numero di utenti che sono entrati direttamente in uno spazio.
lastActiveTime: indica la data e l'ora in cui l'ultimo elemento idoneo viene aggiunto a qualsiasi argomento di questo spazio.
createTime: indica l'ora in cui è stato creato lo spazio.
I valori validi per le operazioni di ordinamento sono:
[[["Facile da capire","easyToUnderstand","thumb-up"],["Il problema è stato risolto","solvedMyProblem","thumb-up"],["Altra","otherUp","thumb-up"]],[["Mancano le informazioni di cui ho bisogno","missingTheInformationINeed","thumb-down"],["Troppo complicato/troppi passaggi","tooComplicatedTooManySteps","thumb-down"],["Obsoleti","outOfDate","thumb-down"],["Problema di traduzione","translationIssue","thumb-down"],["Problema relativo a esempi/codice","samplesCodeIssue","thumb-down"],["Altra","otherDown","thumb-down"]],["Ultimo aggiornamento 2025-02-27 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"]]
