- Richiesta HTTP
- Parametri di ricerca
- Corpo della richiesta
- Corpo della risposta
- Ambiti di autorizzazione
- Prova!
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 | |
---|---|
use |
Se L'utente che chiama deve essere un amministratore di Google Workspace con il privilegio di gestione delle conversazioni di Chat e spazi. Richiede l'ambito OAuth 2.0 Al momento questo metodo supporta solo l'accesso amministrativo, pertanto per questo campo è accettato solo |
page |
Il numero massimo di spazi da restituire. Il servizio potrebbe restituire un valore inferiore a questo valore. Se non specificato, vengono restituiti al massimo 100 spazi. Il valore massimo è 1000. Se utilizzi un valore superiore a 1000, il valore viene modificato automaticamente in 1000. |
page |
Un token ricevuto dalla chiamata dello spazio di ricerca precedente. Fornisci questo parametro per recuperare la pagina successiva. Quando viene applicata la paginazione, tutti gli altri parametri forniti devono corrispondere alla chiamata che ha fornito il token pagina. Il trasferimento di valori diversi agli altri parametri può portare a risultati imprevisti. |
query |
Obbligatorio. Una query di ricerca. Puoi eseguire ricerche utilizzando i seguenti parametri:
In diversi campi, sono supportati solo gli operatori Nello stesso campo, Le seguenti query di esempio sono valide:
|
order |
(Facoltativo) L'ordinamento dell'elenco di spazi. Gli attributi supportati per l'ordinamento sono:
I valori validi per le operazioni di ordinamento sono:
La sintassi supportata è:
|
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 ( |
Campi | |
---|---|
spaces[] |
Una pagina degli spazi richiesti. |
next |
Un token che può essere utilizzato per recuperare la pagina successiva. Se questo campo è vuoto, non ci saranno pagine successive. |
total |
Il numero totale di spazi che corrispondono alla query in tutte le pagine. Se il risultato supera i 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.