Method: spaces.members.list

Elenca le iscrizioni in uno spazio. Per un esempio, vedi Elencare utenti e app Google Chat in uno spazio. L'elenco delle iscrizioni con autenticazione app elenca le iscrizioni agli spazi a cui l'app Chat ha accesso, ma esclude le iscrizioni all'app Chat, inclusa la propria. L'elenco delle iscrizioni con Autenticazione utente elenca le iscrizioni negli spazi a cui l'utente autenticato ha accesso.

Supporta i seguenti tipi di autenticazione:

  • Autenticazione dell'app con uno dei seguenti ambiti di autorizzazione:

  • Autenticazione utente con uno dei seguenti ambiti di autorizzazione:

    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.import (solo spazi in modalità di importazione)
    • L'autenticazione utente concede privilegi amministrativi quando un account amministratore esegue l'autenticazione, useAdminAccess è true e viene utilizzato uno dei seguenti ambiti di autorizzazione:
      • https://www.googleapis.com/auth/chat.admin.memberships.readonly
      • https://www.googleapis.com/auth/chat.admin.memberships

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

Formato: spaces/{space}

Parametri di query

Parametri
pageSize

integer

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

Se non specificato, vengono restituiti al massimo 100 abbonamenti.

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

(Facoltativo) Un token di pagina, ricevuto da una precedente chiamata per elencare gli abbonamenti. Fornisci questo parametro per recuperare la pagina successiva.

Durante la paginazione, tutti gli altri parametri forniti devono corrispondere alla chiamata che ha fornito il token di pagina. Il passaggio di valori diversi agli altri parametri potrebbe portare a risultati imprevisti.
filter

string

(Facoltativo) Un filtro query.

Puoi filtrare gli abbonamenti in base al ruolo (role) e al tipo (member.type) di un 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. Puoi anche filtrare in base a member.type utilizzando l'operatore !=.

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.

È obbligatorio specificare member.type = "HUMAN" o member.type != "BOT" quando useAdminAccess è impostato su true. Gli altri filtri per tipo di membro 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, restituisce anche gli abbonamenti associati a un Google Group, oltre ad altri tipi di abbonamenti. Se è impostato un filter, gli abbonamenti Google Group che non corrispondono ai criteri di filtro non vengono restituiti.
showInvited

boolean

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

Attualmente richiede l'autenticazione dell'utente.
useAdminAccess

boolean

(Facoltativo) Quando true, il metodo viene eseguito utilizzando i privilegi di amministratore Google Workspace dell'utente.

L'utente chiamante 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 appartenenze 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 pagina).
nextPageToken

string

Un token che puoi inviare come pageToken per recuperare la pagina successiva dei risultati. Se è vuoto, non verranno visualizzate altre pagine.

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.app.memberships
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

Per ulteriori informazioni, consulta la Guida all'autorizzazione.