Method: spaces.members.list

Elenca le iscrizioni a uno spazio. Per un esempio, vedi Elencare utenti e app di Google Chat in uno spazio. Le iscrizioni alla scheda con autenticazione delle app elencano le iscrizioni negli spazi a cui ha accesso l'app Chat, ma sono escluse quelle relative all'app Chat, incluse le proprie. L'elenco delle iscrizioni con Autenticazione utente elenca le appartenenze agli spazi a cui ha accesso l'utente autenticato.

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

Richiesta HTTP

GET https://chat.googleapis.com/v1/{parent=spaces/*}/members

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
parent

string

obbligatorio. Il nome della risorsa dello spazio per cui recuperare un elenco di appartenenza.

Formato: spazi/{space}

Parametri di ricerca

Parametri
pageSize

integer

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

Se non specificati, vengono restituiti al massimo 100 appartenenze.

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 chiamata precedente a elencare le iscrizioni. 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.

filter

string

Campo facoltativo. Un filtro di query.

Puoi filtrare le iscrizioni in base al ruolo (role) e al tipo (member.type) di ciascun membro.

Per filtrare in base al ruolo, imposta role su ROLE_MEMBER o ROLE_MANAGER.

Per filtrare per tipo, imposta member.type su HUMAN o BOT.

Per filtrare in base al ruolo e al tipo, utilizza l'operatore AND. Per filtrare in base al ruolo o al tipo, utilizza l'operatore OR.

Ad esempio, le seguenti query sono valide:

role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
member.type = "HUMAN" AND role = "ROLE_MANAGER"

Le seguenti query non sono valide:

member.type = "HUMAN" AND member.type = "BOT"
role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"

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

showGroups

boolean

Campo facoltativo. Quando true, restituisce anche gli abbonamenti associati a un Google Group, oltre ad altri tipi di abbonamenti. Se viene impostato un filter, le appartenenze a Google Group che non corrispondono ai criteri del filtro non vengono restituite.

showInvited

boolean

Campo facoltativo. Quando true, restituisce anche gli abbonamenti associati a invited, oltre ad altri tipi di abbonamenti. Se è impostato un filtro, le appartenenze a invited che non corrispondono ai criteri del filtro non vengono restituite.

Attualmente richiede l'autenticazione dell'utente.

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
{
  "memberships": [
    {
      object (Membership)
    }
  ],
  "nextPageToken": string
}
Campi
memberships[]

object (Membership)

Elenco non ordinato. Elenco di appartenenze nella pagina richiesta (o nella prima).

nextPageToken

string

Un token che puoi inviare 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.import
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

Per ulteriori informazioni, consulta la guida all'autorizzazione.