Actualiza la membresía de un usuario en un espacio de Google Chat

En esta guía, se explica cómo usar el método update() en el recurso Membership de la API de Google Chat para cambiar atributos sobre una membresía, como cambiar un miembro del espacio a administrador del espacio o propietario del espacio.

Si eres administrador de Google Workspace, puedes llamar al método update() para actualizar la membresía de cualquier espacio en tu organización de Google Workspace.

El recursoMembership representa si un usuario humano o una app de Google Chat está invitado a un espacio, forma parte de él o no está presente en él.

Requisitos previos

Node.js

Actualiza una membresía

Para actualizar la membresía de un espacio, pasa lo siguiente en tu solicitud:

  • Especifica un permiso de autorización:
    • Con la autenticación de usuarios, especifica el alcance de autorización chat.memberships.
    • Con la autenticación de la app, especifica el alcance de autorización chat.app.memberships. Cuando actualizas una membresía con autenticación de la app, solo puedes actualizar las membresías en espacios creados por apps de Chat. La autenticación de la app requiere la aprobación del administrador una sola vez.
  • Realiza una llamada al método UpdateMembership().
  • Pasa membership como una instancia de Membership con lo siguiente:
    • El campo name establecido en la membresía que se actualizará, que incluye un ID de espacio y un ID de miembro.
    • Son los campos de membresía que se actualizarán y se establecerán en los valores nuevos.
  • Pasa updateMask para especificar los aspectos de la membresía que se actualizarán. Incluye lo siguiente:
    • role: Es el rol del usuario en un espacio de Chat, que determina las acciones permitidas en el espacio. Para obtener explicaciones detalladas sobre los permisos, consulta MembershipRole en la documentación de referencia de la API de Chat. Los valores posibles son los siguientes:
      • ROLE_MEMBER: Es un miembro del espacio. En la IU de Chat, este rol se llama Miembro.
      • ROLE_ASSISTANT_MANAGER: Es un administrador de espacio. En la IU de chat, este rol se llama Administrador.
      • ROLE_MANAGER: Es el propietario de un espacio. En la IU de chat, este rol se denomina Propietario.

Cómo cambiar un miembro a propietario (autenticación de usuario)

En el siguiente ejemplo, se llama a la API de Chat con autenticación de usuario para convertir a un miembro normal del espacio en propietario del espacio especificando role como ROLE_MANAGER:

Node.js

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

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

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

  // Initialize request argument(s)
  const request = {
    membership: {
      // Replace SPACE_NAME and MEMBER_NAME here
      name: 'spaces/SPACE_NAME/members/MEMBER_NAME',
      // Replace ROLE_NAME here with ROLE_MEMBER or ROLE_MANAGER
      role: 'ROLE_NAME',
    },
    updateMask: {
      // The field paths to update.
      paths: ['role'],
    },
  };

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

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

await main();

Para ejecutar la muestra, reemplaza lo siguiente:

  • SPACE_NAME: Es el ID del name del espacio. Puedes obtener el ID llamando al método ListSpaces() o desde la URL del espacio.
  • MEMBER_NAME: Es el ID del name de la membresía. Puedes obtener el ID llamando al método ListMemberships() o desde el cuerpo de la respuesta que se muestra después de crear una membresía de forma asíncrona con la API de Chat.
  • ROLE_NAME: Es el rol actualizado, ROLE_MANAGER. Puedes establecer este valor en cualquier valor de MembershipRole. Por ejemplo, para convertir a un miembro normal en administrador del espacio, cambia ROLE_NAME por ROLE_ASSISTANT_MANAGER.

La API de Google Chat actualiza la membresía especificada a propietario del espacio y devuelve una instancia de Membership.

Cambiar un propietario a miembro (autenticación del usuario)

En el siguiente ejemplo, se llama a la API de Chat con autenticación del usuario para convertir al propietario de un espacio en un miembro normal del espacio especificando role como ROLE_MEMBER:

Node.js

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

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

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

  // Initialize request argument(s)
  const request = {
    membership: {
      // Replace SPACE_NAME and MEMBER_NAME here
      name: 'spaces/SPACE_NAME/members/MEMBER_NAME',
      // Replace ROLE_NAME here with ROLE_MEMBER or ROLE_MANAGER
      role: 'ROLE_NAME',
    },
    updateMask: {
      // The field paths to update.
      paths: ['role'],
    },
  };

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

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

await main();

Para ejecutar la muestra, reemplaza lo siguiente:

  • SPACE_NAME: Es el ID del name del espacio. Puedes obtener el ID llamando al método ListSpaces() o desde la URL del espacio.
  • MEMBER_NAME: Es el ID del name de la membresía. Puedes obtener el ID llamando al método ListMemberships() o desde el cuerpo de la respuesta que se muestra después de crear una membresía de forma asíncrona con la API de Chat.
  • ROLE_NAME: Es el rol actualizado, ROLE_MEMBER.

La API de Google Chat actualiza la membresía especificada a propietario del espacio y devuelve una instancia de Membership.

Cambia un miembro a propietario (autenticación de la app de Chat)

La autenticación de la app requiere la aprobación del administrador una sola vez.

Escribe un script que llame a la API de Chat

En el siguiente ejemplo, se llama a la API de Chat con autenticación de la app para convertir a un miembro normal del espacio en propietario del espacio. Para ello, se especifica role como ROLE_MANAGER en el objeto body que especifica los atributos de membresía actualizados:

Python

  1. En tu directorio de trabajo, crea un archivo llamado chat_membership_update_to_owner_app.py.

  2. Incluye el siguiente código en chat_membership_update_to_owner_app.py:

    from google.oauth2 import service_account
from apiclient.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.app.memberships"]

def main():
    '''
    Authenticates with Chat API using app authentication,
    then updates a specified space member to change
    it from a regular member to a space owner.
    '''

    # Specify service account details.
    creds = (
        service_account.Credentials.from_service_account_file('credentials.json')
        .with_scopes(SCOPES)
    )

    # 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().patch(

        # The membership to update, and the updated role.
        #
        # Replace SPACE with a space name.
        # Obtain the space name from the spaces resource of Chat API,
        # or from a space's URL.
        #
        # Replace MEMBERSHIP with a membership name.
        # Obtain the membership name from the membership of Chat API.
        name='spaces/SPACE/members/MEMBERSHIP',
        updateMask='role',

        # Replace ROLE with a MembershipRole value.
        # Obtain the MembershipRole values from the membership of Chat API.
        body={'role': 'ROLE'}

      ).execute()

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

if __name__ == '__main__':
    main()

  3. En el código, reemplaza lo siguiente:

    • SPACE: Es el nombre de un espacio, que puedes obtener del método spaces.list en la API de Chat o de la URL de un espacio.

    • MEMBERSHIP: Es el nombre de la membresía, que puedes obtener del método spaces.members.list en la API de Chat.

    • ROLE: Es el rol actualizado, ROLE_MANAGER. Puedes establecer este valor en cualquier valor de MembershipRole. Por ejemplo, para convertir a un miembro normal en administrador del espacio, cambia ROLE por ROLE_ASSISTANT_MANAGER.

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

    python3 chat_membership_update_to_owner_app.py

Cambia un propietario a miembro (autenticación de la app de Chat)

La autenticación de la app requiere la aprobación del administrador una sola vez.

Escribe un script que llame a la API de Chat

En el siguiente ejemplo, se llama a la API de Chat con autenticación de la app para convertir al propietario de un espacio en miembro normal. Para ello, se especifica role como ROLE_MEMBER en el objeto body que especifica los atributos de membresía actualizados:

Python

  1. En tu directorio de trabajo, crea un archivo llamado chat_membership_update_to_member_app.py.

  2. Incluye el siguiente código en chat_membership_update_to_member_app.py:

    from google.oauth2 import service_account
from apiclient.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.app.memberships"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then updates a specified space owner to change
    it to a regular member.
    '''

    # Specify service account details.
    creds = (
        service_account.Credentials.from_service_account_file('credentials.json')
        .with_scopes(SCOPES)
    )

    # 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().patch(

        # The membership to update, and the updated role.
        #
        # Replace SPACE with a space name.
        # Obtain the space name from the spaces resource of Chat API,
        # or from a space's URL.
        #
        # Replace MEMBERSHIP with a membership name.
        # Obtain the membership name from the membership of Chat API.
        name='spaces/SPACE/members/MEMBERSHIP',
        updateMask='role',
        body={'role': 'ROLE_MEMBER'}

      ).execute()

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

if __name__ == '__main__':
    main()

  3. En el código, reemplaza lo siguiente:

    • SPACE: Es el nombre de un espacio, que puedes obtener del método spaces.list en la API de Chat o de la URL de un espacio.

    • MEMBERSHIP: Es el nombre de la membresía, que puedes obtener del método spaces.members.list en la API de Chat.

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

    python3 chat_membership_update_to_member_app.py

Actualiza las membresías como administrador de Google Workspace

Si eres administrador de Google Workspace, puedes llamar al método update() para actualizar las membresías de cualquier espacio 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 Cómo administrar espacios de Google Chat como administrador de Google Workspace.