Compila interfaces de Calendario de Google

Los complementos de Google Workspace pueden proporcionar interfaces personalizadas cuando el usuario visualiza o edita calendarios y eventos de Calendario. Esto te permite proporcionarle al usuario información relevante adicional, automatizar tareas y conectar sistemas de terceros al Calendario de Google.

Cuando compilas una interfaz de complemento para el 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 el Calendario de Google.

El 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 evento de Calendario de Google, una interfaz de selección de archivos adjuntos o las tres opciones:

  • Si un usuario hace clic en el ícono del complemento mientras está en una vista de calendario, el complemento ejecuta la función calendar.homepageTrigger correspondiente (si está presente). Esta función crea y muestra una tarjeta de página principal en el Calendario para mostrarla. Si no se define ninguna función calendar.homepageTrigger, se muestra una tarjeta genérica de la página principal en su lugar.
  • Si el usuario abre un evento de Calendario y hace clic en el ícono del complemento, o cuando el complemento está abierto cuando el usuario abre un evento, el complemento ejecuta la función eventOpenTrigger correspondiente (si está presente). Esta función compila la interfaz de eventos de Calendario del complemento y regresa al Calendario de Google para mostrarse.
  • Si el complemento define una función eventAttachmentTrigger, aparecerá como proveedor de archivos adjuntos cuando el usuario haga clic en Agregar archivo adjunto mientras edita un evento de Calendario. Cuando se selecciona el complemento, la función eventAttachmentTrigger compila la interfaz de selección de archivos adjuntos del complemento y la muestra en el Calendario de Google.

Cómo compilar la interfaz complementaria de Calendario

Para extender el Calendario de Google con un complemento de Google Workspace, sigue estos pasos:

  1. Decide si quieres que tu complemento tenga una página principal específica del Calendario. También decide si quieres proporcionar una interfaz personalizada mientras el usuario edita eventos de Calendario.
  2. Agrega los campos addOns.common y addOns.calendar correspondientes al manifiesto del proyecto de secuencia de comandos del complemento, incluidos los alcances necesarios.
  3. Si proporcionas una página principal específica de Calendario, implementa la función calendar.homepageTrigger para compilar esta interfaz. También puedes optar por usar la interfaz common.homepageTrigger para varios hosts de Google Workspace.
  4. Si proporcionas una interfaz de eventos de Calendario, debes implementar una función calendar.eventOpenTrigger para compilar esta interfaz. Consulta Cómo extender la interfaz de eventos de Calendario para obtener más detalles.
  5. Implementa las funciones de devolución de llamada asociadas necesarias para responder a las interacciones del usuario en la IU, como los clics en un botón.

Páginas principales del calendario

El Calendario de Google admite que se muestren las páginas principales del complemento de Google Workspace. Para mostrar la página principal común de tu complemento en el Calendario de Google, asegúrate de que haya un campo addOns.calendar en el manifiesto del complemento.

Como alternativa, agrega un calendar.homepageTrigger al manifiesto del complemento para proporcionar una página principal específica de Calendario.

En cualquier caso, debes proporcionar el nombre de una función de activación de la página principal en el proyecto de secuencia de comandos de tu complemento. Esta función se llama automáticamente para crear la página principal del Calendario de Google cuando es necesario. Debes implementar esta función para compilar y mostrar un solo objeto Card o un array de objetos Card que conforman la página principal. La función de activación 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 adaptar la construcción de la página principal.

Ampliación de la interfaz de eventos de Calendario

El Calendario de Google se basa en un activador contextual para determinar qué interfaz (si corresponde) mostrar cuando el usuario edita un evento del Calendario. Cuando el activador se activa, ejecuta la función de activación 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 el Calendario muestre el evento mientras el usuario tiene abierto el evento.

Objetos de evento

Se crea un objeto de evento y se pasa a la función de activador contextual calendar.eventOpenTrigger cuando un usuario abre un evento de Calendario. La función del activador puede usar la información de este objeto de evento para determinar cómo crear tarjetas o controlar el comportamiento del complemento. Los objetos de evento también se crean y pasan a funciones homepageTrigger cuando se abre un complemento por primera vez y cuando el usuario hace clic en widgets interactivos o los selecciona.

La estructura completa de los objetos de evento se describe en Objetos de evento. Cuando Calendario es la app host que actúa en el complemento, los objetos de evento de interacción con el widget y el activador contextual incluyen el campo Objeto de evento de Calendario que contiene información de cliente específica del Calendario.

Actualizando eventos del Calendario

Además de la calendar.eventOpenTrigger contextual que se activa cuando un usuario abre un evento de Calendario para editarlo, también puedes definir una 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 o cambia a una solución de reuniones diferente.

Cuando este activador se activa, ejecuta la función de activación especificada por 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:

  • Actualizar la interfaz de eventos de Calendario del complemento en respuesta a los cambios que realicen los usuarios en el evento de Calendario
  • Sincroniza los datos de eventos de Calendario con un sistema de terceros, como un sistema de conferencias que esté conectado al Calendario de Google.

Si necesitas que tu complemento realice ajustes en los datos de un evento de Calendario (como la lista de asistentes), debes establecer el campo del manifiesto calendar.currentEventAccess del complemento 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 de conferencia representan opciones de conferencia de terceros que los usuarios pueden adjuntar a los eventos de Calendario de Google. En la documentación Descripción general de conferencias de terceros, se proporcionan detalles sobre cómo compilar un complemento que agrega soluciones de conferencias 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 del Calendario de Google.