Method: spaces.list

Elenca gli spazi di cui è membro il chiamante. Le chat di gruppo e i messaggi diretti vengono inseriti nell'elenco solo dopo l'invio del primo messaggio. Per un esempio, vedi Elencare gli spazi.

Richiede autenticazione. Supporta l'autenticazione delle app e l'autenticazione utente.

Elenca gli spazi visibili al chiamante o all'utente autenticato. Le chat di gruppo e i messaggi diretti vengono inseriti nell'elenco solo dopo l'invio del primo messaggio.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri di ricerca

Parametri
pageSize

integer

Campo facoltativo. Il numero massimo di spazi da restituire. Il servizio potrebbe restituire meno di questo valore.

Se non specificati, vengono restituiti al massimo 100 spazi.

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

I valori negativi restituiscono un errore INVALID_ARGUMENT.

pageToken

string

Campo facoltativo. Un token di pagina, ricevuto da una precedente chiamata agli spazi elenco. Specifica 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. Se trasmetti un valore diverso, potresti ottenere risultati imprevisti.

filter

string

Campo facoltativo. Un filtro di query.

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

Per filtrare per tipo di spazio, devi specificare un valore enum valido, ad esempio SPACE o GROUP_CHAT (il spaceType non può essere SPACE_TYPE_UNSPECIFIED). Per eseguire query relative a più tipi di spazio, 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 a una richiesta di elenco di 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 di spazi nella pagina richiesta (o nella prima).

nextPageToken

string

Puoi inviare un token come pageToken per recuperare la pagina dei risultati successiva. Se è vuoto, non ci saranno 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.