Creazione di interfacce di Google Calendar

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 ulteriori informazioni pertinenti, automatizzare le attività e collegare sistemi di terze parti a Google Calendar.

Quando crei un'interfaccia aggiuntiva 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 del modo in cui viene aperto, un componente aggiuntivo di Google Workspace può definire un'interfaccia per la home page, un'interfaccia per gli eventi di Google Calendar, un'interfaccia per la selezione degli allegati o tutte e tre le opzioni:

  • Se un utente fa clic sull'icona del componente aggiuntivo mentre è in visualizzazione calendario, il componente aggiuntivo esegue la funzione calendar.homepageTrigger corrispondente (se presente). Questa funzione crea e restituisce una scheda della home page a 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). Questa funzione crea l'interfaccia degli eventi di Calendar del componente aggiuntivo e torna a Google Calendar per la visualizzazione.
  • Se il componente aggiuntivo definisce una funzione eventAttachmentTrigger, il componente 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 di Calendar per il componente aggiuntivo

Puoi estendere Google Calendar con un componente aggiuntivo di Google Workspace seguendo questi passaggi:

  1. Decidi se vuoi che il componente aggiuntivo abbia una home page specifica di Calendar. Decidi anche se vuoi fornire un'interfaccia personalizzata durante la modifica degli eventi di Calendar da parte dell'utente.
  2. Aggiungi i campi addOns.common e addOns.calendar appropriati al manifest del progetto di script per i componenti aggiuntivi, inclusi gli ambiti richiesti.
  3. Se fornisci una home page specifica di Calendar, implementa la funzione calendar.homepageTrigger per creare l'interfaccia. Puoi anche scegliere di utilizzare l'interfaccia common.homepageTrigger per più host di Google Workspace.
  4. Se fornisci un'interfaccia per gli eventi di Calendar, devi implementare una funzione calendar.eventOpenTrigger per crearla. Per maggiori dettagli, consulta Estensione dell'interfaccia degli eventi di Calendar.
  5. 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

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

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 fornire il nome di una funzione di trigger della home page nel progetto di script del componente aggiuntivo. Questa funzione viene richiamata 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 oggetti Card che compongono la home page. Alla funzione di attivazione della home page viene trasmesso un oggetto evento sotto forma di parametro che contiene alcune informazioni generali come la piattaforma del client. Puoi utilizzare i dati dell'oggetto evento per personalizzare la costruzione della home page.

Estendere l'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 nel calendario. Quando 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 affinché Calendar possa visualizzare quando l'utente è aperto l'evento.

Oggetti evento

Un oggetto evento viene creato e passato alla funzione di attivazione contestuale di calendar.eventOpenTrigger quando un utente apre un evento di Calendar. La funzione trigger può utilizzare le informazioni in questo oggetto evento per determinare come creare schede per i componenti aggiuntivi o controllarne il comportamento. Inoltre, gli oggetti evento vengono creati e passati 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. Quando Calendar è l'app host del componente aggiuntivo, l'attivatore contestuale e gli oggetti evento di interazione con il widget includono il campo Oggetto evento Calendar, che trasporta le informazioni client specifiche di Calendar.

Aggiornare gli eventi nel calendario

Oltre all'opzione 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 nel campo manifest calendar.eventUpdateTrigger. La funzione viene eseguita prima che la modifica dell'evento di Calendar venga salvata.

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 apportate dall'utente all'evento di Calendar.
  • Sincronizzare i dati degli 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 modifichi i 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. Ciò richiede inoltre che il componente aggiuntivo abbia l'https://www.googleapis.com/auth/calendar.addons.current.event.write ambito.

Aggiunta di soluzioni di conferenza

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 sulle 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 semplicemente visualizzate sotto forma di opzioni nel menu a discesa dell'interfaccia utente degli eventi di Google Calendar.