Los complementos de Google Workspace pueden proporcionar interfaces personalizadas cuando el usuario ve o edita calendarios y eventos de Calendario. Esto te permite proporcionarle al usuario información adicional relevante, automatizar tareas y conectar sistemas de terceros a Calendario de Google.
Cuando creas una interfaz de complemento para Calendario de Google, puedes proporcionar una página principal. Puedes usar la misma página principal para varios hosts o diseñar una específica para Calendario de Google.
Tu complemento también puede definir una interfaz que aparece cuando el usuario tiene abierto un evento de Calendario.
Cómo acceder a la IU del complemento
Según cómo se abra, un complemento de Google Workspace puede definir una interfaz de página principal, una interfaz de eventos de Calendario de Google, una interfaz de selección de archivos adjuntos o las tres opciones:
- Si un usuario hace clic en el ícono de complemento mientras se encuentra en una vista de calendario, el complemento ejecuta la función
calendar.homepageTriggercorrespondiente (si está presente). Esta función crea y muestra una tarjeta de la página principal en Calendario para su visualización. Si no se define ninguna funcióncalendar.homepageTrigger, se mostrará una tarjeta genérica de la página principal. - Si el usuario abre un evento de Calendario y, luego, hace clic en el ícono de complemento, o el complemento se abre cuando el usuario abre un evento, el complemento ejecuta la función
eventOpenTriggercorrespondiente (si está presente). Esta función compila la interfaz de eventos del complemento de Calendario y regresa a Calendario de Google para mostrarla. - Si el complemento define una función
eventAttachmentTrigger, aparece como proveedor de archivos adjuntos cuando el usuario hace clic en Agregar archivo adjunto mientras edita un evento de Calendario. Cuando se selecciona el complemento, la funcióneventAttachmentTriggercompila la interfaz de selección de archivos adjuntos del complemento y la muestra en Calendario de Google para mostrarla.
Compila la interfaz de Calendario complementaria
Puedes extender Calendario de Google con un complemento de Google Workspace si sigues estos pasos:
- Decide si quieres que tu complemento tenga una página principal específica de Calendario. También debes decidir si quieres proporcionar una interfaz personalizada mientras el usuario está editando los eventos del Calendario.
- Agrega los campos
addOns.commonyaddOns.calendaradecuados al manifiesto del proyecto de secuencia de comandos del complemento, incluidos los alcances necesarios. - Si proporcionas una página principal específica de Calendario, implementa la función
calendar.homepageTriggerpara compilar esta interfaz. También puedes usar la interfazcommon.homepageTriggerpara varios hosts de Google Workspace. - Si proporcionas una interfaz de evento de Calendario, debes implementar una función
calendar.eventOpenTriggerpara compilar esta interfaz. Consulta Extender la interfaz del evento de Calendario para obtener más detalles. - Implementa las funciones de devolución de llamada asociadas necesarias para responder a las interacciones de la IU del usuario, como los clics en los botones.
Páginas principales de Calendario
Calendario de Google permite mostrar las páginas principales del complemento de Google Workspace.
Para mostrar la página principal común de tu complemento en Calendario de Google, asegúrate de que haya un campo addOns.calendar en el manifiesto del complemento.
Como alternativa, puedes agregar un calendar.homepageTrigger al manifiesto del complemento a fin de proporcionar una página principal específica para Calendario.
En cualquier caso, debes proporcionar el nombre de la función de activación de la página principal en el proyecto de secuencia de comandos del complemento. Esta función se llama automáticamente para crear la página principal de Calendario de Google cuando es necesario. Debes implementar esta función para compilar y mostrar un solo Card o un arreglo de objetos Card que conformen la página principal. La función de activador de la página principal recibe un objeto de evento como un parámetro que contiene información general, como la plataforma del cliente. Puedes usar los datos del objeto de evento para personalizar la construcción de la página principal.
Cómo extender la interfaz del evento de Calendario
El Calendario de Google se basa en un activador contextual para determinar qué interfaz (si hay) mostrar cuando el usuario edita un evento de Calendario. Cuando el activador se activa, ejecuta la función de activador contextual especificada por el campo calendar.eventOpenTrigger en el manifiesto del complemento.
Debes implementar la función nombrada en el campo calendar.eventOpenTrigger. Esta función acepta un objeto de evento como argumento y debe mostrar un solo objeto Card o un array de objetos Card para que se muestre en Calendario mientras el usuario tiene el evento abierto.
Objetos de eventos
Se crea un objeto de evento y se pasa a la función de activador contextual de calendar.eventOpenTrigger cuando un usuario abre un evento de Calendario. La función de activación puede usar la información de este objeto de evento para determinar cómo construir tarjetas de complementos o controlar su comportamiento. Los objetos de eventos también se crean y se pasan a funciones homepageTrigger cuando se abre un complemento por primera vez y cuando el usuario hace clic o selecciona widgets interactivos.
La estructura completa de los objetos de evento se describe en Objetos de evento. Cuando Calendario es la app anfitriona que actúa del complemento, el activador contextual y los objetos de evento de interacción del widget incluyen el campo Objeto de evento de Calendario que lleva la información de cliente específica de Calendario.
Actualización de eventos del Calendario
Además del calendar.eventOpenTrigger contextual que se activa cuando un usuario abre un evento de Calendario para editarlo, también puedes definir un calendar.eventUpdateTrigger que se active cuando el usuario actualice y guarde un evento de Calendario. Este activador solo se activa si el usuario realiza una o más de las siguientes ediciones:
- Agrega uno o más asistentes.
- Quita uno o más asistentes.
- Agrega una solución de conferencia o la cambia a otra.
Cuando este activador se activa, ejecuta la función de activación especificada en el campo de manifiesto calendar.eventUpdateTrigger. La función se ejecuta antes de que se guarde la edición del evento de Calendario.
Por lo general, calendar.eventUpdateTrigger se usa para realizar una o más de las siguientes acciones:
- Actualiza la interfaz de eventos del complemento de Calendario en respuesta a los cambios del usuario en el evento de Calendario.
- Sincronizar los datos del evento de Calendario con un sistema de terceros, como un sistema de conferencias conectado a Calendario de Google
Si necesitas que tu complemento realice ajustes en los datos de un evento de Calendario (como su lista de asistentes), debes configurar el campo de manifiesto del complemento calendar.currentEventAccess en WRITE o READ_WRITE. Esto también requiere que el complemento tenga el alcance https://www.googleapis.com/auth/calendar.addons.current.event.write.
Agregar soluciones para conferencias
Las soluciones para conferencias representan una opción de conferencia de terceros que los usuarios pueden adjuntar a los eventos de Calendario de Google. En la documentación Descripción general de las conferencias de terceros, se proporciona información sobre cómo compilar un complemento que agregue soluciones de conferencia nuevas. No es necesario compilar una IU para este tipo de extensión; las soluciones agregadas simplemente aparecen como opciones en el menú desplegable de la IU del evento de Calendario de Google.