Elenca i membri in uno spazio

Questa guida spiega come utilizzare il metodo list nella risorsa membership dell'API Google Chat per elencare i membri di uno spazio come elenco filtrabile e impaginato di appartenenze a uno spazio. Abbonamenti a schede con autenticazione app elenca le iscrizioni agli spazi di cui l'app di Chat dispone accesso a, ma esclude gli abbonamenti all'app di Chat, inclusi si tratta di una risorsa completamente dedicata. Abbonamenti a schede con Autenticazione degli utenti elenca le iscrizioni agli spazi a cui l'utente autenticato ha accesso.

La Membership risorsa indica se un utente umano o un'app Google Chat è invitato, parte di o assente in uno spazio.

Prerequisiti

Python

Elenca i membri in uno spazio con autenticazione utente

Per elencare gli utenti, i gruppi Google e l'app Chat in uno spazio a cui l'utente autenticato ha accesso, trasmetti quanto segue nella richiesta:

L'esempio seguente elenca i membri di gruppi Google, persone e app visibili a l'utente autenticato.

Python

  1. Nella directory di lavoro, crea un file denominato chat_member_list_user.py.

  2. Includi il seguente codice in chat_member_list_user.py:

    from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build

# Define your app's authorization scopes.
# When modifying these scopes, delete the file token.json, if it exists.
SCOPES = ["https://www.googleapis.com/auth/chat.memberships.readonly"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then lists Google Group, human, and app members in a specified space.
    '''

    # Authenticate with Google Workspace
    # and get user authorization.
    flow = InstalledAppFlow.from_client_secrets_file(
                'client_secrets.json', SCOPES)
    creds = flow.run_local_server()

    # Build a service endpoint for Chat API.
    chat = build('chat', 'v1', credentials=creds)

    # Use the service endpoint to call Chat API.
    result = chat.spaces().members().list(

        # The space for which to list memberships.
        parent = 'spaces/SPACE',

        # Set this parameter to list Google Groups.
        showGroups = 'true'

    ).execute()

    # Prints the list of memberships.
    print(result)

if __name__ == '__main__':
    main()

  3. Nel codice, sostituisci SPACE con il nome di uno spazio, che che puoi ottenere Metodo spaces.list nell'API Chat o dall'URL di uno spazio.

  4. Nella directory di lavoro, crea ed esegui l'esempio:

    python3 chat_member_list_user.py

L'API Google Chat restituisce un elenco di membri del gruppo Google, persone e app dal nello spazio specificato.

Elenca membri in uno spazio con autenticazione delle app

Per elencare gli utenti e l'app Chat in uno spazio a cui ha accesso l'app autenticata, trasmetti quanto segue nella richiesta:

L'esempio seguente elenca i membri dello spazio umani (non i gestori dello spazio) visibili a l'app Chat:

Python

  1. Nella directory di lavoro, crea un file denominato chat_member_list_app.py.

  2. Includi il seguente codice in chat_member_list_app.py:

    from google.oauth2 import service_account
from apiclient.discovery import build

# Specify required scopes.
SCOPES = ['https://www.googleapis.com/auth/chat.bot']

# Specify service account details.
CREDENTIALS = (
    service_account.Credentials.from_service_account_file('credentials.json')
    .with_scopes(SCOPES)
)

# Build the URI and authenticate with the service account.
chat = build('chat', 'v1', credentials=CREDENTIALS)

# Use the service endpoint to call Chat API.
result = chat.spaces().members().list(

        # The space for which to list memberships.
        parent = 'spaces/SPACE',

        # An optional filter that returns only human space members.
        filter = 'member.type = "HUMAN" AND role = "ROLE_MEMBER"'

    ).execute()

print(result)

  3. Nel codice, sostituisci SPACE con il nome di uno spazio, che che puoi ottenere Metodo spaces.list nell'API Chat o dall'URL di uno spazio.

  4. Nella directory di lavoro, crea ed esegui l'esempio:

    python3 chat_member_list_app.py

L'API Google Chat restituisce un elenco di membri dello spazio umano (escluso lo spazio) manager) dello spazio specificato.

Personalizzare l'impaginazione o filtrare l'elenco

Per elencare le appartenenze, passa i seguenti parametri di query a personalizza l'impaginazione o filtra le iscrizioni elencate:

  • pageSize: il numero massimo di abbonamenti da restituire. Il servizio potrebbe restituiscono un valore inferiore a questo. Se non specificati, vengono visualizzati al massimo 100 spazi restituito. Il valore massimo è 1000. superiori a 1000 vengono automaticamente è cambiato in 1000.
  • pageToken: un token di pagina, ricevuto da una precedente chiamata agli spazi elenco. Fornisci questo token per recuperare la pagina successiva. Durante l'impaginazione, il valore del filtro deve corrispondere alla chiamata che ha fornito il token della pagina. Il superamento di un un valore diverso potrebbe portare a risultati imprevisti.
  • filter: un filtro query. Richiede autenticazione degli utenti. Per i dettagli delle query supportate, consulta Metodo spaces.members.list.