Configura una app de Google Chat

En esta página, se explica cómo configurar e implementar una app de Google Chat como complemento de Google Workspace.

Para implementar y probar un complemento de Google Workspace que extienda Chat, debes habilitar y configurar una app de Chat con la API de Google Chat. En la configuración de la API de Chat, debes especificar todos los detalles sobre la app de Chat, incluidos el nombre, el avatar, la implementación y las funciones interactivas que deseas usar.

Requisitos previos

HTTP

Apps Script

Elige un nombre visible, un avatar y una descripción para tu app de Chat

El nombre, el avatar y la descripción de la app de Chat se muestran a los usuarios en la IU de Chat. Para interactuar con las apps de chat, los usuarios ven o usan esta información de las siguientes maneras:

  • @menciona la app de Chat para agregarla a un espacio o enviarle un mensaje.
  • Busca y comienza un mensaje directo con la app de Chat. En el menú Apps, los mensajes directos muestran el nombre y el avatar de la app de Chat.
  • Desde la barra de redacción, los usuarios pueden explorar las apps de Chat y ver su nombre, avatar y descripción.

Antes de configurar una app de Chat, debes preparar la siguiente información:

Campo Descripción Formato
Nombre de la aplicación Es el nombre visible de la app de Chat. Hasta 25 caracteres alfanuméricos
URL del avatar Es la imagen que se muestra como el avatar de tu app de Chat. Una URL HTTPS que dirija a una imagen gráfica cuadrada (PNG o JPEG) El tamaño recomendado es de 256 por 256 píxeles o más.
Descripción Una breve descripción del propósito de la app de Chat Hasta 40 caracteres alfanuméricos

En la siguiente sección, especificarás esta información en la configuración de la API de Chat.

Configura tu app de Chat en la consola de Google Cloud

Cuando tengas los detalles de tu app de Chat, abre tu proyecto de Cloud y configura la API de Chat:

  1. En la consola de Google Cloud, ve a la página de la API de Chat y haz clic en la página Configuración:

    Ve a la página Configuración de la API de Chat

  2. En Información de la aplicación, completa los campos Nombre de la app, URL del avatar y Descripción.

  3. En Funciones interactivas, haz clic en Habilitar funciones interactivas para activarlo y completa lo siguiente:

    1. En Funcionalidad, selecciona una o más casillas de verificación para que tu app de Chat esté disponible para instalarse y usarse:

      • Recibir mensajes 1:1: Los usuarios pueden instalar la app de Chat y enviar mensajes en un espacio exclusivo entre el usuario y la app de Chat.

      • Unirse a espacios y conversaciones grupales: Los usuarios pueden agregar la app de Chat y usarla en espacios con varias personas.

    2. En Configuración de conexión, selecciona la arquitectura que deseas usar para recibir objetos de eventos de Chat:

      • Para usar un servicio HTTP, selecciona URL del extremo HTTP y proporciona una URL.
      • Para usar un proyecto de Google Apps Script, selecciona Apps Script y proporciona un ID de implementación para el proyecto.

    3. Opcional: Para recibir objetos de evento en más de un extremo o función, ve a Configuración avanzada > Activadores y proporciona o actualiza las funciones de devolución de llamada para los siguientes activadores de chat:

      • ADDED_TO_SPACE: Un usuario agrega la app de Chat a una conversación grupal o un espacio, o instala la app de Chat para mensajes 1:1.
      • MESSAGE: Un usuario envía un mensaje a la app de Chat. Por ejemplo, envía un mensaje directo a la app de Chat o la menciona en un espacio con varias personas.
      • REMOVED_FROM_SPACE: Un usuario desinstala o quita la app de Chat de un espacio.

    4. Opcional: Agrega otras funciones interactivas, como comandos de barra o vistas previas de vínculos.

    5. En Visibilidad, especifica tu correo electrónico para que puedas instalar y probar la app de Chat antes de publicarla en Google Workspace Marketplace. Puedes especificar hasta cinco personas o uno o más Grupos de Google de tu organización de Google Workspace.

  4. Opcional: En Registros, selecciona la casilla de verificación Registrar errores en Logging para usar Google Cloud Logging. Para obtener más información, consulta Cómo consultar registros de errores de apps de Chat en la documentación de la API de Chat.

  5. Haz clic en Guardar.

Después de guardar la configuración, cualquier persona que especifiques en la configuración de Visibilidad de la API de Chat puede instalar, probar o usar la app de Chat. Para comenzar a probar y depurar tu app de Chat, consulta Cómo probar las funciones interactivas de las apps de Google Chat en la documentación de la API de Chat.

Consideraciones para los complementos de Google Workspace existentes

Las apps de chat requieren una configuración diferente en comparación con los complementos de Google Workspace que extienden otras aplicaciones de Google Workspace. Si tu complemento extiende otras aplicaciones de Google Workspace, ten en cuenta los siguientes requisitos para configurar la app de Chat:

  • Tanto las personas como los administradores de Google Workspace deben poder instalar tu complemento desde Marketplace. Puedes configurar estos parámetros de configuración de instalación en el SDK de Google Workspace Marketplace.
  • Las apps de Chat no usan el nombre ni el logotipo que configuras para otras aplicaciones de Google Workspace en el objeto addons.common del manifest.
  • En el caso de los complementos que se publican en Google Workspace Marketplace, no puedes guardar un borrador de los cambios en la configuración de la API de Google Chat. Después de actualizar y guardar la configuración de la API de Chat, la app de Chat actualizada estará disponible para todos los usuarios existentes. Para actualizar tu ficha de mercado, puedes crear un borrador antes de enviar los cambios.

  • Si compilaste el complemento con Apps Script, haz lo siguiente:

  • Si compilaste tu complemento con un servicio HTTP, omite los detalles de configuración de la app de Chat en el manifiesto y las implementaciones que crees con la API de complementos de Google Workspace. Las implementaciones HTTP que especifiques en el SDK de Google Workspace Marketplace solo se usan para otras aplicaciones de Google Workspace.