Method: spaces.list

Elenca gli spazi di cui il chiamante è membro. Le chat di gruppo e i messaggi diretti non vengono elencati finché non viene inviato il primo messaggio. Per un esempio, vedi Elencare gli spazi.

Richiede l'autenticazione. Supporta l'autenticazione delle app e l'autenticazione degli utenti.

Elenca gli spazi visibili al chiamante o all'utente autenticato. Le chat di gruppo e i messaggi diretti non vengono elencati finché non viene inviato il primo messaggio.

Per elencare tutti gli spazi denominati dell'organizzazione Google Workspace, utilizza il metodo spaces.search() utilizzando i privilegi di amministratore di Workspace.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri di query

Parametri
pageSize

integer

(Facoltativo) Il numero massimo di spazi da restituire. Il servizio potrebbe restituire un valore inferiore a questo valore.

Se non specificati, vengono restituiti al massimo 100 spazi.

Il valore massimo è 1000. Se utilizzi un valore superiore a 1000, il valore viene modificato automaticamente in 1000.

I valori negativi restituiscono un errore INVALID_ARGUMENT.
pageToken

string

(Facoltativo) Un token di pagina, ricevuto da una precedente chiamata agli spazi di elenco. Fornisci questo parametro per recuperare la pagina successiva.

Durante l'impaginazione, il valore del filtro deve corrispondere alla chiamata che ha fornito il token della pagina. Il passaggio di un valore diverso può portare a risultati imprevisti.
filter

string

(Facoltativo) Un filtro di query.

Puoi filtrare gli spazi in base al tipo (spaceType).

Per filtrare in base al tipo di spazio, devi specificare un valore enum valido, come SPACE o GROUP_CHAT (il spaceType non può essere SPACE_TYPE_UNSPECIFIED). Per eseguire query su più tipi di spazi, utilizza l'operatore OR.

Ad esempio, le seguenti query sono valide:

spaceType = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

Le query non valide vengono rifiutate dal server con un errore INVALID_ARGUMENT.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

La risposta per una richiesta di elenchi spazi.

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

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

object (Space)

Elenco degli spazi nella pagina richiesta (o nella prima).
nextPageToken

string

Puoi inviare un token come pageToken per recuperare la pagina successiva di risultati. Se è vuoto, non ci sono pagine successive.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta la Guida all'autorizzazione.