Method: spaces.list

Elenca gli spazi di cui il chiamante è membro e che sono visibili al chiamante o all'utente autenticato. Richiede l'autenticazione. Supporta completamente l'autenticazione degli account di servizio.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri di ricerca

Parametri
pageSize

integer

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

Se non viene specificato un valore, vengono restituiti al massimo 100 spazi.

Il valore massimo è 1000; i valori superiori a 1000 sono forzati a 1000.

I valori negativi restituiscono un errore INVALID_EXPIRE.

pageToken

string

(Facoltativo) Un token di pagina, ricevuto da una precedente chiamata a spazi di elenco. Forniscilo 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ò causare risultati imprevisti.

filter

string

(Facoltativo) Un filtro di query.

Richiede l'autenticazione utente.

L'API supporta il filtro per spaceType.

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_EXPIRE.

Con l'autenticazione dell'account di servizio, questo campo viene ignorato e la query restituisce sempre tutti gli spazi. Tuttavia, l'API Chat convalida ancora la sintassi delle query con gli account di servizio, quindi le query non valide vengono comunque rifiutate.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

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 prima).

nextPageToken

string

Un token che può essere inviato 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 scoprire di più, consulta la Guida alle autorizzazioni.