Si quieres 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.
- Configurar el manifiesto del proyecto o el recurso de implementación del complemento
- Escribe 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 extiende.
- Publica el complemento.
Configurar los proyectos de tu complemento y elegir 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 tu complemento en un lenguaje que no sea Apps Script, solo tendrás que crear un proyecto de Google Cloud.
Antes de comenzar a desarrollar complementos, elige una sola cuenta de usuario como propietario de los proyectos y decide 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 programación y las pruebas.
Proyectos de Apps Script
Puedes compilar los archivos del proyecto de Apps Script de tu complemento en una unidad compartida de modo que ninguna cuenta tenga la propiedad exclusiva. Ubicar tu 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 el publicador. La cuenta de publicación debe tener acceso de edición al proyecto de secuencia de comandos, pero no necesita ser 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 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 la apariencia y el comportamiento de tu complemento
Decide cómo quieres que se vea tu complemento y cómo debe comportarse antes de comenzar a crearlo. Considera para qué casos de uso el complemento debería intentar ofrecer soluciones. Comienza con un diseño simple para comenzar a trabajar primero y, luego, agrégale más ajustes.
Consulta la guía de estilo del complemento de Google Workspace para obtener lineamientos sobre cómo diseñar la experiencia del usuario con el complemento.
Configura el manifiesto del proyecto de 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 las 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 necesarios del complemento.
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 lenguaje de código, muestra el formato JSON con el formato correcto para que la interfaz se renderice como tarjetas.
También debes implementar las funciones de activador especificadas en el manifiesto del complemento. Si tu complemento se conecta a un servicio de terceros ajeno a Google mediante OAuth, también debes configurar OAuth para ese servicio.
Construir tarjetas
Para definir una interfaz de usuario de complemento, crea objetos Card y llénalos de 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 la tarjeta 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 que se mostrará en las tarjetas complementarias que compiles.
Puedes usar los 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 para conectarse a servicios que no son de Google para obtener más detalles.
Pedido de construcción
Cuando creas una tarjeta, debes hacerlo desde arriba. Es decir, debes usar este orden de construcción:
- Compila el widget.
- Agrega el widget a la sección de tarjetas.
- Repite el proceso hasta que la sección de la tarjeta tenga todos los widgets.
- Agrega la sección de la tarjeta.
Esto es necesario porque cuando agregas un widget a una tarjeta o sección de tarjetas, en realidad estás agregando una copia de ese widget. Cualquier cambio que realices en el objeto 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, independientemente de la tarjeta que se muestre. Todas las acciones universales definidas aparecen siempre en el menú de tarjetas del complemento.
Consulta Acciones universales para obtener más detalles.
Verifica los permisos de OAuth del complemento
Los permisos 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 según la función de orden, y nada más.
En los proyectos de complementos, configura de forma explícita los alcances del complemento para asegurarte de que el complemento use el conjunto de alcances menos permisivo posible. Tú defines qué alcances 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 instala 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 según lo esperado para los contextos y las acciones del usuario.
Consulta Prueba los complementos de Google Workspace para obtener más detalles.
Publica el complemento
Si publicas tu complemento, estará disponible para otros usuarios, 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 públicamente deben completar la revisión de la app antes de publicarse.
Consulta Publicación de complementos de Google Workspace para obtener más detalles.