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 membresías de un espacio. Cuando se crean listas de membresías con autenticación de apps, se enumeran las membresías en los espacios a los que tiene acceso la app de Chat, pero se excluyen las membresías de la app de Chat, incluidas las propias. Enumerar las membresías con Autenticación de usuarios indica las membresías en 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 a un espacio, si forma parte de él o si está ausente.

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.

  • Autorización configurada para la app de Chat. Enumerar las membresías admite los siguientes métodos de autenticación:

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 tu 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 puedes obtener del método spaces.list en la API de Chat o de 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

Para enumerar los usuarios y la 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 humanos del espacio (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 de 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 (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: Es 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 cambian a 1,000 automáticamente.
  • 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. Durante la paginación, 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. Se requiere la autenticación del usuario. Para obtener detalles de consulta compatibles, consulta el método spaces.members.list.