Compila complementos de Google Workspace

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

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

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

Si compilas tu complemento en Apps Script, creas 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.

Antes de comenzar el desarrollo de complementos, elige una sola cuenta de usuario para poseer los proyectos y decide qué otras cuentas son colaboradores. El propietario de los proyectos crea y administra los archivos del proyecto y las configuraciones asociadas, mientras que los colaboradores pueden ayudarte 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 propiedad exclusiva. Colocar el archivo de secuencia de comandos del complemento en una unidad compartida garantiza que varios colaboradores tengan acceso al proyecto de secuencia de comandos.

Cuando publicas un complemento, una sola cuenta de usuario actúa como publicador. La cuenta de publicación debe tener acceso de edición al proyecto de la 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

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

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

Diseña la apariencia y el comportamiento de tus complementos

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

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

Cómo configurar 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 bibliotecas. En el caso de los complementos de Google Workspace, el manifiesto también proporciona la información básica que la aplicación host necesita para mostrar el complemento de forma correcta.

Consulta Manifiestos para obtener detalles sobre cómo configurar el manifiesto de tu 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 del complemento requeridos.

Codifica 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 idioma 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 que se especifique en el manifiesto del complemento. Si tu complemento se conecta a un servicio externo ajeno a Google mediante OAuth, también debes configurar OAuth para ese servicio.

Crea tarjetas

Para definir una interfaz de usuario de complemento, debes crear objetos Card y completarlos con widgets. Las funciones del activador especificadas en tu manifiesto deben mostrar un solo objeto Card o un array de objetos Card que representen diferentes “páginas” de la interfaz del complemento. Tu complemento también puede crear y mostrar tarjetas nuevas en respuesta a las acciones del usuario.

En Apps Script, puedes crear tarjetas con la clase CardBuilder. Cada tarjeta requiere un CardHeader y uno o más CardSections. Debes propagar cada sección de tarjetas con los widgets individuales que conforman la interfaz del complemento. Los widgets de interacción suelen estar vinculados a acciones para definir su comportamiento de interacción.

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 y mostrarla en las tarjetas del complemento que compiles. Puedes usar datos recuperados de servicios que no son de Google.

Si tus complementos de Google Workspace necesitan acceso a APIs que no son de Google y que requieren OAuth, debes configurar ese servicio y conectarte a él. Consulta la Guía sobre cómo conectarse a servicios que no son de Google para obtener más detalles.

Pedido de construcción

Cuando crees una tarjeta, debes compilar desde la recarga. Es decir, debes usar el siguiente orden de construcción:

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

Esto es necesario porque, cuando agregas un widget a una sección de tarjetas, 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

Puedes usar acciones universales para proporcionar una funcionalidad independiente del contexto. Las acciones universales son elementos de menú disponibles en la IU del complemento, independientemente de la tarjeta que se muestre. Todas las acciones universales definidas siempre 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 permisos definen qué acciones puede realizar el complemento en nombre de un usuario. Se recomienda que los complementos solo tengan permisos para las acciones que deben tener en orden y nada más.

En los proyectos de complementos, configura los permisos de los complementos de forma explícita para asegurarte de que el complemento use el conjunto de alcances menos permisivo posible. Tú defines los alcances que usa 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 instalar el complemento no publicado. 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 los complementos de Google Workspace para obtener más detalles.

Publica el complemento

Si publicas tu complemento, estará disponible para otras personas, ya sea de forma pública o solo para los usuarios de 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.

Los complementos de Google Workspace se publican en Google Workspace Marketplace. Los complementos disponibles a nivel público deben completar la revisión de la app antes de publicarse.

Consulta Cómo publicar el complemento de Google Workspace para obtener más detalles.