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 mostrar una lista de miembros de un espacio como una lista paginada y filtrable de membresías en un espacio.

  • Ficha de membresías con autenticación de app enumera las membresías en espacios a los que la app de Chat tiene acceso, pero excluye las membresías de la app de Chat, incluidas las propias.
  • La lista de membresías con autenticación del usuario muestra las membresías en los espacios a los que el usuario autenticado tiene acceso.
  • Si enumeras las membresías como administrador de Google Workspace con autenticación de usuarios mediante privilegios de administrador, se enumerarán las membresías en todos los espacios de tu organización de Google Workspace.

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

Node.js

Python

Java

Apps Script

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

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

  • Con la autenticación de usuarios, especifica el alcance de la autorización chat.memberships.readonly o chat.memberships.
  • Realiza una llamada al método ListMemberships().
  • Para enumerar los Grupos de Google, establece el parámetro de consulta showGroups en true.

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.

Node.js

chat/client-libraries/cloud/list-memberships-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';

const USER_AUTH_OAUTH_SCOPES = ['https://www.googleapis.com/auth/chat.memberships.readonly'];

// This sample shows how to list memberships with user credential
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME here
    parent: 'spaces/SPACE_NAME',
    // Filter membership by type (HUMAN or BOT) or role (ROLE_MEMBER or
    // ROLE_MANAGER)
    filter: 'member.type = "HUMAN"'
  };

  // Make the request
  const pageResult = chatClient.listMembershipsAsync(request);

  // Handle the response. Iterating over pageResult will yield results and
  // resolve additional pages automatically.
  for await (const response of pageResult) {
    console.log(response);
  }
}

main().catch(console.error);

Python

chat/client-libraries/cloud/list_memberships_user_cred.py
from authentication_utils import create_client_with_user_credentials
from google.apps import chat_v1 as google_chat

SCOPES = ["https://www.googleapis.com/auth/chat.memberships.readonly"]

# This sample shows how to list memberships with user credential
def list_memberships_user_cred():
    # Create a client
    client = create_client_with_user_credentials(SCOPES)

    # Initialize request argument(s)
    request = google_chat.ListMembershipsRequest(
        # Replace SPACE_NAME here
        parent = 'spaces/SPACE_NAME',
        # Filter membership by type (HUMAN or BOT) or role (ROLE_MEMBER or
        # ROLE_MANAGER)
        filter = 'member.type = "HUMAN"',
        # Number of results that will be returned at once
        page_size = 100
    )

    # Make the request
    page_result = client.list_memberships(request)

    # Handle the response. Iterating over page_result will yield results and
    # resolve additional pages automatically.
    for response in page_result:
        print(response)

list_memberships_user_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/ListMembershipsUserCred.java
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.ListMembershipsRequest;
import com.google.chat.v1.ListMembershipsResponse;
import com.google.chat.v1.Membership;

// This sample shows how to list memberships with user credential.
public class ListMembershipsUserCred {

  private static final String SCOPE =
    "https://www.googleapis.com/auth/chat.memberships.readonly";

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithUserCredentials(
          ImmutableList.of(SCOPE))) {
      ListMembershipsRequest.Builder request = ListMembershipsRequest.newBuilder()
        // Replace SPACE_NAME here.
        .setParent("spaces/SPACE_NAME")
        // Filter membership by type (HUMAN or BOT) or role
        // (ROLE_MEMBER or ROLE_MANAGER).
        .setFilter("member.type = \"HUMAN\"")
        // Number of results that will be returned at once.
        .setPageSize(10);

      // Iterating over results and resolve additional pages automatically.
      for (Membership response :
          chatServiceClient.listMemberships(request.build()).iterateAll()) {
        System.out.println(JsonFormat.printer().print(response));
      }
    }
  }
}

Apps Script

chat/advanced-service/Main.gs
/**
 * This sample shows how to list memberships with user credential
 * 
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.memberships.readonly'
 * referenced in the manifest file (appsscript.json).
 */
function listMembershipsUserCred() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME here
  const parent = 'spaces/SPACE_NAME';
  // Filter membership by type (HUMAN or BOT) or role (ROLE_MEMBER or
  // ROLE_MANAGER)
  const filter = 'member.type = "HUMAN"';

  // Iterate through the response pages using page tokens
  let responsePage;
  let pageToken = null;
  do {
    // Request response pages
    responsePage = Chat.Spaces.Members.list(parent, {
      filter: filter,
      pageSize: 10,
      pageToken: pageToken
    });
    // Handle response pages
    if (responsePage.memberships) {
      responsePage.memberships.forEach((membership) => console.log(membership));
    }
    // Update the page token to the next one
    pageToken = responsePage.nextPageToken;
  } while (pageToken);
}

Para ejecutar este ejemplo, reemplaza SPACE_NAME por el ID del campo name del espacio. Para obtener el ID, llama al método ListSpaces() o desde la URL del espacio.

La API de Google Chat muestra una lista de miembros del Grupo de Google, humanos y de apps del espacio especificado.

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

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

  • Con la autenticación de apps, especifica el alcance de autorización de chat.bot.
  • Realiza una llamada al método ListMemberships().
  • Para enumerar los Grupos de Google, establece el parámetro de consulta showGroups en true.

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

Node.js

chat/client-libraries/cloud/list-memberships-app-cred.js
import {createClientWithAppCredentials} from './authentication-utils.js';

// This sample shows how to list memberships with app credential
async function main() {
  // Create a client
  const chatClient = createClientWithAppCredentials();

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME here
    parent: 'spaces/SPACE_NAME',
    // Filter membership by type (HUMAN or BOT) or role (ROLE_MEMBER or
    // ROLE_MANAGER)
    filter: 'member.type = "HUMAN"'
  };

  // Make the request
  const pageResult = chatClient.listMembershipsAsync(request);

  // Handle the response. Iterating over pageResult will yield results and
  // resolve additional pages automatically.
  for await (const response of pageResult) {
    console.log(response);
  }
}

main().catch(console.error);

Python

chat/client-libraries/cloud/list_memberships_app_cred.py
from authentication_utils import create_client_with_app_credentials
from google.apps import chat_v1 as google_chat

# This sample shows how to list memberships with app credential
def list_memberships_app_cred():
    # Create a client
    client = create_client_with_app_credentials()

    # Initialize request argument(s)
    request = google_chat.ListMembershipsRequest(
        # Replace SPACE_NAME here
        parent = 'spaces/SPACE_NAME',
        # Filter membership by type (HUMAN or BOT) or role (ROLE_MEMBER or
        # ROLE_MANAGER)
        filter = 'member.type = "HUMAN"',
        # Number of results that will be returned at once
        page_size = 100
    )

    # Make the request
    page_result = client.list_memberships(request)

    # Handle the response. Iterating over page_result will yield results and
    # resolve additional pages automatically.
    for response in page_result:
        print(response)

list_memberships_app_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/ListMembershipsAppCred.java
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.ListMembershipsRequest;
import com.google.chat.v1.ListMembershipsResponse;
import com.google.chat.v1.Membership;

// This sample shows how to list memberships with app credential.
public class ListMembershipsAppCred {

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithAppCredentials()) {
      ListMembershipsRequest.Builder request = ListMembershipsRequest.newBuilder()
        // Replace SPACE_NAME here.
        .setParent("spaces/SPACE_NAME")
        // Filter membership by type (HUMAN or BOT) or role
        // (ROLE_MEMBER or ROLE_MANAGER).
        .setFilter("member.type = \"HUMAN\"")
        // Number of results that will be returned at once.
        .setPageSize(10);

      // Iterate over results and resolve additional pages automatically.
      for (Membership response :
          chatServiceClient.listMemberships(request.build()).iterateAll()) {
        System.out.println(JsonFormat.printer().print(response));
      }
    }
  }
}

Apps Script

chat/advanced-service/Main.gs
/**
 * This sample shows how to list memberships with app credential
 * 
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.bot'
 * used by service accounts.
 */
function listMembershipsAppCred() {
// Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME here
  const parent = 'spaces/SPACE_NAME';
  // Filter membership by type (HUMAN or BOT) or role (ROLE_MEMBER or
  // ROLE_MANAGER)
  const filter = 'member.type = "HUMAN"';

  // Iterate through the response pages using page tokens
  let responsePage;
  let pageToken = null;
  do {
    // Request response pages
    responsePage = Chat.Spaces.Members.list(parent, {
      filter: filter,
      pageSize: 10,
      pageToken: pageToken
    }, getHeaderWithAppCredentials());
    // Handle response pages
    if (responsePage.memberships) {
      responsePage.memberships.forEach((membership) => console.log(membership));
    }
    // Update the page token to the next one
    pageToken = responsePage.nextPageToken;
  } while (pageToken);
}

Para ejecutar este ejemplo, reemplaza SPACE_NAME por el ID del campo name del espacio. Para obtener el ID, llama al método ListSpaces() o desde la URL del espacio.

La API de Google Chat muestra una lista de miembros del espacio humanos (excepto los administradores del espacio) del espacio especificado.

Cómo incluir miembros como administradores de Google Workspace

Si eres administrador de Google Workspace, puedes llamar al método ListMemberships() para enumerar las membresías de cualquier espacio de tu organización de Google Workspace. La API de Chat solo muestra membresías sobre usuarios (internos y externos) o Grupos de Google de tu organización y, por lo tanto, omite las membresías de las apps de Chat.

Para llamar a este método como administrador de Google Workspace, haz lo siguiente:

  • Llama al método con la autenticación del usuario y especifica un alcance de autorización que admita llamar al método con privilegios de administrador.
  • En tu solicitud, especifica los siguientes parámetros de consulta:
    • Establece useAdminAccess en true.
    • Para mostrar solo usuarios, establece el filter de member.type igual a HUMAN.
    • Para mostrar usuarios y grupos, establece el filter para member.type que no sea igual a BOT AND showGroups igual a true.

Para obtener más información y ejemplos, consulta Administra espacios de Google Chat como administrador de Google Workspace.

Personaliza la paginación o filtra la lista

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

  • 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 como máximo 100 espacios. 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 desde una llamada a listSpaces anterior. Proporciona este token para recuperar la página siguiente. Cuando se realiza la paginación, el valor del filtro debe coincidir con la llamada que proporcionó el token de página. Pasar un valor diferente puede generar resultados inesperados.
  • filter: Es un filtro de consulta. Requiere autenticación del usuario. Para obtener detalles sobre las consultas compatibles, consulta la referencia de ListMembershipsRequest.