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 especificados.

El recurso Space representa un lugar en el que 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 organices un espacio, ten en cuenta lo siguiente:

  • El usuario (autenticado) que realiza la llamada 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 MD entre dos usuarios, se muestra el DM. De lo contrario, se crea un MD.
  • No puedes configurar espacios con respuestas en múltiples conversaciones ni agregar personas fuera de tu 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 la interfaz de línea de comandos:

    pip3 install --upgrade google-api-python-client google-auth-httplib2 google-auth-oauthlib oauth2client

  • Una app de Chat publicada. Para crear y publicar una app de Chat, consulta Cómo compilar una app de Google Chat.

  • Autorización configurada para la app de Chat. La configuració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 tu solicitud:

  • Especifica el alcance de autorización de 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} de 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 si incluyes una membresía con users/123456789 como member.name.
  • Para crear un DM entre el usuario que realiza la llamada y otro usuario humano, especifica la membresía del usuario humano en tu solicitud.
  • Para crear un DM entre el usuario que realiza la llamada y la app que realiza la llamada, configura Space.singleUserBotDm como 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 esta app como miembro de un espacio o MD existente entre dos usuarios humanos, consulta Crea 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:

    import os.path

from google.auth.transport.requests import Request
from google.oauth2.credentials import Credentials
from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError

# 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

Se configura 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 a fin de compilar su URL. Puedes obtener el ID de 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.