I componenti aggiuntivi di Google Workspace possono fornire interfacce personalizzate quando l'utente visualizza o modifica i calendari e gli eventi di Calendar. In questo modo puoi fornire all'utente informazioni aggiuntive 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 crearne una specifica 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 un'interfaccia della home page, un'interfaccia dell'evento di Google Calendar, un'interfaccia di selezione degli allegati o tutte e tre:
- Se un utente fa clic sull'icona del componente aggiuntivo in visualizzazione del calendario, il componente aggiuntivo esegue la funzione
calendar.homepageTriggercorrispondente (se presente). Questa funzione crea e restituisce una scheda della home page da visualizzare in Calendar. Se non è stata definita alcuna funzionecalendar.homepageTrigger, viene visualizzata una scheda della home page generica. - Se l'utente apre un evento di Calendar e 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 corrispondente
eventOpenTrigger(se presente). Questa funzione crea l'interfaccia dell'evento di 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 funzioneeventAttachmentTriggercrea l'interfaccia di selezione dei componenti aggiuntivi e la restituisce a Google Calendar per la visualizzazione.
Creazione dell'interfaccia del componente aggiuntivo Calendar
Per estendere Google Calendar con un componente aggiuntivo di Google Workspace, segui questi passaggi:
- Decidi se vuoi che il tuo componente aggiuntivo abbia una home page specifica per Calendar. Decidi anche se vuoi fornire un'interfaccia personalizzata mentre l'utente modifica gli eventi di Calendar.
- Aggiungi i campi
addOns.commoneaddOns.calendarappropriati al manifest del progetto dello script del componente aggiuntivo, inclusi gli eventuali scope richiesti. - Se fornisci una home page specifica per Calendar, implementa la funzione
calendar.homepageTriggerper creare questa interfaccia. Puoi anche scegliere di utilizzare l'interfaccia dicommon.homepageTriggerper più host Google Workspace. - Se fornisci un'interfaccia di eventi di Calendar, devi implementare una funzione
calendar.eventOpenTriggerper creare l'interfaccia. Per maggiori dettagli, vedi Estensione degli eventi di Calendar. - Implementare le funzioni di callback associate necessarie per rispondere alle interazioni dell'utente nell'interfaccia utente, ad esempio i clic sui pulsanti.
Home page di Calendar
Google Calendar supporta la visualizzazione delle home page dei componenti aggiuntivi di Google Workspace.
Per mostrare la home page comune del tuo componente aggiuntivo in Google Calendar, assicurati che nel file manifest del componente aggiuntivo sia presente un campo addOns.calendar.
In alternativa, aggiungi un
calendar.homepageTrigger
al file manifest del componente aggiuntivo per fornire una home page specifica per Calendar.
In entrambi i casi, devi fornire il nome di una funzione di attivazione della home page nel progetto dello script del componente aggiuntivo. Questa funzione viene chiamata automaticamente per creare la home page di Google Calendar quando è necessario. Devi implementare questa funzione per creare
e restituire un singolo
Card o un array di
Card
oggetti 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 creazione della home page.
Estensione dell'interfaccia dell'evento di Calendar
Google Calendar si basa su un attivatore contestuale per determinare quale interfaccia mostrare (se presente) quando l'utente modifica un evento di Calendar. Quando l'attivatore viene attivato, viene eseguita la funzione di attivatore 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 visualizzare in Calendar quando l'utente ha aperto l'evento.
Oggetti evento
Quando un utente apre un evento di Calendar, viene creato un oggetto evento e passato alla funzione di trigger contestuale calendar.eventOpenTrigger. La funzione di attivazione può utilizzare le informazioni in questo
oggetto evento per determinare come creare schede aggiuntive o controllare il
comportamento del componente aggiuntivo. Gli oggetti evento vengono inoltre creati e passati alle funzioni homepageTrigger quando un componente aggiuntivo viene aperto per la prima volta e quando l'utente fa clic su o seleziona widget interattivi.
La struttura completa degli oggetti evento è descritta in Oggetti evento. Quando Calendar è l'app host in esecuzione del componente aggiuntivo, gli oggetti evento di attivazione contestuale e di interazione con il widget includono il campo Oggetto evento di Calendar che contiene le informazioni del client specifiche di Calendar.
Aggiornamento degli eventi nel calendario
Oltre all'evento calendar.eventOpenTrigger di tipo contestuale che viene attivato quando un utente apre un evento di Calendar per modificarlo, puoi anche definire un evento calendar.eventUpdateTrigger che viene attivato 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 viene attivato, esegue la funzione di attivazione specificata dal campo manifest calendar.eventUpdateTrigger. La funzione viene eseguita prima che la modifica dell'evento di Calendar venga salvata.
calendar.eventUpdateTrigger
viene in genere utilizzato per eseguire una o più delle seguenti operazioni:
- Aggiornare l'interfaccia degli eventi di Calendar del componente aggiuntivo in risposta alle modifiche degli utenti all'evento di Calendar.
- Sincronizzare i dati degli eventi di Calendar con un sistema di terze parti, ad esempio un sistema di conferenze collegato a Google Calendar.
Se vuoi che il tuo componente aggiuntivo apporti modifiche ai dati di un evento di Calendar (ad esempio l'elenco dei partecipanti), devi impostare il campo manifest del componente aggiuntivo calendar.currentEventAccess 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 un'interfaccia utente per questo tipo di estensione. Le soluzioni aggiunte vengono visualizzate semplicemente come opzioni nel menu a discesa dell'interfaccia utente dell'evento di Google Calendar.