Si quieres crear un nuevo complemento de Google Workspace, sigue esta información general procedimiento:
- 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 del complemento o recurso de implementación.
- Escribe código para definir la apariencia del complemento y el comportamiento de los usuarios.
- Verifica los permisos de OAuth de tu complemento.
- Prueba el complemento en la aplicaciones de host se 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 creas tu complemento en un lenguaje que no sea Apps Script, solo necesitas crear un proyecto de Google Cloud.
Antes de comenzar a desarrollar un complemento, elige un solo de usuario como propietaria de los proyectos y decidir qué otras cuentas se y colaboradores. El propietario de los proyectos crea y administra los archivos del proyecto. y los parámetros de configuración asociados, mientras que los colaboradores pueden ayudar con la programación y las pruebas.
Proyectos de Apps Script
Puedes compilar la secuencia de comandos de Apps Script de tu complemento los archivos del proyecto en un entorno compartido en Drive para que ningún cuenta individual tiene la propiedad exclusiva. Coloca tu complemento de secuencia de comandos en una unidad compartida garantiza que múltiples colaboradores tengan acceso a el proyecto de secuencia de comandos.
Cuando publicas un complemento, actúa una sola cuenta de usuario como publicador. La cuenta de publicación debe tener acceso de edición a la secuencia de comandos el proyecto, 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 complementos proyecto de Google Cloud. Esto ayuda a garantizar que alguien de tu equipo siempre pueda acceder en 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 qué aspecto quieres que tenga el complemento y cómo de que debe comportarse antes de comenzar a crearlo. Considera en qué casos de uso el complemento debe intentar brindar soluciones. Inicio con un diseño sencillo para comenzar a trabajar primero y, luego, agregar más mejoras.
Consulta la guía de estilo de los complementos de Google Workspace. para obtener pautas sobre cómo diseñar el complemento una experiencia fluida a los desarrolladores.
Configura el manifiesto del proyecto de complemento
En los proyectos de Apps Script, el manifiesto del proyecto es un JSON especial . Especifica una variedad de detalles sobre el proyecto, como su biblioteca dependencias. Para los complementos de Google Workspace, el manifiesto también proporciona la información información que la aplicación host necesita para mostrar el complemento correcto.
Consulta Manifiestos para obtener detalles sobre cómo configurar tu del complemento en Apps Script.
A medida que agregue código y funciones a su complemento, edite la manifiesto según sea necesario para producir el complemento requerido la apariencia y el comportamiento.
Codifica el complemento
Debes implementar una interfaz basada en tarjetas para el complemento. Usa Apps Script Servicio de tarjeta o, si escribes en otro lenguaje de código, devuelve JSON con el formato correcto para que la interfaz se renderice como tarjetas.
También debes implementar cualquier activador funciones especificadas en el manifiesto del complemento. Si el El complemento se conecta a un servicio de terceros que no es de Google con OAuth, debes configurar el OAuth para ese servicio.
Construir tarjetas
Para definir una interfaz de usuario de complemento, crea
objetos Card y los rellena con
widgets. Activa funciones especificadas en
tu manifiesto debe devolver un solo
Card o un array de
Objetos Card que representan
diferentes “páginas” de la interfaz del complemento. Tu
el complemento también puede crear y mostrar tarjetas nuevas en
respuesta a las acciones del usuario.
En Apps Script, puedes crear tarjetas con el
CardBuilder. Cada
la tarjeta requiere un CardHeader
y una o más
CardSections Deberías
Rellena cada sección de la tarjeta con los widgets individuales que conforman la sección.
del complemento. Interacción
widgets, son
normalmente se vinculan a acciones para definir
su comportamiento de interacción.
Luego de agregar todas las secciones y widgets a la tarjeta a través de sus
CardBuilder, debes llamar
CardBuilder.build()
para crear el objeto Card correspondiente.
Puedes usar otras Apps Script integradas
servicios como
CalendarApp para recuperar
información para mostrar en las tarjetas de complementos que crees.
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, puedes debe configurar y conectarse a ese servicio; consulta la sección Conexión a Guía de servicios ajenos a Google para 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, agrega una copia de ese widget. Los cambios que realices en el widget después de agregarlo no se reflejan en la última tarjeta.
Acciones universales
Puedes usar acciones universales para brindar una funcionalidad independiente del contexto. Las acciones universales son elementos del menú disponible en la IU del complemento, independientemente de la tarjeta que se muestra. Todas las acciones universales definidas aparecen siempre en el menú de tarjetas del complemento.
Consulta las Acciones universales para obtener más información. más detalles.
Verifica los permisos de OAuth del complemento
Los alcances definen las acciones que el complemento puede tomar en nombre de un usuario. Es un práctica recomendada para que los complementos solo tengan alcances para las acciones que debe tener una función en orden y nada más.
En proyectos de complementos, establece explícitamente el complemento los permisos para garantizar el complemento usa el conjunto de alcances menos permisivo como sea posible. Tú defines qué alcances usa tu complemento el complemento manifiesto.
Consulta Alcances para obtener más detalles.
Prueba el complemento
Para probar los complementos no publicados, primero instala el sin publicar complemento. Una vez que se instale y autorice, puedes usar el complemento. en su cuenta y probar su apariencia y comportamiento en las aplicaciones host que se extiende. Debes verificar que el complemento se comporte de la siguiente manera: y lo que se espera de los contextos y las acciones de los usuarios.
Consulta Prueba los complementos de Google Workspace para obtener más detalles.
Publica el complemento
Si publicas tu complemento, estará disponible para otros usuarios. de forma pública o solo para los usuarios de tu dominio. Antes de comenzar la 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 completarla.
Los complementos de Google Workspace se publican en Google Workspace Marketplace. Disponible de manera pública los complementos deben completar la revisión de la app antes del cuando se publiquen.
Consulta Cómo publicar complementos de Google Workspace para más detalles.