Compila complementos de Google Workspace

Cuando desees compilar un nuevo Google Workspace complemento, sigue este procedimiento general:

  1. Configura los proyectos de complementos y elige un propietario y colaboradores.
  2. Diseña el aspecto y el comportamiento de tu complemento.
  3. Configura el manifiesto del proyecto o el recurso de implementación del complemento.
  4. Escribe el código para definir la apariencia y el comportamiento del complemento.
  5. Verifica los permisos de OAuth del complemento.
  6. Prueba el complemento dentro de las aplicaciones host que extiende.
  7. Publica el complemento.

Configura tus proyectos de complementos y elige un propietario y colaboradores

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

Antes de comenzar el desarrollo del complemento, elige una sola cuenta de usuario para poseer los proyectos y decidir qué otras cuentas son 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

Puedes compilar los archivos de 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 te permite garantizar con facilidad que varios colaboradores siempre tengan acceso al proyecto de la secuencia de comandos.

Cuando publicas un complemento, una única cuenta de usuario actúa como publicador. La cuenta de publicación debe tener acceso de edición al proyecto de secuencia de comandos, pero no es necesario que sea el propietario.

Proyectos de Google Cloud

Te recomendamos que agregues colaboradores al proyecto de Cloud de complemento. Esto ayuda a garantizar que alguien de tu equipo siempre pueda acceder a la configuración de la nube del complemento.

Diseña la apariencia y el comportamiento de tu complemento

Decide cómo deseas que se vea tu complemento y cómo debería comportarse antes de comenzar a compilarlo. Considera para qué casos prácticos el complemento debe intentar proporcionar soluciones. Comienza con un diseño simple para comenzar a trabajar y, luego, agrega más mejoras.

Consulta la Google Workspace guía de estilo de complementos a fin de obtener lineamientos para diseñar la experiencia del usuario del complemento.

Configura el manifiesto del proyecto del complemento

En los proyectos de Apps Script, el manifiesto del proyecto es un archivo JSON especial. Especifica una variedad de detalles sobre el proyecto, como sus dependencias de biblioteca. En el caso de los Google Workspace complementos, el manifiesto también proporciona la información básica que necesita la aplicación host para mostrar el complemento de forma correcta.

Consulta Manifiestos para obtener información sobre cómo configurar el manifiesto del complemento en Apps Script.

A medida que agregues código y funciones a tu complemento, edita el manifiesto según sea necesario para producir la apariencia y el comportamiento necesarios del complemento.

Codifique el complemento

Debes implementar una interfaz basada en tarjetas para el complemento. Usa el Servicio de tarjetas de Apps Script o, si escribes en otro lenguaje de código, muestra un JSON con el formato correcto para que la interfaz se procese como tarjetas.

También debes implementar cualquier función de activador especificada en el manifiesto del complemento. Si tu complemento se conecta a un servicio de terceros que no es de Google mediante OAuth, también debes configurar OAuth para ese servicio.

Cómo construir tarjetas

Para definir una interfaz de usuario de complemento, crea objetos Card y complétalos con widgets. Las funciones de activador especificadas en tu manifiesto deben mostrar un solo objeto Card o un arreglo de objetos Card que representen páginas de la interfaz de complemento. El complemento también puede crear y mostrar tarjetas nuevas en respuesta a las acciones del usuario.

En la secuencia de comandos de apps, crea tarjetas con la clase CardBuilder. Cada tarjeta requiere un CardHeader y uno o más CardSections. Debes propagar cada sección de tarjeta con los widgets individuales que conforman la interfaz de complemento. Los widgets de interacción, por lo general, están vinculados a acciones para definir su comportamiento.

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

Puedes usar otros servicios integrados de Apps Script, como CalendarApp, para recuperar información que se mostrará en las tarjetas de complementos que compiles. Puedes usar datos recuperados de servicios que no son de Google.

Si tu Google Workspace complemento necesita acceso a API que no sean de Google y que requieran OAuth, debes configurarlo y conectarte a él. Consulta la guía Cómo conectarse a servicios que no son de Google para obtener más detalles.

Orden de construcción

Cuando compilas una tarjeta, debes compilar desde arriba. Es decir, debes usar este orden de construcción:

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

Esto es necesario porque cuando agregas un widget a una tarjeta o sección de tarjeta, en realidad agregas una copia de ese widget. Cualquier cambio que hagas en el objeto del widget después de agregarlo no se reflejará en la tarjeta final.

Acciones universales

Puedes usar acciones universales para proporcionar una funcionalidad independiente del contexto. Las acciones universales son elementos de menú disponibles en la IU del complemento, sin importar qué tarjeta se muestra actualmente. Todas las acciones universales definidas siempre aparecen en el menú de la tarjeta del complemento.

Consulta Acciones universales para obtener más detalles.

Verifique los permisos de OAuth del complemento

Los alcances definen las acciones que el complemento puede realizar en nombre de un usuario. Se recomienda que los complementos solo tengan alcances para las acciones que deben tener en orden y nada más.

En los proyectos de complementos, establece de forma explícita los alcances de los complementos para garantizar que el complemento use el conjunto de permisos menos permisivo posible. Tú defines qué alcances usará tu complemento en el manifiesto del complemento.

Consulta Alcances para obtener más detalles.

Prueba el complemento

Para probar los complementos no publicados, primero debes instalarlos. Una vez instalado y autorizado, puedes usar el complemento en tu cuenta y probar su apariencia y comportamiento en las aplicaciones host que extiende. Debes verificar que el complemento se comporte como se espera para los contextos y las acciones del usuario.

Consulta Cómo probar complementos Google Workspace para obtener más detalles.

Publica el complemento

Si publicas el complemento, estará disponible para otros usuarios, ya sea de forma pública o solo en tu dominio. Antes de comenzar el proceso de publicación, asegúrate de revisar la descripción general de la publicación. La publicación es un proceso complejo que requiere preparación y tiempo para completarse.

Google Workspace Los complementos se publican en Google Workspace Marketplace. Los complementos disponibles públicamente deben completar la revisión de la app antes de que se publiquen.

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

Google Workspace Ejemplo de complemento

 l10n-placeholder41=.

Para ayudarte a comprender cómo se crean los Google Workspace complementos, en la guía de inicio rápido sobre complementos deGoogle Workspace , se muestra cómo compilar un complemento simple Google Workspace, incluidas las páginas principales, la navegación de tarjetas y las conexiones a un servicio de terceros. Una vez que hayas completado la guía de inicio rápido, puedes instalar el complemento y experimentar con el código.