En esta página, se proporciona una descripción general para 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 quieres que tu complemento esté disponible para los usuarios.
- Configura los proyectos de tu complemento y elige un propietario y colaboradores.
- Diseña y configura la apariencia y el comportamiento de tu complemento.
- Compila el complemento.
- Verifica los permisos de OAuth del complemento.
- Prueba el complemento en una o más aplicaciones de Google Workspace.
- Publica el complemento.
Puedes crear un complemento con Apps Script o HTTP. Para obtener una comparación, mira el video "Apps Script vs. HTTP endpoints: Which should you choose?" (Comparación entre Apps Script y los extremos HTTP: ¿Cuál deberías elegir?). 🤔".
Elige aplicaciones host de Google Workspace
Puedes configurar los complementos de Google Workspace para que aparezcan en las siguientes aplicaciones host de Google Workspace:
- Gmail
- Calendario de Google
- Google Chat
- Documentos de Google
- Google Drive
- Google Meet
- Hojas de cálculo de Google
- Presentaciones de Google
Para obtener información sobre cómo compilar aplicaciones de Google Workspace, consulta Extiende la IU de Google Workspace.
Configura los proyectos de tu complemento y elige un propietario y colaboradores
Si compilas tu complemento en Apps Script, crearás 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 del complemento, elige una sola cuenta de usuario para ser propietario de los proyectos y decide qué otras cuentas serán 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
Antes de compilar tu complemento, revisa las cuotas y limitaciones de Apps Script para asegurarte de que el diseño de tu proyecto se alinee con estos lineamientos. Apps Script es ideal para el desarrollo ligero de complementos personales o internos con una pequeña base de usuarios. Si prevés crear un complemento a gran escala que necesite controlar a muchos usuarios, requiera una latencia baja o exija un control total sobre tu infraestructura, considera desarrollar en un entorno de tiempo de ejecución diferente.
Puedes compilar los archivos del 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 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 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 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 de Cloud del complemento.
Para crear un proyecto de Google Cloud, consulta Crea un proyecto de Google Cloud.
Diseña y configura la apariencia y el comportamiento de tu complemento
Antes de comenzar a crear tu complemento, decide cómo quieres que se vea y cómo debe comportarse. Considera para qué casos de uso el complemento debería intentar proporcionar soluciones. Comienza con un diseño simple para que funcione primero y, luego, agrega más detalles.
Consulta la guía de estilo de los complementos de Google Workspace para obtener instrucciones sobre cómo diseñar la experiencia del usuario de tu complemento.
Configura el manifiesto del complemento
Después de diseñar tu complemento, puedes comenzar a implementar el diseño en el manifiesto del complemento. En el manifiesto, se configura la mayor parte de la apariencia y el comportamiento del complemento, incluidas las aplicaciones host de Google Workspace que extiende el complemento.
Para obtener más información, consulta Manifiestos para complementos de Google Workspace.
A medida que agregas código y funciones a tu complemento, edita el manifiesto según sea necesario para producir la apariencia y el comportamiento requeridos del complemento.
Configura la apariencia y el comportamiento de la app de Google Chat
Si diseñaste un complemento que extiende Google Chat, debes usar la API de Google Chat para configurar la apariencia y el comportamiento de una app de Chat. Para conocer los pasos, consulta Cómo configurar una app de Google Chat.
Compila 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 programación, devuelve JSON con el formato adecuado para que la interfaz se renderice como tarjetas.
También debes implementar las funciones de activación especificadas en el manifiesto del complemento. Si tu complemento se conecta a un servicio de terceros que no es de Google a través de OAuth, también debes configurar OAuth para ese servicio.
Cartas de estructuras
Para definir la interfaz de usuario de un complemento, crea objetos Card y complétalos con widgets. Las funciones de activación especificadas en el manifiesto deben devolver 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, creas 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 componen 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 la 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 los datos recuperados de servicios que no son de Google.
Si tu complemento necesita acceder 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 detalles.
Orden de construcción
Cuando crees una tarjeta, debes hacerlo de arriba hacia abajo. Es decir, debes usar este orden de construcción:
- Compila el widget.
- Agrega el widget a la sección de la tarjeta.
- Repite el proceso hasta que la sección de la tarjeta tenga 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 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 permisos definen qué acciones puede realizar el complemento en nombre del usuario. Es una práctica recomendada que los complementos solo tengan permisos para las acciones que deben realizar para funcionar y nada más.
En los proyectos de complementos, establece de forma explícita los alcances del complemento para garantizar que el complemento use el conjunto de alcances menos permisivo posible. En el manifiesto del complemento, defines los permisos que usa tu complemento.
Consulta Alcances para obtener más detalles.
Prueba el complemento
Para probar complementos no publicados, primero debes instalar el complemento no publicado. Una vez que lo instales y autorices, podrás 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.
Para comenzar a probar tu complemento, consulta las siguientes guías:
- Prueba y depura complementos de Google Workspace de Apps Script
- Prueba y depura complementos de Google Workspace HTTP
- Prueba funciones interactivas para las apps de Google Chat
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 públicamente deben completar la revisión de la app antes de publicarse.
Consulta Publica un complemento de Google Workspace para obtener más detalles.