En esta guía, se explica cómo usar el método create
en el recurso Space
de la API de Google Chat para crear un espacio con nombre.
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.
Un espacio con nombre es un lugar en el que las personas envían mensajes, comparten archivos y colaboran. Los espacios con nombre pueden incluir apps de Chat. Los espacios con nombre incluyen funciones adicionales que las conversaciones grupales y los mensajes directos sin nombre no tienen, como los administradores del espacio, que pueden aplicar parámetros de configuración administrativos y descripciones, y agregar o quitar personas y apps. Después de crear un espacio con nombre,
el único miembro del espacio es el usuario autenticado. El espacio no incluye a otras personas o apps, ni siquiera la app de Chat que lo crea. Para agregar personas, crea membresías en el espacio llamando al método create
en el recurso Member
.
Para obtener información sobre cómo hacerlo, consulta Crea una membresía.
Para crear un espacio con nombre con varios miembros (un chat en grupo sin nombre entre tres o más personas, una conversación de mensaje directo entre dos personas o una persona y la app de Chat que llama a la API de Chat), configura un espacio en su lugar.
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 creación de un espacio requiere la autenticación del usuario con el permiso de autorización
chat.spaces.create
ochat.spaces
.
Crear un espacio con nombre
Para crear un espacio con nombre, pasa lo siguiente en tu solicitud:
- Especifica el alcance de autorización de
chat.spaces.create
ochat.spaces
. - Llama al método
create
en el recursoSpace
. - Configura
spaceType
comoSPACE
. - Configura
displayName
con el nombre del espacio visible para el usuario. En el siguiente ejemplo,displayName
se configura comoAPI-made
. - De manera opcional, configura otros atributos del espacio, como
spaceDetails
(una descripción visible para el usuario y un conjunto de lineamientos del espacio).
A continuación, te mostramos cómo crear un espacio con nombre:
Python
- En el directorio de trabajo, crea un archivo llamado
chat_space_create_named.py
. Incluye el siguiente código en
chat_space_create_named.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 creates a Chat space. ''' # 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().create( # Details about the space to create. body = { # To create a named space, set spaceType to SPACE. 'spaceType': 'SPACE', # The user-visible name of the space. 'displayName': 'API-made' } ).execute() # Prints details about the created membership. print(result) if __name__ == '__main__': main()
En el directorio de trabajo, compila y ejecuta la muestra:
python3 chat_space_create_named.py
Se creará un espacio con nombre. Para navegar al espacio, usa el ID de recurso del espacio a fin de compilar su URL. Puedes encontrar 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 navegar al espacio con la siguiente
URL: https://mail.google.com/chat/u/0/#chat/space/1234567
.
Temas relacionados
- Para agregar personas y apps al espacio, crea miembros.
- Crea un mensaje para publicar en el espacio.
- Obtén detalles sobre un espacio.
- Enumera espacios.
- Actualiza un espacio.
- Borrar un espacio.
- Configura un espacio.
- Busca un espacio de mensaje directo.