En esta página, se explica cómo compilar un complemento de Google Workspace que funcione en Google Chat con Google Apps Script. En Google Chat, los complementos aparecen para los usuarios como apps de Google Chat. Para obtener más información, consulta la descripción general de la extensión de Google Chat.
La app de Chat te permite enviar mensajes directamente y responderlos haciendo eco de tus mensajes.
En el siguiente diagrama, se muestra la arquitectura y el patrón de mensajería:
En el diagrama anterior, un usuario que interactúa con una app de chat de Apps Script tiene el siguiente flujo de información:
- Un usuario envía un mensaje a una app de Chat, ya sea en un mensaje directo o en un espacio de Chat.
- La lógica de la app de Chat que se implementa en Apps Script, que reside en Google Cloud, recibe y procesa el mensaje.
- De manera opcional, la lógica de la app de Chat se puede integrar en los servicios de Google Workspace, como Calendario o Hojas de cálculo, o en otros servicios de Google, como Google Maps o YouTube.
- La lógica de la app de Chat envía una respuesta al servicio de la app de Chat en Chat.
- La respuesta se entrega al usuario.
Objetivos
- Configura el entorno.
- Configura la secuencia de comandos.
- Configura un complemento de Google Workspace para la app de Chat.
- Prueba la app de Chat.
Requisitos previos
- Una cuenta de Google Workspace para empresas o negocios con acceso a Google Chat
- Un proyecto de Google Cloud, Para crear uno, consulta Crea un proyecto de Google Cloud.
Configura tu entorno
Abre tu proyecto de Cloud en la consola de Google Cloud
Si aún no está abierto, abre el proyecto de Cloud que deseas usar para este ejemplo:
- En la consola de Google Cloud, ve a la página Seleccionar un proyecto.
- Selecciona el proyecto de Google Cloud que deseas usar. También puedes hacer clic en Create project y seguir las instrucciones en pantalla. Si creas un proyecto de Google Cloud, es posible que debas activar la facturación para el proyecto.
Activa la API de Chat
Antes de usar las APIs de Google, debes activarlas en un proyecto de Google Cloud. Puedes activar una o más APIs en un solo proyecto de Google Cloud.En la consola de Google Cloud, habilita la API de Google Chat.
Cómo configurar la pantalla de consentimiento de OAuth
Todas las apps que usan OAuth 2.0 requieren una configuración de pantalla de consentimiento. Cuando configuras la pantalla de consentimiento de OAuth de tu app, defines lo que se muestra a los usuarios y revisores de apps, y registras tu app para que puedas publicarla más adelante.
- En la consola de Google Cloud, ve a Menú > APIs y servicios > Pantalla de consentimiento de OAuth.
- En Tipo de usuario, selecciona Interno y, luego, haz clic en Crear.
- Completa el formulario de registro de la aplicación y, luego, haz clic en Guardar y continuar.
Por ahora, puedes omitir agregar permisos y hacer clic en Guardar y continuar. En el futuro, cuando crees una app para usarla fuera de tu organización de Google Workspace, debes cambiar el Tipo de usuario a Externo y, luego, agregar los permisos de autorización que requiere tu app.
- Revisa el resumen del registro de tu app. Para realizar cambios, haz clic en Editar. Si el registro de la app parece correcto, haz clic en Volver al panel.
Configura la secuencia de comandos
Para configurar la secuencia de comandos, crea una copia del proyecto de la guía de inicio rápido y, luego, configura tu proyecto de Cloud en Apps Script.
Crea una copia del proyecto de la guía de inicio rápido
- Haz clic en el siguiente botón para abrir el proyecto de Apps Script del complemento en Google Chat.
Abre el proyecto - Haz clic en Descripción general.
- En la página de descripción general, haz clic en Crear una copia.
Asigna un nombre a tu copia del proyecto de Apps Script:
Haz clic en Copia de la app de chat de complementos.
En Título del proyecto, escribe
Add-on Chat app
.Haga clic en Cambiar nombre.
Copia el número del proyecto de Cloud
- En la consola de Google Cloud, ve a Menú > IAM y administración > Configuración.
- En el campo Número del proyecto, copia el valor.
Configura el proyecto de Cloud del proyecto de Apps Script
- En el proyecto de Apps Script de la app de Chat, haz clic en Configuración del proyecto .
- En Proyecto de Google Cloud Platform (GCP), haz clic en Cambiar proyecto.
- En Número de proyecto de GCP, pega el número de proyecto de Google Cloud.
- Haz clic en Establecer el proyecto.
Ahora tienes un código de app que funciona y que puedes probar (como se describe en los siguientes pasos) y, luego, personalizar para cumplir con tus requisitos.
Asegúrate de haber accedido a la Cuenta de Google correcta cuando abras el proyecto de Apps Script. A veces, la cuenta actual puede cambiar a la cuenta predeterminada sin que te des cuenta.
Cómo crear una implementación de prueba
Necesitas un ID de implementación para este proyecto de Apps Script, de modo que puedas usarlo en el siguiente paso.
Para obtener el ID de la implementación principal, haz lo siguiente:
- En el proyecto de Apps Script de la app de Chat, haz clic en Implementar > Probar implementaciones.
- Copia el ID de implementación principal para usarlo en un paso posterior y haz clic en Listo.
Configura el complemento
Con tu implementación de Apps Script, sigue estos pasos para crear un complemento y, luego, implementar la app de Google Chat:
- En la consola, busca
Google Chat API
y haz clic en API de Google Chat. - Haz clic en Administrar.
Haz clic en Configuración y configura la app de Chat:
- En el campo Nombre de la app, ingresa
Add-on Chat app
. - En el campo Avatar URL, ingresa
https://developers.google.com/chat/images/quickstart-app-avatar.png
. - En el campo Descripción, ingresa
Add-on Chat app
. - En Funcionalidad, selecciona Recibir mensajes 1:1 y Unirse a espacios y conversaciones grupales.
- En Configuración de conexión, selecciona Proyecto de Apps Script.
- En el campo ID de implementación, pega el ID de implementación principal que copiaste anteriormente.
- En Visibilidad, selecciona Personas y grupos específicos de tu dominio y, luego, ingresa tu correo electrónico.
- En el campo Nombre de la app, ingresa
Haz clic en Guardar.
La app de Chat está lista para responder mensajes.
Prueba la app de Chat
Para probar tu app de Chat, abre un espacio de mensajes directos con la app de Chat y envía un mensaje:
Abre Google Chat con la cuenta de Google Workspace que proporcionaste cuando te agregaste como verificador de confianza.
- Haz clic en Nuevo chat.
- En el campo Agregar 1 o más personas, escribe el nombre de tu app de Chat.
Selecciona tu app de Chat en los resultados. Se abrirá un mensaje directo.
En el nuevo mensaje directo con la app, escribe
Hello
y presionaenter
.La app de Chat te agradece por agregarlo y repite tu mensaje.
Para agregar verificadores de confianza y obtener más información sobre cómo probar funciones interactivas, consulta Cómo probar funciones interactivas para apps de Google Chat.
Solucionar problemas
Cuando una app de Google Chat o una tarjeta muestran un error, la interfaz de Chat muestra un mensaje que dice "Se produjo un error". o "No se puede procesar tu solicitud". A veces, la IU de Chat no muestra ningún mensaje de error, pero la app o la tarjeta de Chat producen un resultado inesperado. Por ejemplo, es posible que no aparezca un mensaje de la tarjeta.
Aunque es posible que no se muestre un mensaje de error en la IU de Chat, los mensajes de error descriptivos y los datos de registro están disponibles para ayudarte a corregir errores cuando se activa el registro de errores de las apps de Chat. Si necesitas ayuda para ver, depurar y corregir errores, consulta Cómo solucionar problemas y corregir errores de Google Chat.
Limpia
Para evitar que se apliquen cargos a tu cuenta de Google Cloud por los recursos que usaste en este instructivo, te recomendamos que borres el proyecto de Cloud.
- En la consola de Google Cloud, ve a la página Administrar recursos. Haz clic en Menú > IAM y administración > Administrar recursos.
- En la lista de proyectos, selecciona el proyecto que deseas borrar y haz clic en Borrar .
- En el cuadro de diálogo, escribe el ID del proyecto y, luego, haz clic en Cerrar para borrarlo.