En esta página, se proporciona una descripción general de cómo compilar interfaces de usuario (IU) para complementos de Google Workspace que extienden Google Chat.
Para compilar interfaces para apps de Chat, usa los siguientes componentes de complementos:
- Activadores: Son las formas en que los usuarios de Google Chat pueden invocar una app de Chat, por ejemplo, agregándola a un espacio o enviándole un mensaje.
- Objetos de eventos: Son los datos que las apps de Chat reciben de los activadores o las interacciones de la IU.
- Acciones: Son las formas en que las apps de Chat pueden responder a las interacciones, como enviar mensajes o mostrar una interfaz de usuario basada en tarjetas.
Las apps de chat pueden crear y mostrar tarjetas en las siguientes interfaces:
- Mensajes que pueden contener texto, tarjetas estáticas o interactivas, y botones
- Diálogos, que son tarjetas que se abren en una ventana nueva y, por lo general, les solicitan a los usuarios que envíen información
- Vistas previas de vínculos, que son tarjetas que muestran una vista previa de la información sobre un servicio externo
Activadores
En esta sección, se explican los activadores que usan los complementos de Google Workspace en Chat.
Los activadores son las formas específicas en que los usuarios invocan una app de Chat con la IU de Chat, como usar @menciones o comandos de la app.
En la siguiente tabla, se muestran los activadores de Chat, una descripción y cómo suelen responder las apps de Chat:
| Activador | Descripción | Respuesta típica |
|---|---|---|
| Se agregó al espacio |
Un usuario agrega la app de Chat a un espacio, o un administrador de Google Workspace instala la app de Chat en espacios de mensajes directos para los usuarios de su organización. Para obtener información sobre las apps de Chat instaladas por los administradores, consulta Cómo instalar apps de Marketplace en tu dominio en la documentación del Centro de ayuda para administradores de Google Workspace. |
La app de Chat envía un mensaje de incorporación que explica qué hace y cómo pueden interactuar con ella los usuarios del espacio. |
| Mensaje |
Un usuario interactúa con la app de Chat en un mensaje de una de las siguientes maneras:
|
La app de Chat responde en función del contenido del mensaje. Por ejemplo, una app de Chat responde al comando de barra /about con un mensaje que explica las tareas que puede realizar la app de Chat.
|
| Se quitó del espacio |
Un usuario quita la app de Chat de un espacio, o un administrador de Google Workspace desinstala la app de Chat para un usuario de su organización. Los usuarios no pueden quitar las apps de Chat que instaló su administrador. Si un usuario ya había instalado la app de Chat, esta permanecerá instalada, independientemente de si un administrador de Google Workspace intenta desinstalarla. |
La app de Chat quita las notificaciones entrantes configuradas para el espacio (como borrar un webhook) y borra el almacenamiento interno. Las apps de chat no pueden responder con mensajes a este activador, ya que ya no son miembros del espacio. |
| Comando de la app |
Un usuario usa un comando de la app de Chat. |
La app de Chat responde al comando. Por ejemplo, respuestas con un mensaje o apertura de un diálogo. |
A diferencia de otros complementos de Google Workspace, debes configurar las funciones de devolución de llamada para estos activadores con la API de Google Chat. Para obtener orientación, consulta Cómo configurar una app de Google Chat.
Para responder a un activador, consulta las siguientes guías:
- Envía mensajes de Google Chat
- Abrir diálogos interactivos
- Vista previa de vínculos en mensajes de Google Chat
Objetos de eventos
Las apps de Chat reciben objetos de eventos cuando se activa un activador de Chat o cuando los usuarios de Chat interactúan con una IU de la app de Chat (por ejemplo, cuando hacen clic en un botón). El objeto de evento contiene datos sobre la interacción que la app de Chat puede usar para responder o actualizar una IU.
Para obtener información sobre el manejo de objetos de eventos, consulta las siguientes guías:
- Envía mensajes de Google Chat
- Abrir diálogos interactivos
- Vista previa de vínculos en mensajes de Google Chat
Para obtener información sobre los objetos de eventos de complementos en Chat y otras aplicaciones de Google Workspace, consulta Objetos de eventos.
Acciones del chat
En esta sección, se explica cómo las apps de Chat pueden usar acciones de complemento para responder a las interacciones del usuario.
Para responder con una acción del complemento, una app de Chat debe responder en un plazo de 30 segundos, y la respuesta debe publicarse en el espacio en el que se produjo la interacción. De lo contrario, la app de Chat debe configurar la autenticación y llamar a la API de Google Chat para responder.
Las apps de chat pueden controlar y responder a las interacciones de muchas maneras. En muchos casos, las apps de Chat responden con un mensaje. Las apps de chat también pueden buscar información en una fuente de datos, registrar la información del objeto de evento o cualquier otra cosa. Este comportamiento de procesamiento es, en esencia, lo que define la app de Google Chat.
Para responder a las interacciones del usuario, las apps de Chat deben controlar el objeto de evento correspondiente y devolver uno de los siguientes objetos JSON:
DataActions: Crea o actualiza datos de Google Workspace. Para enviar o actualizar mensajes de Chat, el objeto debe contener el lenguaje de marcado que define los cambios en los datos deMessage, representados comochatDataActionMarkup.RenderActions: Crea o actualiza un diálogo, o bien proporciona sugerencias de entrada para un menú de selección múltiple.AuthorizationError: Muestra a los usuarios una tarjeta de autorización para acceder o autenticarse en un servicio externo a Google. En Chat, solo se admite la tarjeta de autorización básica.
| Respuesta de la app de chat | Acción obligatoria para la devolución |
|---|---|
| Enviar o actualizar un mensaje | DataActions |
| Abrir, actualizar o cerrar un diálogo | RenderActions |
| Para recopilar información de una tarjeta o un diálogo, sugiere elementos de selección según lo que los usuarios escriben en un menú de selección múltiple. | RenderActions |
| Vistas previas de vínculos en los mensajes que los usuarios de Chat envían en un espacio | DataActions |
Responde con la API de Google Chat
En lugar de devolver una acción del complemento, es posible que las apps de Chat deban usar la API de Google Chat para responder a una interacción. Por ejemplo, las apps de Chat deben llamar a la API de Google Chat para realizar cualquiera de las siguientes acciones:
- Responder a una interacción después de 30 segundos
- Realizar tareas fuera del espacio en el que se produjo la interacción
- Realizar tareas en Chat que no están disponibles como acciones de complementos Por ejemplo, enumerar los espacios de los que un usuario o una app de Chat son miembros, o agregar usuarios a un espacio
- Realizar tareas en nombre del usuario de Chat (lo que requiere autenticación del usuario)
Para obtener información sobre cómo autenticar y llamar a la API de Chat, consulta la descripción general de la API de Chat.
Temas relacionados
- Activadores para complementos de Google Workspace
- Configura una app de Google Chat
- Objetos de eventos
- Acciones de complementos
- Envía mensajes de Google Chat
- Abrir diálogos interactivos
- Vista previa de vínculos en mensajes de Google Chat
- Descripción general de la API de Chat