Oggetti evento

Questa pagina illustra la struttura degli oggetti evento di Google Workspace Add-ons.

Gli oggetti evento sono strutture JSON che vengono costruite automaticamente e passate come parametri alle funzioni di trigger o di callback quando un utente interagisce con un componente aggiuntivo. Gli oggetti evento trasmettono informazioni lato client sull'app host e sul contenuto corrente alla funzione di callback lato server del componente aggiuntivo.

I componenti aggiuntivi di Google Workspace utilizzano gli oggetti evento nelle seguenti posizioni:

• Attivatori della home page. A ogni funzione homepageTrigger che definisci viene passato automaticamente un oggetto evento quando viene attivata la funzione di attivazione della home page. Puoi utilizzare questo oggetto la funzione di attivazione della home page per identificare l'app host attiva, piattaforma, le impostazioni internazionali dell'utente e altre informazioni.

  Gli oggetti evento creati quando vengono attivati gli attivatori della home page non contengono tutti i campi inclusi negli altri due casi; i campi relativi ai widget e alle informazioni contestuali vengono omessi.

• Attivatori contestuali. Ogni applicazione host fornisce un insieme diverso di trigger contestuali che si attivano quando l'utente inserisce un contesto specifico. Ad esempio:

  • Gmail fornisce un attivatore contestuale per quando un utente apre un messaggio e un altro quando un utente compone un messaggio.
  • Google Calendar fornisce un attivatore contestuale per quando un utente apre un evento.
  • Google Drive fornisce un trigger contestuale che segnala quando un utente seleziona i file di Drive.

  Quando viene attivato un attivatore contestuale, l'applicazione host chiama il corrispondente runFunction elencato nel manifest del componente aggiuntivo, passandogli un oggetto evento come parametro. Gli oggetti evento creati quando contestuali gli attivatori attivati contengono tutti i campi inclusi nell'evento attivatore della home page più campi contenenti informazioni contestuali.

• Azioni widget. Oggetti evento vengono utilizzati anche per fornire widget all'interattività usando lo stesso modello di azione utilizzato dai componenti aggiuntivi di Gmail per gli utilizzi odierni. I componenti aggiuntivi di Google Workspace utilizzano tutte le stesse funzioni di gestore dei widget, gli oggetti e le risposte alle azioni di Action. Tuttavia, nei Componenti aggiuntivi di Google Workspace Oggetti di eventi di azione includere ancora più informazioni su cui può agire una funzione di callback.

  Gli oggetti evento creati come risultato delle azioni del widget contengono tutte le inclusi negli oggetti di eventi trigger contestuali, più i campi contenenti le informazioni del widget.

• Eventi che attivano l'anteprima dei link. In Documenti, Fogli e Presentazioni Google, puoi configurare le anteprime dei link per i servizi di terze parti in base a pattern di URL specifici. Quando gli utenti interagiscono con un link che soddisfa il pattern, viene attivato l'evento linkPreviewTriggers e un oggetto evento contenente il link viene passato alla funzione di callback dell'attivatore. Il tuo componente aggiuntivo può utilizzare questo oggetto evento per creare un smart chip e smart card che mostrano informazioni sul link all'interno dell'host un'applicazione. Puoi anche creare azioni del widget per consentire agli utenti di interagire la scheda di anteprima e i relativi contenuti.

Struttura dell'oggetto evento

La tabella seguente descrive la struttura di primo livello degli oggetti evento di Google Workspace Add-ons. La struttura dell'oggetto event include un campo di primo livello commonEventObject per le informazioni indipendenti dall'host. Ogni oggetto evento può anche avere uno dei seguenti campi di primo livello specifici dell'host, determinato dal app host attiva: gmailEventObject, calendarEventObject o driveEventObject.

Per la compatibilità con le versioni precedenti, i componenti aggiuntivi di Google Workspace includono anche tutti i campi originali utilizzati in Oggetti di eventi di azione dei componenti aggiuntivi di Gmail. Questi campi sono elencati nella tabella seguente nella sezione "Campi del componente aggiuntivo di Gmail originale". le informazioni in questi campi vengono riprodotte nella nuova struttura dell'oggetto.

Oggetto evento comune

L'oggetto evento comune è la parte dell'oggetto evento complessivo che trasporta informazioni generali indipendenti dall'host al componente aggiuntivo fornite dal client dell'utente. Questo e includono dettagli quali le impostazioni internazionali dell'utente, l'app host e la piattaforma.

Oltre agli attivatori della home page e contestuali, i componenti aggiuntivi creano e passano gli oggetti evento alle funzioni di callback dell'azione quando l'utente interagisce con i widget. La funzione di callback del componente aggiuntivo può eseguire query l'oggetto evento comune per determinare i contenuti dei widget aperti nella di alto profilo. Ad esempio, il tuo componente aggiuntivo può individuare il testo inserito da un utente in un widget TextInput nell'objettivo eventObject.commentEventObject.formInputs.

Input del modulo del selettore della data e dell'ora

Le funzioni di callback delle azioni possono ricevere i valori attuali dei widget nel campo commonEventObject.formInputs. Sono inclusi i valori di data o ora selezionati dall'utente nel selettore di data o ora widget. Tuttavia, la struttura delle informazioni varia a seconda che si tratti di il widget è stato configurato come selettore data-ora, selettore solo data o solo ora selettore. Le differenze strutturali sono descritte nella tabella seguente:

Oggetto evento Calendar

L'oggetto evento Calendar è la parte dell'oggetto evento complessivo che trasporta informazioni sul calendario e sugli eventi nel calendario di un utente. È presente in un oggetto evento solo se l'applicazione host è Google Calendar.

La tabella seguente elenca i campi presenti nel campo calendarEventObject di un oggetto evento. I campi contrassegnati come Dati generati dall'utente sono presenti nell'oggetto evento se e solo se i dati sono presenti nell'evento di Calendar e il componente aggiuntivo imposta il campo addOns.calendar.currentEventAccess manifest su READ o READ_WRITE.

Partecipante

Gli oggetti dei partecipanti trasportano informazioni sui singoli partecipanti in Google Calendar eventi. Queste informazioni sono presenti nell'oggetto evento se e solo se i dati sono presenti nell'evento di Calendar e il componente aggiuntivo imposta il campo addOns.calendar.currentEventAccess manifest su READ o READ_WRITE.

Dati conferenza

Gli oggetti di dati delle conferenze contengono informazioni sulle conferenze allegate agli eventi di Google Calendar. Possono essere soluzioni Google per conferenze, Google Meet o conferenze di terze parti. Queste informazioni sono presenti nell'oggetto evento se e solo se i dati sono presenti nell'evento di Calendar e il componente aggiuntivo imposta il campo addOns.calendar.currentEventAccess manifest su READ o READ_WRITE.

Punto di ingresso

Gli oggetti punto di contatto contengono informazioni sui mezzi di accesso stabiliti per una determinata conferenza, ad esempio per telefono o video. Queste informazioni sono presenti in l'oggetto evento solo se i dati sono presenti nell'evento di Calendar e il componente aggiuntivo imposta la sua addOns.calendar.currentEventAccess manifest su READ o READ_WRITE.

Oggetto evento Drive

L'oggetto evento Drive è la parte dell'oggetto evento complessivo che trasporta informazioni su Google Drive di un utente e sui suoi contenuti. È solo presente in un oggetto evento se l'applicazione host è Google Drive.

Elemento di Drive

Gli oggetti elemento di Drive contengono informazioni su elementi di Drive specifici, ad esempio file o cartelle.

Oggetto evento Gmail

L'oggetto evento di Gmail è la parte dell'oggetto evento complessivo che trasporta informazioni sui messaggi Gmail di un utente. È presente solo in un oggetto evento se l'applicazione host è Gmail.

Oggetto evento Documenti

L'oggetto evento Documenti è la parte dell'oggetto evento complessivo che trasporta informazioni sul documento di un utente e sui suoi contenuti. È presente in un oggetto evento solo se l'applicazione host è Documenti Google.

"docs" : {
  "matchedUrl" : {
      "url" : "https://www.example.com/12345"
  }
}
        

Oggetto evento Fogli

L'oggetto evento Fogli è la parte dell'oggetto evento complessivo che contiene informazioni sul documento di un utente e sui relativi contenuti. È presente in un oggetto evento solo se l'applicazione host è Fogli Google.

"sheets" : {
  "matchedUrl" : {
      "url" : "https://www.example.com/12345"
  }
}
        

Oggetto evento Presentazioni

L'oggetto evento Presentazioni è la parte dell'oggetto evento complessivo che trasporta informazioni sul documento di un utente e sui suoi contenuti. È presente in un oggetto evento solo se l'applicazione host è Presentazioni Google.

"slides" : {
  "matchedUrl" : {
      "url" : "https://www.example.com/12345"
  }
}