Method: spaces.members.list

Elenca le iscrizioni in uno spazio. Per un esempio, vedi Elenco di utenti e app Google Chat in uno spazio. L'elenco dei membri con autenticazione app elenca i membri degli spazi a cui ha accesso l'app Chat, ma esclude i membri dell'app Chat, inclusi i suoi. La scheda delle iscrizioni con Autenticazione utente elenca le iscrizioni agli spazi a cui l'utente autenticato ha accesso.

Supporta i seguenti tipi di autenticazione:

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 il quale recuperare un elenco di membri.

Formato: workspace/{space}

Parametri di query

Parametri
pageSize

integer

(Facoltativo) Il numero massimo di abbonamenti da restituire. Il servizio potrebbe restituire meno di questo valore.

Se non specificato, vengono restituiti al massimo 100 abbonamenti.

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

I valori negativi restituiscono un errore INVALID_ARGUMENT.
pageToken

string

(Facoltativo) Un token di pagina ricevuto da una chiamata precedente per elencare le iscrizioni. Specifica 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. Se passi valori diversi agli altri parametri, potresti ottenere risultati imprevisti.
filter

string

(Facoltativo) Un filtro di query.

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

Per filtrare per ruolo, imposta role su ROLE_MEMBER o ROLE_MANAGER.

Per filtrare per tipo, imposta member.type su HUMAN o BOT. Puoi anche filtrare in base a member.type utilizzando l'operatore !=.

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

member.type = "HUMAN" o member.type != "BOT" è obbligatorio quando useAdminAccess è impostato su true. Gli altri filtri dei tipi di membri verranno rifiutati.

Ad esempio, le seguenti query sono valide:

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

member.type != "BOT"

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

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

boolean

(Facoltativo) Quando true, restituisce anche gli abbonamenti associati ai membri invited, oltre ad altri tipi di abbonamenti. Se è impostato un filtro, gli abbonamenti a invited che non corrispondono ai criteri del filtro non vengono restituiti.

Attualmente richiede l'autenticazione dell'utente.
useAdminAccess

boolean

Se true, il metodo viene eseguito utilizzando i privilegi di amministratore di Google Workspace dell'utente.

L'utente che effettua la chiamata deve essere un amministratore di Google Workspace con il privilegio Gestisci spazi e conversazioni di Chat.

Richiede l'ambito OAuth 2.0 chat.admin.memberships.readonly o chat.admin.memberships.

L'elenco delle iscrizioni alle app in uno spazio non è supportato quando si utilizza l'accesso amministrativo.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

Risposta per elencare le iscrizioni allo spazio.

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 degli abbonamenti nella pagina richiesta (o nella prima).
nextPageToken

string

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