Cuando desees compilar un nuevo complemento de Google Workspace, sigue este procedimiento general:
- Configura los proyectos de tu complemento y elige un propietario y colaboradores.
- Diseña la apariencia y el comportamiento de tu complemento.
- Configura el manifiesto del proyecto del complemento o el recurso de implementación.
- Escriba código para definir la apariencia y el comportamiento del complemento.
- Verifica los permisos de OAuth de tu complemento.
- Prueba el complemento dentro de las aplicaciones host que se extienden.
- Publica el complemento.
Configure los proyectos de su complemento y elija un propietario y colaboradores
Si compilas tu complemento en Apps Script, crearás un proyecto de Apps Script y uno de Google Cloud. Si compilas el complemento en un lenguaje que no sea Apps Script, solo deberás crear un proyecto de Google Cloud.
Antes de comenzar a desarrollar complementos, elige una sola cuenta de usuario para tener 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 del proyecto de Apps Script de tu complemento en una unidad compartida para que ninguna cuenta sea propietaria única. Colocar el archivo de secuencia de comandos de complemento en una unidad compartida te permite garantizar con facilidad que varios colaboradores siempre tengan acceso al proyecto de 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 necesita ser el propietario.
Proyectos de Google Cloud
Te recomendamos agregar colaboradores al proyecto de Cloud del 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 debe 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 detalles.
Consulta la Guía de estilo del complemento de Google Workspace si deseas conocer los lineamientos para diseñar la experiencia del usuario del complemento.
Cómo configurar el manifiesto del proyecto complementario
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 complementos de Google Workspace, 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 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 requeridos 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 el formato JSON 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 ajeno a Google con OAuth, también debes configurar OAuth para ese servicio.
Creación de tarjetas
Para definir una interfaz de usuario de complemento, debes crear objetos Card y llenarlos con widgets. Las funciones del activador especificadas en tu manifiesto deben mostrar un solo objeto Card o un arreglo 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 mediante 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 complementos. Los widgets de interacción, por lo general, están vinculados 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, 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 tus complementos de Google Workspace necesitan acceso a API que no sean de Google y que requieran OAuth, debes configurarlo y conectarte a ese servicio. Consulta la guía de conexión a servicios que no son de Google para obtener más detalles.
Orden de construcción
Cuando crees una tarjeta, deberás realizar la compilación desde arriba. Es decir, debes usar esta orden de construcción:
- Compila el widget.
- Agrega el widget a la sección de tarjetas.
- Repite este paso hasta que la sección de tarjetas contenga todos sus widgets.
- Agrega la sección de la tarjeta 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. Los cambios que realices en el objeto de widget después de agregarlo no se reflejarán en la tarjeta final.
Acciones universales
Puedes usar las acciones universales para proporcionar una funcionalidad independiente del contexto. Las acciones universales son elementos del menú disponibles en la IU del complemento, sin importar la tarjeta que se muestre en ese momento. Todas las acciones universales definidas siempre aparecen en el menú de tarjetas 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 del usuario. Se recomienda que los complementos solo tengan alcances para las acciones que deben tener en orden y nada más.
En proyectos de complementos, configura explícitamente los alcances del complemento para garantizar que el complemento use el conjunto de permisos menos permisivo posible. Defines los alcances que usa tu complemento en el manifiesto del complemento.
Consulta Alcances para obtener más detalles.
Pruebe 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 en los contextos y las acciones del usuario.
Consulta Prueba los complementos de Google Workspace para obtener más información.
Publica el complemento
La publicación de tu complemento hace que esté disponible para otros, ya sea de forma pública o solo para 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 públicamente deben completar la revisión de la app antes de publicarse.
Consulta Publica el complemento de Google Workspace para obtener más detalles.
Ejemplo de complemento de Google Workspace
Para ayudarte a comprender cómo se crean los complementos de Google Workspace, la guía de inicio rápido sobre complementos de Google Workspace "Gatos" demuestra cómo compilar un complemento simple de Google Workspace, incluidas las páginas principales, la navegación con 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.