Muestra una lista de los miembros de un espacio

En esta guía, se explica cómo usar el método list en el recurso membership de la API de Google Chat para enumerar los miembros de un espacio como una lista paginada y filtrable de las membresías en un espacio. Enumera las membresías con autenticación de apps Se enumeran las membresías en los espacios que tiene la app de Chat. acceso, pero excluye las membresías de la app de Chat, lo que incluye por sí solos. Enumera las membresías con Autenticación de usuarios Se muestran las membresías de los espacios a los que tiene acceso el usuario autenticado.

El Recurso Membership representa si se invita a un usuario humano o a una app de Google Chat es parte de un espacio o está ausente.

Requisitos previos

Python

Muestra una lista de los miembros de un espacio con autenticación de usuario

Para mostrar una lista de los usuarios, los Grupos de Google y la app de Chat en un espacio al que tiene acceso el usuario autenticado, pasa lo siguiente en la solicitud:

En el siguiente ejemplo, se enumeran los miembros del Grupo de Google, las personas y los miembros de la app visibles para el usuario autenticado.

Python

  1. En el directorio de trabajo, crea un archivo llamado chat_member_list_user.py.

  2. Incluye el siguiente código en 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. En el código, reemplaza SPACE por un nombre de espacio, que que puedes obtener de la Método spaces.list en la API de Chat o desde la URL de un espacio.

  4. En tu directorio de trabajo, compila y ejecuta la muestra:

    python3 chat_member_list_user.py

La API de Google Chat muestra una lista de los miembros del Grupo de Google, las personas y los miembros de la app del espacio especificado.

Muestra una lista de los miembros de un espacio con la autenticación de apps

Cómo mostrar una lista de los usuarios y la app de Chat en un espacio a los que tiene acceso la app autenticada, pasa lo siguiente en la solicitud:

En el siguiente ejemplo, se enumeran los miembros humanos del espacio (no los administradores del espacio) que pueden ver la app de Chat:

Python

  1. En el directorio de trabajo, crea un archivo llamado chat_member_list_app.py.

  2. Incluye el siguiente código en 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. En el código, reemplaza SPACE por un nombre de espacio, que que puedes obtener de la Método spaces.list en la API de Chat o desde la URL de un espacio.

  4. En tu directorio de trabajo, compila y ejecuta la muestra:

    python3 chat_member_list_app.py

La API de Google Chat muestra una lista de los miembros humanos del espacio (sin incluir el espacio) del espacio especificado.

Personaliza la paginación o filtra la lista

Para enumerar las membresías, pasa los siguientes parámetros de consulta a personalizar la paginación o filtrar las membresías enumeradas:

  • pageSize: Es la cantidad máxima de membresías que se mostrarán. Es posible que el servicio mostrar menos que este valor. Si no se especifica, se permiten 100 espacios como máximo que se devuelven. El valor máximo es 1,000. los valores superiores a 1,000 se cambió a 1,000.
  • pageToken: Un token de página, recibido de una llamada anterior a los espacios de lista. Proporciona este token para recuperar la página siguiente. Al paginar, el valor del filtro debe coincidir con la llamada que proporcionó el token de la página. Si pasas un un valor diferente puede generar resultados inesperados.
  • filter: Es un filtro de consulta. Requiere autenticación de usuarios. Para obtener detalles de consultas compatibles, revisa el Método spaces.members.list.