Muestra una lista de usuarios y apps de Google Chat 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 usuarios y la app de Chat de un espacio como una lista de membresías paginada y filtrable de un espacio. Enumerar membresías con autenticación de app enumera las membresías en espacios a los que tiene acceso la app de Chat, pero excluye las membresías de la app de Chat, incluidas las propias. Enumera las membresías con la autenticación de usuarios para mostrarlas en los espacios a los que tiene acceso el usuario autenticado.

El recurso Membership representa si un usuario humano o una app de Google Chat están invitados a un espacio, son parte de él o no lo están.

Requisitos previos

Python

  • Python 3.6 o superior
  • La herramienta de administración de paquetes pip

  • Las bibliotecas cliente de Google más recientes para Python. Para instalarlos o actualizarlos, ejecuta el siguiente comando en tu interfaz de línea de comandos:

    pip3 install --upgrade google-api-python-client google-auth-oauthlib google-auth
  • Un proyecto de Google Cloud con la API de Google Chat habilitada y configurada Para conocer los pasos, consulta Compila una app de Google Chat.

  • La autorización configurada para la app de Chat. Las membresías de las fichas admiten los siguientes métodos de autenticación:

Muestra una lista de usuarios y la app de Chat en un espacio con autenticación de usuarios

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

En el siguiente ejemplo, se enumeran los miembros del espacio humano (no los administradores del espacio) visibles para el usuario autenticado porque filter se estableció en ROLE_Member:

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 human space members (but not space managers) 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',

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

    ).execute()

    # Prints details about the created membership.
    print(result)

if __name__ == '__main__':
    main()

  3. En el código, reemplaza SPACE por un nombre de espacio, que puedes obtener del método spaces.list en la API de Chat o desde la URL de un espacio.

  4. En el 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 espacio humano (excepto los administradores del espacio) y los miembros de la app del espacio especificado.

Muestra una lista de usuarios y la app de Chat en un espacio con autenticación de app

Para mostrar una lista de usuarios y de app de Chat en un espacio al que tiene acceso la app autenticada, pasa lo siguiente en la solicitud:

En el siguiente ejemplo, se enumeran los miembros del espacio humano (no los administradores del espacio) visibles para 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 puedes obtener del método spaces.list en la API de Chat o desde la URL de un espacio.

  4. En el 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 del espacio humano (excepto los administradores del 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 fin de personalizar la paginación o filtrar las membresías enumeradas:

  • pageSize: La cantidad máxima de membresías que se mostrarán. Es posible que el servicio muestre menos que este valor. Si no se especifica, se muestran 100 espacios como máximo. El valor máximo es 1,000; los valores superiores a 1,000 se cambian automáticamente a 1,000.
  • pageToken: Es un token de página, recibido de una llamada anterior a los espacios de la lista. Proporciona este token para recuperar la página siguiente. Cuando se pagina, el valor del filtro debe coincidir con la llamada que proporcionó el token de la página. Pasar un valor diferente puede generar resultados inesperados.
  • filter: Es un filtro de consulta. Requiere autenticación de usuario. Para obtener detalles de la consulta compatible, consulta el método spaces.members.list.