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 del espacio a administrador del espacio o cambiar de administrador a este.

El Recurso Membership representa si se invita a un usuario humano o a una app de Google Chat es parte de un espacio o está ausente.

Requisitos previos

Python

Node.js

Apps Script

Cómo actualizar una membresía

Para actualizar una membresía del espacio, pasa lo siguiente en tu solicitud:

  • Especifica el alcance de la autorización chat.memberships.
  • Llama al Método patch en el recurso Membership, y pasar el name de la membresía para actualizar, así como un updateMask y un body que especifica los atributos de membresía actualizados.
  • updateMask especifica 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 acciones en el espacio. Estos son los posibles valores:
      • ROLE_MEMBER: Es un miembro del espacio. El usuario tiene permisos básicos, como enviar mensajes al espacio. En un grupo 1:1 y sin nombre conversaciones, todos tienen este rol.
      • ROLE_MANAGER: Es un administrador del espacio. El usuario tiene todos los permisos básicos y permisos administrativos que les permiten controlar 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, un miembro normal del espacio se convierte en administrador del espacio especificando role como ROLE_MANAGER en el body, que especifica la membresía actualizada atributos:

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 que puedes obtener de la Método spaces.list en la API de Chat o desde la URL de un espacio.

    • MEMBERSHIP: Es un nombre de membresía, que que puedes obtener de la 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.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 que puedes obtener de la Método spaces.list en la API de Chat o desde la URL de un espacio.

    • MEMBERSHIP: Es un nombre de membresía, que que puedes obtener de la 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.js
    

Apps Script

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

  1. Agrega el permiso 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 conjunto de datos código:

    /**
     * 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 los detalles del cambio.

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

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

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 que puedes obtener de la Método spaces.list en la API de Chat o desde la URL de un espacio.

    • MEMBERSHIP: Es un nombre de membresía, que que puedes obtener de la 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.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 que puedes obtener de la Método spaces.list en la API de Chat o desde la URL de un espacio.

    • MEMBERSHIP: Es un nombre de membresía, que que puedes obtener de la 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.js
    

Apps Script

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

  1. Agrega el permiso 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 conjunto de datos código:

    /**
     * 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 los detalles del cambio.