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 patch en el recurso membership de la API de Google Chat para cambiar los atributos de una membresía, como cambiar un miembro de un espacio a administrador o administrador del espacio.

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.

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
  • 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. La actualización de una membresía requiere la autenticación del usuario con el alcance de autorización chat.memberships o, si se importan datos a Chat, el alcance de autorización chat.import.

Node.js

  • Node.js y npm

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

    npm install @google-cloud/local-auth @googleapis/chat
  • 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. La actualización de una membresía requiere la autenticación del usuario con el alcance de autorización chat.memberships o, si se importan datos a Chat, el alcance de autorización chat.import.

Apps Script

Cómo actualizar una membresía

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

  • Especifica el alcance de la autorización de chat.memberships.
  • Llama al método patch en el recurso Membership y pasa el name de la membresía que deseas actualizar, así como un updateMask y un body que especifiquen los atributos de membresía actualizados.
  • updateMask especifica los aspectos de la membresía que se actualizará y, además, incluye lo siguiente:
    • role: Es la función del usuario en un espacio de Chat, que determina sus acciones permitidas en el espacio. Los valores posibles son los siguientes:
      • ROLE_MEMBER: Miembro del espacio. El usuario tiene permisos básicos, como enviar mensajes al espacio. En las conversaciones en grupo 1:1 y sin nombre, todos tienen esta función.
      • ROLE_MANAGER: Administrador del espacio. El usuario tiene todos los permisos básicos y los permisos administrativos que le permiten administrar el espacio, como agregar o quitar miembros. Solo se admite en espacios en los que spaceType es SPACE (espacios con nombre).

Cómo convertir a un miembro normal del espacio en administrador del espacio

En el siguiente ejemplo, se convierte a un miembro normal del espacio en administrador del espacio especificando role como ROLE_MANAGER en el body que especifica los atributos de membresía actualizados:

Python

  1. En el directorio de trabajo, crea un archivo llamado chat_membership_update.py.

  2. Incluye el siguiente código en chat_membership_update.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"]

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

    # 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().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_MANAGER'}

      ).execute()

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

if __name__ == '__main__':
    main()

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

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

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

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

    python3 chat_membership_update.py

Node.js

  1. En el directorio de trabajo, crea un archivo llamado chat_membership_update.js.

  2. Incluye el siguiente código en chat_membership_update.js:

    const chat = require('@googleapis/chat');
const {authenticate} = require('@google-cloud/local-auth');

/**
* Updates a membership in a Chat space to change it from
* a space member to a space manager.
* @return {!Promise<!Object>}
*/
async function updateSpace() {

  /**
  * Authenticate with Google Workspace
  * and get user authorization.
  */
  const scopes = [
    'https://www.googleapis.com/auth/chat.memberships',
  ];

  const authClient =
      await authenticate({scopes, keyfilePath: 'client_secrets.json'});

  /**
  * Build a service endpoint for Chat API.
  */
  const chatClient = await chat.chat({version: 'v1', auth: authClient});

  /**
  * Use the service endpoint to call Chat API.
  */
  return await chatClient.spaces.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',
    requestBody: {
      role: 'ROLE_MANAGER'
    }
  });
}

/**
* Use the service endpoint to call Chat API.
*/
updateSpace().then(console.log);

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

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

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

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

    python3 chat_membership_update.js

Apps Script

En este ejemplo, se llama a la API de Chat con el servicio de Chat avanzado.

  1. Agrega el alcance de autorización chat.memberships al archivo appsscript.json del proyecto de Apps Script:

    "oauthScopes": [
  "https://www.googleapis.com/auth/chat.memberships"
]

  2. Agrega una función como esta al código del proyecto de Apps Script:

    /**
 * Updates a membership from space member to space manager.
 * @param {string} memberName The resource name of the membership.
*/
function updateMembershipToSpaceManager(memberName) {
  try {
    const body = {'role': 'ROLE_MANAGER'};
    Chat.Spaces.Members.patch(memberName, body);
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log('Failed to create message with error %s', err.message);
  }
}

La API de Google Chat cambia la membresía especificada a un administrador del espacio y muestra una instancia de Membership que detalla el cambio.

Cómo convertir a un administrador del espacio en miembro normal

En el siguiente ejemplo, se convierte a un administrador del espacio en miembro normal de un espacio especificando role como ROLE_MEMBER en el body que especifica los atributos de membresía actualizados:

Python

  1. En el directorio de trabajo, crea un archivo llamado chat_membership_update.py.

  2. Incluye el siguiente código en chat_membership_update.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"]

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

    # 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().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 un nombre de espacio, que puedes obtener del método spaces.list en la API de Chat, o bien desde la URL de un espacio.

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

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

    python3 chat_membership_update.py

Node.js

  1. En el directorio de trabajo, crea un archivo llamado chat_membership_update.js.

  2. Incluye el siguiente código en chat_membership_update.js:

    const chat = require('@googleapis/chat');
const {authenticate} = require('@google-cloud/local-auth');

/**
* Updates a membership in a Chat space to change it from
* a space manager to a space member.
* @return {!Promise<!Object>}
*/
async function updateSpace() {

  /**
  * Authenticate with Google Workspace
  * and get user authorization.
  */
  const scopes = [
    'https://www.googleapis.com/auth/chat.memberships',
  ];

  const authClient =
      await authenticate({scopes, keyfilePath: 'client_secrets.json'});

  /**
  * Build a service endpoint for Chat API.
  */
  const chatClient = await chat.chat({version: 'v1', auth: authClient});

  /**
  * Use the service endpoint to call Chat API.
  */
  return await chatClient.spaces.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',
    requestBody: {
      role: 'ROLE_MEMBER'
    }
  });
}

/**
* Use the service endpoint to call Chat API.
*/
updateSpace().then(console.log);

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

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

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

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

    python3 chat_membership_update.js

Apps Script

En este ejemplo, se llama a la API de Chat con el servicio de Chat avanzado.

  1. Agrega el alcance de autorización chat.memberships al archivo appsscript.json del proyecto de Apps Script:

    "oauthScopes": [
  "https://www.googleapis.com/auth/chat.memberships"
]

  2. Agrega una función como esta al código del proyecto de Apps Script:

    /**
 * Updates a membership from space manager to space member.
 * @param {string} memberName The resource name of the membership.
*/
function updateMembershipToSpaceMember(memberName) {
  try {
    const body = {'role': 'ROLE_MEMBER'};
    Chat.Spaces.Members.patch(memberName, body);
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log('Failed to create message with error %s', err.message);
  }
}

La API de Google Chat cambia la membresía especificada a un administrador del espacio y muestra una instancia de Membership que detalla el cambio.