Obtén detalles sobre una membresía

En esta guía, se explica cómo usar el get() método en el recurso Membership de la API de Google Chat para obtener detalles sobre una membresía en un espacio.

Si eres administrador de Google Workspace, puedes llamar al método get() para recuperar detalles sobre cualquier membresía de tu organización de Google Workspace.

El recurso Membership representa si un usuario humano o una app de Google Chat está invitado a un espacio, forma parte de él o está ausente.

La autenticación con la autenticación de la app permite que una app de Chat obtenga membresías de los espacios a los que tiene acceso en Google Chat (por ejemplo, los espacios de los que es miembro), pero excluye las membresías de la app de Chat, incluida la suya. La autenticación con la autenticación del usuario muestra las membresías de los espacios a los que tiene acceso el usuario autenticado.

Requisitos previos

Node.js

Python

Java

Apps Script

Obtén detalles sobre una membresía

Para obtener detalles sobre una membresía en Google Chat, pasa lo siguiente en tu solicitud:

  • Con la autenticación de la app, especifica el permiso de autorización chat.bot. Con la autenticación del usuario, especifica el alcance de autorización chat.memberships.readonly o chat.memberships. Como práctica recomendada, elige el alcance más restrictivo que permita que tu app funcione.
  • Llama al GetMembership() método.
  • Pasa el name de la membresía que deseas obtener. Obtén el nombre de la membresía del recurso de membresía de Google Chat.

Obtén una membresía con la autenticación del usuario

Sigue estos pasos para obtener una membresía con la autenticación del usuario:

Node.js

chat/client-libraries/cloud/get-membership-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 get membership 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 and MEMBER_NAME here
    name: 'spaces/SPACE_NAME/members/MEMBER_NAME',
  };

  // Make the request
  const response = await chatClient.getMembership(request);

  // Handle the response
  console.log(response);
}

await main();

Python

chat/client-libraries/cloud/get_membership_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 get membership with user credential
def get_membership_with_user_cred():
    # Create a client
    client = create_client_with_user_credentials(SCOPES)

    # Initialize request argument(s)
    request = google_chat.GetMembershipRequest(
        # Replace SPACE_NAME and MEMBER_NAME here
        name = 'spaces/SPACE_NAME/members/MEMBER_NAME',
    )

    # Make the request
    response = client.get_membership(request)

    # Handle the response
    print(response)

get_membership_with_user_cred()

Java

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

// This sample shows how to get membership with user credential.
public class GetMembershipUserCred {

  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))) {
      GetMembershipRequest.Builder request = GetMembershipRequest.newBuilder()
        // replace SPACE_NAME and MEMBERSHIP_NAME here
        .setName("spaces/SPACE_NAME/members/MEMBERSHIP_NAME");
      Membership response = chatServiceClient.getMembership(request.build());

      System.out.println(JsonFormat.printer().print(response));
    }
  }
}

Apps Script

chat/advanced-service/Main.gs
/**
 * This sample shows how to get membership 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 getMembershipUserCred() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME and MEMBER_NAME here
  const name = "spaces/SPACE_NAME/members/MEMBER_NAME";

  // Make the request
  const response = Chat.Spaces.Members.get(name);

  // Handle the response
  console.log(response);
}

Para ejecutar esta muestra, reemplaza lo siguiente:

  • SPACE_NAME: Es el ID del name del espacio. Puedes obtener el ID llamando al ListSpaces() método o desde la URL del espacio.
  • MEMBER_NAME: Es el ID del miembro's name. Puedes obtener el ID llamando al ListMemberships() método.

La API de Chat muestra una instancia de Membership que detalla la membresía especificada.

Obtén una membresía con la autenticación de la app

Sigue estos pasos para obtener una membresía con la autenticación de la app:

Node.js

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

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

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME and MEMBER_NAME here
    name: 'spaces/SPACE_NAME/members/MEMBER_NAME',
  };

  // Make the request
  const response = await chatClient.getMembership(request);

  // Handle the response
  console.log(response);
}

await main();

Python

chat/client-libraries/cloud/get_membership_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 get membership with app credential
def get_membership_with_app_cred():
    # Create a client
    client = create_client_with_app_credentials()

    # Initialize request argument(s)
    request = google_chat.GetMembershipRequest(
        # Replace SPACE_NAME and MEMBER_NAME here
        name = 'spaces/SPACE_NAME/members/MEMBER_NAME',
    )

    # Make the request
    response = client.get_membership(request)

    # Handle the response
    print(response)

get_membership_with_app_cred()

Java

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

// This sample shows how to get membership with app credential.
public class GetMembershipAppCred {

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithAppCredentials()) {
      GetMembershipRequest.Builder request = GetMembershipRequest.newBuilder()
        // replace SPACE_NAME and MEMBERSHIP_NAME here
        .setName("spaces/SPACE_NAME/members/MEMBERSHIP_NAME");
      Membership response = chatServiceClient.getMembership(request.build());

      System.out.println(JsonFormat.printer().print(response));
    }
  }
}

Apps Script

chat/advanced-service/Main.gs
/**
 * This sample shows how to get membership with app credential
 *
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.bot'
 * used by service accounts.
 */
function getMembershipAppCred() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME and MEMBER_NAME here
  const name = "spaces/SPACE_NAME/members/MEMBER_NAME";
  const parameters = {};

  // Make the request
  const response = Chat.Spaces.Members.get(
    name,
    parameters,
    getHeaderWithAppCredentials(),
  );

  // Handle the response
  console.log(response);
}

Para ejecutar esta muestra, reemplaza lo siguiente:

  • SPACE_NAME: Es el ID del name del espacio. Puedes obtener el ID llamando al ListSpaces() método o desde la URL del espacio.
  • MEMBER_NAME: Es el ID del miembro's name. Puedes obtener el ID llamando al ListMemberships() método.

La API de Chat muestra una instancia de Membership que detalla la membresía especificada.

Obtén detalles sobre las membresías como administrador de Google Workspace

Si eres administrador de Google Workspace, puedes llamar al método GetMembership() para recuperar detalles sobre una membresía de cualquier usuario de tu organización de Google Workspace.

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

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