Creare le interfacce di Google Calendar

I componenti aggiuntivi di Google Workspace possono offrire interfacce personalizzate quando l'utente visualizza o modifica calendari ed eventi. In questo modo puoi fornire all'utente ulteriori informazioni pertinenti, automatizzare le attività e collegare sistemi di terze parti a Google Calendar.

Quando crei un'interfaccia di componente aggiuntivo per Google Calendar, puoi fornire una home page. Puoi utilizzare la stessa home page per più host o progettarne uno specifico per Google Calendar.

Il componente aggiuntivo può anche definire un'interfaccia che viene visualizzata quando l'utente ha aperto un evento di Calendar.

Accesso all'interfaccia utente del componente aggiuntivo

A seconda di come viene aperto, un componente aggiuntivo di Google Workspace può definire l'interfaccia della home page, un'interfaccia degli eventi di Google Calendar, un'interfaccia di selezione degli allegati o tutti e tre:

  • Se un utente fa clic sull'icona del componente aggiuntivo in visualizzazione del calendario, il componente aggiuntivo esegue la funzione calendar.homepageTrigger corrispondente (se presente). Questa funzione crea e restituisce una scheda della home page in Calendar per la visualizzazione. Se non viene definita alcuna funzione calendar.homepageTrigger, viene visualizzata una scheda generica della home page.
  • Se l'utente apre un evento di Calendar e poi fa clic sull'icona del componente aggiuntivo, o se il componente aggiuntivo è aperto quando l'utente apre un evento, il componente aggiuntivo esegue la funzione eventOpenTrigger corrispondente (se presente). La funzione crea l'interfaccia degli eventi Calendar del componente aggiuntivo e torna a Google Calendar per la visualizzazione.
  • Se il componente aggiuntivo definisce una funzione eventAttachmentTrigger, viene visualizzato come fornitore di allegati quando l'utente fa clic su Aggiungi allegato durante la modifica di un evento di Calendar. Quando il componente aggiuntivo è selezionato, la funzione eventAttachmentTrigger crea l'interfaccia di selezione degli allegati del componente aggiuntivo e la restituisce a Google Calendar per la visualizzazione.

Creazione dell'interfaccia del componente aggiuntivo di Calendar

Per estendere Google Calendar con un componente aggiuntivo di Google Workspace, segui questi passaggi:

  1. Decidi se vuoi che il tuo componente aggiuntivo abbia una home page specifica di Calendar. Decidi inoltre se vuoi fornire un'interfaccia personalizzata mentre l'utente modifica gli eventi di Calendar.
  2. Aggiungi i campi addOns.common e addOns.calendar appropriati al manifest del progetto di script del componente aggiuntivo, inclusi eventuali ambiti richiesti.
  3. Se fornisci una home page specifica per Calendar, implementa la funzione calendar.homepageTrigger per creare questa interfaccia. Puoi anche scegliere di utilizzare l'interfaccia common.homepageTrigger per più host Google Workspace.
  4. Se fornisci un'interfaccia di eventi di Calendar, devi implementare una funzione calendar.eventOpenTrigger per creare l'interfaccia. Per maggiori dettagli, vedi Estensione degli eventi di Calendar.
  5. Implementare le funzioni di callback associate necessarie per rispondere alle interazioni dell'utente nell'interfaccia utente, ad esempio i clic sui pulsanti.

Home page del calendario

Google Calendar supporta la visualizzazione delle home page del componente aggiuntivo di Google Workspace. Per visualizzare la home page comune del componente aggiuntivo in Google Calendar, assicurati semplicemente che nel file manifest del componente aggiuntivo sia presente un campo addOns.calendar.

In alternativa, aggiungi un elemento calendar.homepageTrigger al file manifest del componente aggiuntivo per fornire una home page specifica di Calendar.

In entrambi i casi, devi specificare il nome di una funzione trigger della home page nel progetto di script del componente aggiuntivo. Questa funzione viene chiamata automaticamente per creare la home page di Google Calendar. Devi implementare questa funzione per creare e restituire un singolo Card o un array di oggetti Card che compongono la home page. Alla funzione trigger della home page viene passato un oggetto evento come parametro contenente alcune informazioni generali, come la piattaforma del client. Puoi utilizzare i dati dell'oggetto evento per personalizzare la costruzione della home page.

Estensione dell'interfaccia degli eventi di Calendar

Google Calendar si basa su un trigger contestuale per determinare quale interfaccia (se presente) visualizzare quando l'utente modifica un evento di Calendar. Quando il trigger si attiva, esegue la funzione di trigger contestuale specificata dal campo calendar.eventOpenTrigger nel manifest del componente aggiuntivo.

Devi implementare la funzione denominata nel campo calendar.eventOpenTrigger. Questa funzione accetta un oggetto evento come argomento e deve restituire un singolo oggetto Card o un array di oggetti Card da mostrare a Calendar mentre l'utente ha l'evento aperto.

Oggetti evento

Un oggetto evento viene creato e passato alla funzione di attivazione contestuale calendar.eventOpenTrigger quando un utente apre un evento di Calendar. La funzione trigger può utilizzare le informazioni in questo oggetto evento per determinare come costruire le schede dei componenti aggiuntivi o controllare il comportamento dei componenti aggiuntivi. Inoltre, gli oggetti evento vengono creati e trasmessi alle funzioni homepageTrigger alla prima apertura di un componente aggiuntivo e quando l'utente fa clic o seleziona widget interattivi.

La struttura completa degli oggetti evento è descritta in Oggetti evento. Se Calendar è l'app ospitante del componente aggiuntivo, gli oggetti trigger contestuale e evento di interazione con i widget includono il campo Oggetto evento Calendar che contiene le informazioni sul client specifiche di Calendar.

Aggiornamento degli eventi di Calendar

Oltre alla finestra calendar.eventOpenTrigger contestuale che si attiva quando un utente apre un evento di Calendar per la modifica, puoi anche definire un calendar.eventUpdateTrigger che si attiva quando l'utente aggiorna e salva un evento di Calendar. Questo attivatore si attiva solo se l'utente apporta una o più delle seguenti modifiche:

  • Aggiunge uno o più partecipanti.
  • Rimuove uno o più partecipanti.
  • Aggiunge o passa a un'altra soluzione per conferenze.

Quando si attiva, questo attivatore esegue la funzione attivatore specificata dal campo manifest calendar.eventUpdateTrigger. La funzione viene eseguita prima del salvataggio della modifica dell'evento di Calendar.

In genere, calendar.eventUpdateTrigger viene utilizzato per eseguire una o più delle seguenti operazioni:

  • Aggiornare l'interfaccia degli eventi di Calendar del componente aggiuntivo in risposta alle modifiche dell'utente all'evento di Calendar.
  • Sincronizzare i dati sugli eventi di Calendar con un sistema di terze parti, ad esempio un sistema di conferenza collegato a Google Calendar.

Se hai bisogno che il componente aggiuntivo possa apportare modifiche ai dati di un evento di Calendar (ad esempio l'elenco dei partecipanti), devi impostare il campo manifest calendar.currentEventAccess del componente aggiuntivo su WRITE o READ_WRITE. Inoltre, il componente aggiuntivo deve avere l'https://www.googleapis.com/auth/calendar.addons.current.event.write ambito.

Aggiunta di soluzioni per conferenze

Le soluzioni di conferenza rappresentano opzioni di conferenza di terze parti che gli utenti possono allegare agli eventi di Google Calendar. La documentazione sulla panoramica delle conferenze di terze parti fornisce dettagli su come creare un componente aggiuntivo che aggiunga nuove soluzioni per conferenze. Non è necessario creare una UI per questo tipo di estensione; le soluzioni aggiunte vengono semplicemente visualizzate come opzioni nel menu a discesa della UI degli eventi di Google Calendar.