Method: spaces.search

Restituisce un elenco di spazi in un'organizzazione Google Workspace in base alla ricerca di un amministratore.

Richiede l'autenticazione dell'utente con privilegi amministrativi. Nella richiesta, imposta useAdminAccess su true.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri di query

Parametri
useAdminAccess

boolean

Se true, il metodo viene eseguito utilizzando i privilegi di amministratore di Google Workspace dell'utente.

L'utente che effettua la chiamata deve essere un amministratore di Google Workspace con il privilegio Gestisci spazi e conversazioni di Chat.

Richiede l'ambito OAuth 2.0 chat.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:

  • ASC per l'ordine crescente. Valore predefinito.

  • DESC per la modalità discendente.

Le sintassi supportate sono:

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

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

Risposta con un elenco di spazi corrispondenti alla richiesta di spazi di ricerca.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "spaces": [
    {
      object (Space)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Campi
spaces[]

object (Space)

Una pagina degli spazi richiesti.
nextPageToken

string

Un token che può essere utilizzato per recuperare la pagina successiva. Se questo campo è vuoto, non ci saranno pagine successive.
totalSize

integer

Il numero totale di spazi che corrispondono alla query in tutte le pagine. Se il risultato è superiore a 10.000 spazi, questo valore è una stima.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta la Guida all'autorizzazione.