En esta página, se proporciona una descripción general sobre cómo diseñar, compilar y publicar complementos de Google Workspace. En esta descripción general, se explican los siguientes pasos:
- Determina las aplicaciones de Google Workspace en las que deseas que el complemento esté disponible para los usuarios.
- Configura los proyectos de tu complemento y elige un propietario y colaboradores.
- Diseña el comportamiento y la apariencia de tu complemento.
- Configura el manifiesto del proyecto o el recurso de implementación del complemento.
- Escribir código para definir la apariencia y el comportamiento del complemento
- Verifica los permisos de OAuth de tu complemento.
- Prueba el complemento en una o más aplicaciones de Google Workspace.
- Publica el complemento.
Elige las aplicaciones de host de Google Workspace
Puedes configurar los complementos de Google Workspace para que aparezcan en las siguientes aplicaciones de host de Google Workspace:
- Gmail
- Calendario de Google
- Documentos de Google
- Google Drive
- Hojas de cálculo de Google
- Presentaciones de Google
Para obtener información sobre cómo compilar para aplicaciones de Google Workspace, consulta Cómo extender la IU de Google Workspace.
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 uno 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 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 un unidad compartida para 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 es necesario que sea el propietario.
Para crear un proyecto de Apps Script, consulta Proyectos de secuencias de comandos.
Proyectos de Google Cloud
Te recomendamos que agregues colaboradores al proyecto de Cloud del complemento. Esto ayuda a garantizar que alguien de tu equipo siempre pueda acceder a la configuración en la nube 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 debería comportarse antes de comenzar a compilarlo. Considera para qué casos de uso el complemento debería intentar ofrecer 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 con el 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 bibliotecas. 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 correctamente.
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 generar el comportamiento y la apariencia requeridos.
Programa 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 lo 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 externo que no es de Google con OAuth, también debes configurar OAuth para ese servicio.
Cómo crear tarjetas
Para definir una interfaz de usuario de complementos, crea objetos Card y complétalos con widgets. Las funciones de activación 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 completar cada sección de la tarjeta con los widgets individuales que conforman la interfaz del complemento. Los widgets de interacción suelen vincularse 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 datos recuperados de servicios que no son de Google.
Si tu complemento necesita acceso a APIs que no son de Google y que requieren OAuth, debes configurar y conectarte a ese servicio. Consulta la guía para conectarse a servicios que no son de Google para obtener más información.
Orden de construcción
Cuando crees una tarjeta, debes hacerlo de arriba abajo. 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. 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 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 alcances definen qué acciones puede realizar el complemento en nombre de un usuario. Es una práctica recomendada que los complementos solo tengan permisos para las acciones que deben tener para funcionar y nada más.
En los proyectos de complementos, configura de forma explícita los permisos del complemento para asegurarte de que use el conjunto de permisos menos permisivo posible. Tú defines qué alcances usa tu complemento en el manifest del complemento.
Consulta Alcances para obtener más información.
Prueba el complemento
Para probar 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 de Google Workspace para obtener más detalles.
Publica el complemento
Si publicas tu complemento, estará disponible para otras personas, bien 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 Cómo publicar un complemento de Google Workspace para obtener más detalles.