Cómo configurar un espacio con miembros iniciales

En esta guía, se explica cómo usar el método setup en el recurso Space de la API de Google Chat para configurar un espacio de Google Chat. Cuando se configura un espacio, se crea un espacio y se le agregan usuarios específicos.

El recurso Space representa un lugar donde las personas y las apps de Chat pueden enviar mensajes, compartir archivos y colaborar. Existen varios tipos de espacios:

  • Los mensajes directos (MD) son conversaciones entre dos usuarios, o un usuario, y una app de Chat.
  • Los chats en grupo son conversaciones entre tres o más usuarios y las apps de Chat.
  • Los espacios con nombre son lugares persistentes en los que las personas envían mensajes, comparten archivos y colaboran.

Cuando crees un espacio, ten en cuenta lo siguiente:

  • El usuario (autenticado) que llama se agrega automáticamente al espacio, por lo que no necesitas especificar la membresía del usuario en la solicitud.
  • Cuando se crea un mensaje directo (DM), si existe un DM entre dos usuarios, se muestra el DM. De lo contrario, se crea un DM.
  • No puedes configurar espacios con respuestas en múltiples conversaciones ni agregar personas fuera de Google Workspace.

Requisitos previos

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 configuración de un espacio requiere autenticación del usuario con el permiso de autorización chat.spaces.create o chat.spaces.

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 creación de un espacio requiere la autenticación del usuario con el permiso de autorización chat.spaces.create o chat.spaces.

Cómo configurar un espacio

Para configurar un espacio, pasa lo siguiente en la solicitud:

  • Especifica el alcance de la autorización chat.spaces.create o chat.spaces.
  • Llama al método setup en el recurso Space.
  • Para agregar un usuario humano como miembro del espacio, especifica users/{user}, en el que {user} es el {person_id} del person de la API de People o el ID de un user en la API de Directory. Por ejemplo, si la persona resourceName de la API de People es people/123456789, puedes agregar al usuario al espacio incluyendo una membresía con users/123456789 como member.name.
  • Para crear un MD entre el usuario que realiza la llamada y otro usuario humano, especifica la membresía del usuario humano en tu solicitud.
  • Para crear un MD entre el usuario que realiza la llamada y la app que realiza la llamada, establece Space.singleUserBotDm en true y no especifiques ninguna membresía. Solo puedes usar este método para configurar un MD con la app que realiza la llamada. Para agregar la app que realiza la llamada como miembro de un espacio o un MD existente entre dos usuarios humanos, consulta cómo crear una membresía.

En el siguiente ejemplo, se crea un espacio con nombre y membresías al espacio para tres usuarios humanos, el usuario autenticado y otros dos usuarios especificados:

Python

  1. En el directorio de trabajo, crea un archivo llamado chat_space_setup.py.
  2. Incluye el siguiente código en chat_space_setup.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.spaces.create"]
    
    def main():
        '''
        Authenticates with Chat API via user credentials,
        then sets up a Chat space by creating a space and adding members.
        '''
    
        # 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().setup(
    
          # Details about the space to set up.
          body = {
    
            # Attributes of the space to set up, like space type and display name.
            'space': {
    
                # To set up a named space, set spaceType to SPACE.
                'spaceType': 'SPACE',
    
                # The user-visible name of the space
                'displayName': 'API-setup'
            },
    
            # The people and app to add to the space.
            #
            # The authenticated user is automatically added to the space,
            # and doesn't need to be specified in the memberships array.
            'memberships': [
                {
                  'member': {
                    'name':'users/123456789',
                    'type': 'HUMAN'
                  }
                },
                {
                  'member': {
                    'name':'users/987654321',
                    'type': 'HUMAN'
                  }
                }
            ]
          }
    
          ).execute()
    
        # Prints details about the created membership.
        print(result)
    
    if __name__ == '__main__':
        main()
    
  3. En el directorio de trabajo, compila y ejecuta la muestra:

    python3 chat_space_setup.py
    

Node.js

  1. En el directorio de trabajo, crea un archivo llamado setup-space.js.
  2. Incluye el siguiente código en setup-space.js:

    const chat = require('@googleapis/chat');
    const {authenticate} = require('@google-cloud/local-auth');
    
    /**
    * Sets up a new Chat space with users.
    * @return {!Promise<!Object>}
    */
    async function setupSpace() {
      const scopes = [
        'https://www.googleapis.com/auth/chat.spaces.create',
      ];
    
      const authClient =
          await authenticate({scopes, keyfilePath: 'client_secrets.json'});
    
      const chatClient = await chat.chat({version: 'v1', auth: authClient});
    
      return await chatClient.spaces.setup({
        requestBody: {
          space: {
            spaceType: 'SPACE',
            displayName: 'API-made',
          },
          memberships: [
            {member: {name: 'users/123456789', type: 'HUMAN'}},
            {member: {name: 'users/987654321', type: 'HUMAN'}},
          ]
        }
      });
    }
    
    setupSpace().then(console.log);
    
  3. En tu directorio de trabajo, ejecuta la muestra:

    node setup-space.js
    

Se configuró un espacio de chat con nombre con tres usuarios humanos, incluido el usuario autenticado.

Para ir al espacio, usa el ID de recurso del espacio para compilar su URL. Puedes obtener el ID del recurso del espacio name en el cuerpo de la respuesta de Google Chat. Por ejemplo, si el name de tu espacio es spaces/1234567, puedes ir al espacio con la siguiente URL: https://mail.google.com/chat/u/0/#chat/space/1234567.