Compila una app de Google Chat con Google Apps Script

En esta página, se explica cómo compilar un complemento de Google Workspace que funcione en Google Chat con Google Apps Script.

La app de Chat te permite enviar mensajes directos y responde con la repetición de tus mensajes.

En el siguiente diagrama, se muestran la arquitectura y el patrón de mensajería:

Arquitectura de una app de Chat implementada con Apps Script.

En el diagrama anterior, un usuario que interactúa con una app de Chat de Apps Script tiene el siguiente flujo de información:

  1. Un usuario envía un mensaje a una app de Chat, ya sea en un mensaje directo o en un espacio de Chat.
  2. La lógica de la app de Chat que se implementa en Apps Script, que reside en Google Cloud, recibe y procesa el mensaje.
  3. De manera opcional, la lógica de la app de Chat se puede integrar con los servicios de Google Workspace, como Calendar o Hojas de cálculo, o con otros servicios de Google, como Google Maps o YouTube.
  4. La lógica de la app de Chat envía una respuesta al servicio de la app de Chat en Chat.
  5. La respuesta se entrega al usuario.

Objetivos

  • Configura el entorno.
  • Configura la secuencia de comandos.
  • Configura la app de Chat.
  • Prueba la app de Chat.

Requisitos previos

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 esta muestra:

  1. En la consola de Google Cloud, ve a la página Seleccionar un proyecto.

    Selecciona un proyecto de Cloud

  2. Selecciona el proyecto de Google Cloud que deseas usar. O bien, haz clic en Crear proyecto y sigue 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.

Habilitar la API

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. Configurar la pantalla de consentimiento de OAuth de tu app define lo que se muestra a los usuarios y revisores de apps, y registra tu app para que puedas publicarla más adelante.

  1. En la consola de APIs de Google, ve a Menú > Plataforma de autenticación de Google > Información de la marca.

    Ir a Información de la marca

  2. Si ya configuraste la plataforma de autenticación de Google, puedes configurar los siguientes parámetros de configuración de la pantalla de consentimiento de OAuth en Información de la marca, Público y Acceso a los datos. Si ves un mensaje que dice Aún no se configuró la plataforma de autenticación de Google, haz clic en Comenzar:
    1. En Información de la aplicación, en Nombre de la app, ingresa un nombre para la app.
    2. En Correo electrónico de asistencia al usuario, elige una dirección de correo electrónico de asistencia en la que los usuarios puedan comunicarse contigo si tienen preguntas sobre su consentimiento.
    3. Haz clic en Siguiente.
    4. En Público, selecciona Interno.
    5. Haz clic en Siguiente.
    6. En Información de contacto, ingresa una Dirección de correo electrónico en la que puedas recibir notificaciones sobre cualquier cambio en tu proyecto.
    7. Haz clic en Siguiente.
    8. En Finalizar, revisa la Política de Datos del Usuario de los Servicios de las APIs de Google y, si estás de acuerdo, selecciona Acepto la Política de Datos del Usuario de los Servicios de las APIs de Google.
    9. Haz clic en Continuar.
    10. Haz clic en Crear.
  3. Por ahora, puedes omitir la adición de permisos. En el futuro, cuando crees una app para usar fuera de tu organización de Google Workspace, debes cambiar el Tipo de usuario a Externo. Luego, agrega los permisos de autorización que requiere tu app. Para obtener más información, consulta la guía completa Configura el consentimiento de OAuth guide.

Configura la secuencia de comandos

Para configurar la secuencia de comandos, usa la plantilla de la app de Chat de la página Comenzar de Apps Script.

Crea el proyecto de Apps Script

  1. En la página Comenzar de Apps Script, ve a Iniciadores de complementos de Google Workspace y haz clic en la plantilla App de Chat:

    Abre la plantilla de la app de Chat

  2. En el nuevo proyecto de Apps Script que se abre, asigna un nombre al proyecto:

    1. Haz clic en Proyecto sin título.

    2. En Título del proyecto, escribe Add-on Chat app.

    3. Haga clic en Cambiar nombre.

En el futuro, si deseas usar ciertas APIs de Google o publicar tu app, debes asociar tu proyecto de Cloud con tu proyecto de Apps Script. Para esta guía, no es necesario que lo hagas. Para obtener más información, consulta la guía de proyectos de Google Cloud.

Crea 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 implementación principal, haz lo siguiente:

  1. En el proyecto de Apps Script de la app de Chat, haz clic en Implementar > Implementaciones de prueba.
  2. Copia el ID de implementación principal para usarlo en un paso posterior y haz clic en Listo.

Configura la app de Chat

Sigue estos pasos para configurar la app de Google Chat:

  1. En la consola de APIs, busca Google Chat API, y haz clic en Google Chat API.
  2. Haz clic en Administrar.
  3. Haz clic en Configuración y configura la app de Chat:

    1. En el campo Nombre de la app, ingresa Add-on Chat app.
    2. En el campo URL del avatar, ingresa https://developers.google.com/workspace/add-ons/images/quickstart-app-avatar.png.
    3. En el campo Descripción, ingresa Add-on Chat app.
    4. En Funcionalidad, selecciona Unirse a espacios y conversaciones grupales.
    5. En Configuración de la conexión, selecciona Proyecto de Apps Script.
    6. En el campo ID de implementación, pega el ID de implementación principal que copiaste anteriormente.
    7. En Visibilidad, selecciona Personas y grupos específicos de tu dominio y escribe tu correo electrónico.
  4. Haz clic en Guardar.

La app de Chat está lista para responder a los 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:

  1. Abre Google Chat con la cuenta de Google Workspace que proporcionaste cuando te agregaste como evaluador de confianza.

    Ve a Google Chat

  2. Haz clic en Nuevo chat.
  3. En el campo Agregar 1 o más personas, escribe el nombre de tu app de Chat.
  4. Selecciona tu app de Chat en los resultados. Se abrirá un mensaje directo.

  5. En el nuevo mensaje directo con la app, escribe Hello y presiona enter.

    La app de Chat te agradece por agregarla y repite tu mensaje.

Para agregar evaluadores de confianza y obtener más información sobre las pruebas de funciones interactivas, consulta Prueba funciones interactivas para apps de Google Chat.

Solucionar problemas

Cuando una app o tarjeta de Google Chat muestra un error, la interfaz de Chat muestra un mensaje que dice "Se produjo un error". o "No se pudo procesar la solicitud". A veces, la IU de Chat no muestra ningún mensaje de error, pero la app o tarjeta de Chat produce un resultado inesperado; por ejemplo, es posible que no aparezca un mensaje de tarjeta.

Aunque es posible que no se muestre un mensaje de error en la IU de Chat, hay mensajes de error descriptivos y datos de registro disponibles para ayudarte a corregir errores cuando se activa el registro de errores para las apps de Chat. Para obtener ayuda para ver, depurar y corregir errores, consulta Soluciona y corrige 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.

  1. En la consola de APIs de Google, ve a la página Administrar recursos. Haz clic en Menú > IAM y administración > Administrar recursos.

    Ir al administrador de recursos

  2. En la lista de proyectos, selecciona el proyecto que deseas borrar y haz clic en Borrar .
  3. En el diálogo, escribe el ID del proyecto y, luego, haz clic en Cerrar para borrar el proyecto.