Compila complementos de Google Workspace

Aprende a diseñar, compilar y publicar complementos de Google Workspace:

  1. Determina en qué aplicaciones de Google Workspace quieres que esté disponible tu complemento para los usuarios.
  2. Configura los proyectos de tu complemento y elige un propietario y colaboradores.
  3. Diseña y configura la apariencia y el comportamiento de tu complemento.
  4. Compila el complemento.
  5. Verifica los permisos de OAuth de tu complemento.
  6. Prueba el complemento en una o más aplicaciones de Google Workspace.
  7. Publica el complemento.

Compila un complemento con Apps Script o HTTP. Para comparar ambos, mira el video "Apps Script vs. HTTP endpoints: Which should you choose?" (Comparación entre Apps Script y los extremos HTTP: ¿Cuál deberías elegir?). 🤔".

Elige aplicaciones alojadas de Google Workspace

Puedes configurar los complementos de Google Workspace para que aparezcan en las siguientes aplicaciones alojadas de Google Workspace:

  • Gmail
  • Calendario de Google
  • Google Chat
  • Documentos de Google
  • Google Drive
  • Google Meet
  • Hojas de cálculo de Google
  • Presentaciones de Google

Para crear aplicaciones de Google Workspace, consulta Extiende la IU de Google Workspace.

Configura los proyectos de tu complemento y elige un propietario y colaboradores

Si compilas tu complemento en Apps Script, crearás un proyecto de Apps Script y un proyecto de Google Cloud. Si compilas tu complemento en un lenguaje que no sea Apps Script, solo debes crear un proyecto de Google Cloud.

Para compilar un complemento, debes configurar un proyecto de secuencia de comandos y un proyecto de Cloud.

Antes de comenzar el desarrollo de complementos, elige una sola cuenta de usuario para ser propietario de los proyectos y decide qué otras cuentas serán colaboradores. El propietario de los proyectos crea y administra los archivos del proyecto y la configuración asociada, mientras que los colaboradores pueden ayudar con la codificación y las pruebas.

Proyectos de Apps Script

Antes de compilar tu complemento, revisa las cuotas y limitaciones de Apps Script para alinear el diseño de tu proyecto con estos lineamientos. Apps Script es ideal para el desarrollo ligero de complementos personales o internos con una pequeña base de usuarios. Si tu complemento requiere compatibilidad con muchos usuarios, baja latencia o control total sobre tu infraestructura, considera usar un entorno de ejecución diferente.

Crea los archivos del proyecto de Apps Script de tu complemento en una unidad compartida para que ninguna cuenta tenga la propiedad exclusiva. Colocar el archivo de secuencia de comandos del complemento en una unidad compartida garantiza que todos los colaboradores tengan acceso al proyecto de secuencia de comandos.

Cuando publicas un complemento, una sola cuenta de usuario es el publicador. La cuenta de publicación debe tener acceso de edición al proyecto de secuencia de comandos, pero no es necesario que sea la propietaria.

Para crear un proyecto de Apps Script, consulta Proyectos de secuencias de comandos.

Proyectos de Google Cloud

Agrega colaboradores al proyecto de Cloud del complemento. Esto garantiza que tu equipo siempre pueda acceder a la configuración de Cloud del complemento.

Para crear un proyecto de Google Cloud, consulta Crea un proyecto de Google Cloud.

Diseña y configura la apariencia y el comportamiento de tu complemento

Decide cómo se verá y se comportará tu complemento antes de compilarlo. Considera qué casos de uso resuelve el complemento. Comienza con un diseño básico para que funcione primero y, luego, agrega detalles.

Consulta la guía de estilo de los complementos de Google Workspace para obtener instrucciones sobre cómo diseñar la experiencia del usuario de tu complemento.

Configura el manifiesto del complemento

Implementa el diseño en el manifiesto del complemento. Configura la apariencia y el comportamiento del complemento en el manifiesto, incluidas las aplicaciones host de Google Workspace que extiende el complemento.

Para obtener más información, consulta Manifiestos para complementos de Google Workspace.

A medida que agregues código y funciones, actualiza el manifiesto según sea necesario para definir la apariencia y el comportamiento requeridos del complemento.

Configura la apariencia y el comportamiento de la app de Google Chat

Si diseñas un complemento que extiende Google Chat, usa la API de Google Chat para configurar la apariencia y el comportamiento de una app de Chat. Para conocer los pasos, consulta Usa la API de Google Chat.

Compila el complemento

Implementa una interfaz basada en tarjetas para el complemento. Usa Card service o, si usas otro lenguaje de código, devuelve JSON con formato para que la interfaz se renderice como tarjetas.

Implementa las funciones de activación especificadas en el manifiesto del complemento. Si tu complemento se conecta a un servicio de terceros con OAuth, configura OAuth para ese servicio.

Tarjetas de estructura

Define una interfaz de usuario del complemento creando objetos Card y agregando widgets. Las funciones de activación especificadas en tu manifiesto deben devolver un solo objeto Card o un array de objetos Card que representen diferentes "páginas" de la interfaz del complemento. El complemento también puede crear y mostrar tarjetas nuevas en respuesta a las acciones del usuario.

En Apps Script, crea tarjetas con la clase CardBuilder. Cada tarjeta requiere un CardHeader y uno o más CardSections. Completa cada sección de la tarjeta con los widgets individuales que componen la interfaz. Los widgets de interacción suelen vincularse a acciones para definir su comportamiento de interacción.

Después de agregar todas las secciones y los widgets a tu tarjeta a través de su CardBuilder, llama a CardBuilder.build para crear el objeto Card correspondiente.

Usa los servicios integrados de Apps Script](/apps-script/guides/services/) como CalendarApp para recuperar información que se mostrará en las tarjetas del complemento. Usar datos de servicios que no son de Google

Si tu complemento necesita acceder a APIs que no son de Google y que requieren OAuth, configura y conéctate a ese servicio. Consulta la guía para conectarse a servicios que no son de Google.

Orden de construcción

Cuando crees una tarjeta, comienza por la parte superior. Usa este orden de construcción:

  1. Compila el widget.
  2. Agrega el widget a la sección de la tarjeta.
  3. Repite el proceso hasta que la sección de la tarjeta tenga todos sus widgets.
  4. Agrega la sección de la tarjeta a la tarjeta.

Esto se debe a que, cuando agregas un widget a una tarjeta o sección de tarjeta, en realidad agregas una copia de ese widget. Los cambios que realices en el objeto del widget después de agregarlo no se reflejarán en la tarjeta final.

Acciones universales

Usa acciones universales para proporcionar funcionalidad independiente del contexto. Las acciones universales son elementos de menú disponibles en la IU del complemento, independientemente de la tarjeta. Todas las acciones universales definidas aparecen en el menú de la tarjeta del complemento.

Consulta Acciones universales para obtener más detalles.

Verifica los permisos de OAuth del complemento

Los alcances definen las acciones que el complemento puede realizar en nombre del usuario. Los complementos solo deben tener los alcances que necesitan para funcionar.

En los proyectos de complementos, establece los alcances del complemento para garantizar que el complemento use el conjunto de alcances menos permisivo posible. Define los alcances en el manifiesto del complemento.

Consulta Alcances para obtener más detalles.

Prueba el complemento

Para probar complementos no publicados, primero debes instalar el complemento no publicado. Después de instalarlo y autorizarlo, usa el complemento en tu cuenta para probar su apariencia y comportamiento en las aplicaciones alojadas que extiende. Verifica que el complemento se comporte como se espera en los contextos y las acciones del usuario.

Para comenzar a probar tu complemento, consulta las siguientes guías:

Publica el complemento

La publicación hace que tu complemento esté disponible para otras personas. Antes de publicar, revisa la descripción general de la publicación. La publicación es un proceso complejo que requiere preparación.

Los complementos de Google Workspace se publican en Google Workspace Marketplace. Los complementos disponibles públicamente requieren una revisión de la app antes de publicarse.

Consulta Publicación de complementos de Google Workspace para obtener más detalles.