I componenti aggiuntivi di Google Workspace possono fornire interfacce personalizzate quando l'utente visualizza o modifica calendari ed eventi di Calendar. In questo modo puoi fornire all'utente informazioni aggiuntive pertinenti, automatizzare le attività e connettere sistemi di terze parti a Calendar.
Quando crei un'interfaccia del componente aggiuntivo di Google Workspace per Calendar, puoi fornire una home page. Puoi utilizzare la stessa home page per più host o progettarne una specifica per Calendar.
Il componente aggiuntivo può anche definire un'interfaccia che viene visualizzata quando l'utente ha aperto un evento di Calendar.
Accedere all'interfaccia utente del componente aggiuntivo
La tua UI può essere visualizzata in diversi modi a seconda del contesto. Ad esempio, un componente aggiuntivo può definire un'interfaccia della home page, un'interfaccia dell'evento di Calendar, un'interfaccia di selezione degli allegati o tutte e tre:
- Se un utente fa clic sull'icona del componente aggiuntivo mentre si trova in una visualizzazione del calendario, il componente aggiuntivo esegue la funzione
calendar.homepageTriggercorrispondente (se presente). Questa funzione crea e restituisce una scheda della home page a Calendar per la visualizzazione. Se non è definita alcuna funzionecalendar.homepageTrigger, viene visualizzata una scheda della home page generica. - Se l'utente apre un evento di Calendar e poi fa clic sull'icona del componente aggiuntivo oppure se il componente aggiuntivo è aperto quando l'utente apre un evento, il componente aggiuntivo esegue la funzione
eventOpenTriggercorrispondente (se presente). Questa funzione crea l'interfaccia dell'evento di calendario del componente aggiuntivo e torna a Calendar per la visualizzazione. - Se il componente aggiuntivo definisce una funzione
eventAttachmentTrigger, viene visualizzato come provider 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 degli allegati del componente aggiuntivo e la restituisce a Calendar per la visualizzazione.
Creare l'interfaccia del componente aggiuntivo di Calendar
Per creare la tua UI, segui questi passaggi. Per estendere Calendar con un componente aggiuntivo di Google Workspace:
- 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 calendario.
- Aggiungi i campi
addOns.commoneaddOns.calendarappropriati al manifest del progetto di script del componente aggiuntivo, inclusi gli ambiti richiesti. - Se fornisci una home page specifica per Calendar, implementa la funzione
calendar.homepageTriggerper creare questa interfaccia. Puoi anche scegliere di utilizzare l'interfacciacommon.homepageTriggerper più applicazioni host. - Se fornisci un'interfaccia per gli eventi di Calendar, implementa una
funzione
calendar.eventOpenTriggerper creare questa interfaccia. Per maggiori dettagli, vedi Estensione dell'interfaccia degli eventi di Calendar. - Implementa le funzioni di callback associate necessarie per rispondere alle interazioni dell'utente con l'interfaccia utente, ad esempio i clic sui pulsanti.
Home page di Calendar
I componenti aggiuntivi supportano la visualizzazione delle home page dei componenti aggiuntivi di Google Workspace. Per mostrare la home page comune del componente aggiuntivo in Calendar, assicurati che nel manifest del componente aggiuntivo sia presente un campo addOns.calendar.
In alternativa, aggiungi un
calendar.homepageTrigger
al 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 di script del componente aggiuntivo. Questa funzione viene
chiamata automaticamente per creare la home page di Calendar quando è
necessario. Implementa questa funzione per creare e restituire un singolo
Card o un array di
oggetti Card che compongono la
home page. Alla funzione di attivazione della home page viene passato un
oggetto evento come parametro che
contiene alcune informazioni generali, ad esempio la piattaforma del client. Utilizza i dati dell'oggetto
evento per personalizzare la creazione della home page.
Estendere l'interfaccia dell'evento di Calendar
Calendar si basa su un trigger contestuale per determinare quale interfaccia (se presente) visualizzare quando l'utente modifica un evento di Calendar. Quando viene attivato, esegue la funzione di attivazione contestuale
specificata dal campo
calendar.eventOpenTrigger
nel manifest del componente aggiuntivo.
Implementa 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 che Calendar deve visualizzare mentre l'utente ha aperto l'evento.
Oggetti evento
Viene creato un oggetto evento e
passato alla
funzione di attivazione contestuale calendar.eventOpenTrigger quando un utente apre un evento di Calendar.
La funzione di attivazione può utilizzare le informazioni in questo oggetto evento per determinare
come costruire le schede dei componenti aggiuntivi o controllare il
comportamento dei componenti aggiuntivi. Gli oggetti evento vengono creati e
passati alle
funzioni homepageTrigger quando un componente aggiuntivo viene aperto per la prima volta e quando l'utente fa clic o seleziona widget interattivi.
La struttura completa degli oggetti evento è descritta in Oggetti evento. Quando Calendar è l'app host dell'add-on, gli oggetti evento di attivazione contestuale e interazione con i widget includono il campo Oggetto evento di Calendar che contiene informazioni specifiche del client di Calendar.
Aggiornare gli eventi di Calendar
Oltre all'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 trigger viene attivato solo se l'utente esegue 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 questo trigger viene attivato, esegue la funzione di trigger specificata dal campo manifest
calendar.eventUpdateTrigger. La funzione viene eseguita prima del salvataggio della modifica dell'evento di Calendar.
Il
calendar.eventUpdateTrigger
viene in genere utilizzato per uno o più dei seguenti scopi:
- Aggiorna l'interfaccia dell'evento di calendario del componente aggiuntivo in risposta alle modifiche apportate dall'utente all'evento di calendario.
- Sincronizzare i dati degli eventi di Calendar con un sistema di terze parti, ad esempio un sistema di conferenza connesso a Calendar.
Se devi apportare modifiche ai dati di un evento di Calendar (ad esempio all'elenco dei partecipanti), imposta il campo manifest dell'calendar.currentEventAccess componente aggiuntivo su WRITE o READ_WRITE. Inoltre, il componente aggiuntivo deve avere l'ambito https://www.googleapis.com/auth/calendar.addons.current.event.write
.
Aggiungere soluzioni per conferenze
Se gestisci un sistema di videoconferenza di terze parti, puoi integrarlo con Calendar aggiungendo soluzioni per le conferenze. Questa funzionalità era precedentemente in versione beta come componenti aggiuntivi per le conferenze di Calendar�.
Le soluzioni di videoconferenza rappresentano opzioni di conferenza di terze parti che gli utenti possono allegare agli eventi di Calendar. La documentazione Panoramica delle conferenze di terze parti fornisce dettagli su come creare un componente aggiuntivo che aggiunge nuove soluzioni di conferenza. Non è necessario creare un'interfaccia utente per questo tipo di estensione; le soluzioni aggiunte vengono visualizzate come opzioni nel menu a discesa dell'interfaccia utente dell'evento di Calendar.