Oggetti evento

Questa pagina descrive la struttura degli oggetti evento dei componenti aggiuntivi di Google Workspace.

Gli oggetti evento sono strutture JSON che vengono create e passate automaticamente come parametri per attivare o richiamare le funzioni quando un utente interagisce con un componente aggiuntivo. Gli oggetti evento portano le informazioni lato client sull'app host e sul contesto corrente nella funzione di callback lato server del componente aggiuntivo.

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

  • Attivatori della home page. Per 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 nella funzione di trigger della home page per identificare l'app host attiva, la piattaforma del client, le impostazioni internazionali dell'utente e altre informazioni.

    Gli oggetti evento creati quando si attivano 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.

  • Trigger contestuali. Ogni applicazione host fornisce un insieme diverso di attivatori contestuali che si attivano quando l'utente accede a un contesto specifico. Ad esempio:

    Quando si attiva un attivatore contestuale, l'applicazione host chiama il runFunction corrispondente elencato nel manifest del componente aggiuntivo, passando un oggetto evento come parametro. Gli oggetti evento creati quando vengono attivati gli attivatori contestuali contengono tutti i campi inclusi negli oggetti evento di trigger della home page, oltre ai campi contenenti informazioni contestuali.

  • Azioni widget: Gli oggetti evento vengono utilizzati anche per fornire interattività dei widget, utilizzando lo stesso modello di azione utilizzato dai componenti aggiuntivi di Gmail. I componenti aggiuntivi di Google Workspace utilizzano le stesse funzioni di gestore dei widget, gli oggetti Action e le risposte alle azioni. Tuttavia, nei componenti aggiuntivi di Google Workspace, gli oggetti evento di azione includono ancora più informazioni su cui può agire una funzione di callback.

    Gli oggetti evento creati come risultato delle azioni dei widget contengono tutti i campi inclusi negli oggetti evento di trigger contestuale, oltre a quelli contenenti informazioni sui widget.

  • Attivatori dei link di anteprima: In Documenti, Fogli e Presentazioni Google, puoi configurare anteprime dei link per servizi di terze parti in base a pattern URL specifici. Quando gli utenti interagiscono con un link che soddisfa il pattern, linkPreviewTriggers si attiva e un oggetto evento che contiene il link viene passato alla funzione di callback dell'attivatore. Il componente aggiuntivo può utilizzare questo oggetto evento per creare uno smart chip e una scheda che mostri le informazioni sul link all'interno dell'applicazione host. Puoi anche creare azioni widget per consentire agli utenti di interagire con la scheda di anteprima e i suoi contenuti.

Struttura dell'oggetto evento

La tabella seguente descrive la struttura di primo livello degli oggetti evento dei componenti aggiuntivi di Google Workspace. La struttura dell'oggetto evento 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, determinati dall'app host attiva: gmailEventObject, calendarEventObject o driveEventObject.

Per la compatibilità con le versioni precedenti, gli oggetti evento dei componenti aggiuntivi di Google Workspace includeno anche tutti i campi originali utilizzati negli oggetti evento di azione dei componenti aggiuntivi di Gmail. Questi campi sono elencati nella tabella seguente, in "Campi dei componenti aggiuntivi originali di Gmail". Le informazioni in questi campi vengono riprodotte in una nuova struttura di oggetti.

Oggetto evento
eventObject.commonEventObject Common fields object
Un oggetto contenente informazioni comuni a tutti gli oggetti evento, a prescindere dall'applicazione host.
eventObject.calendar Calendar event object
Presenta solo se l'organizzatore della chiamata è Google Calendar. Un oggetto contenente informazioni sul calendario e sugli eventi.
eventObject.drive Drive event object
È presente solo se l'organizzatore della chiamata è Google Drive. Un oggetto contenente informazioni su Drive.
eventObject.gmail Gmail event object
Presenta solo se l'organizzatore della chiamata è Gmail. Un oggetto contenente informazioni di Gmail.
eventObject.docs Docs event object
Presenta solo se l'organizzatore della chiamata è Documenti Google. Un oggetto contenente informazioni su Documenti.
eventObject.sheets Sheets event object
Presenta solo se l'organizzatore della chiamata è Fogli Google. Un oggetto contenente informazioni su Fogli.
eventObject.slides Slides event object
Presenta solo se l'organizzatore della chiamata è Presentazioni Google. Un oggetto contenente informazioni su Presentazioni.
Campi dei componenti aggiuntivi di Gmail originali
eventObject.messageMetadata.accessToken string
Obsoleta. Un token di accesso. Puoi utilizzarla per attivare l'accesso ai dati utente utilizzando ambiti temporanei dei componenti aggiuntivi di Gmail.

Per i componenti aggiuntivi di Google Workspace, trova queste informazioni nel campo eventObject.gmail.accessToken.

eventObject.messageMetadata.messageId string
Obsoleta. L'ID messaggio del thread aperto nell'interfaccia utente di Gmail.

Per i componenti aggiuntivi di Google Workspace, trova queste informazioni nel campo eventObject.gmail.messageId.

eventObject.clientPlatform string
Obsoleta. Indica l'origine dell'evento (web, iOS o Android).

Per i componenti aggiuntivi di Google Workspace, trova queste informazioni nel campo eventObject.commonEventObject.platform.

eventObject.formInput object
Obsoleta. Una mappa dei valori correnti di tutti i widget dei moduli nella scheda, con un solo valore per widget. Le chiavi sono gli ID stringa associati ai widget e i valori sono stringhe. L'oggetto event fornisce formInput come comodità quando è necessario leggere i dati da più widget con valori singoli previsti, come input e opzioni di testo. Per i widget a più valori, ad esempio le caselle di controllo, puoi leggere ciascun valore da formInputs.

Per i componenti aggiuntivi di Google Workspace, puoi trovare queste informazioni nel campo eventObject.commonEventObject.formInputs. I widget con valori singoli sono rappresentati come array con un singolo elemento.

eventObject.formInputs object
Obsoleta. Una mappa dei valori correnti dei widget nella scheda, presentata come elenchi di stringhe. Le chiavi sono gli ID stringa associati al widget. Per i widget a valore singolo, il valore viene presentato in un array di un singolo elemento. Per i widget a più valori, come i gruppi di caselle di controllo, tutti i valori vengono presentati in un elenco.

Per i componenti aggiuntivi di Google Workspace, trova queste informazioni nel campo eventObject.commonEventObject.formInputs.

eventObject.parameters object
Obsoleta. Mappa dei parametri aggiuntivi che fornisci a Action utilizzando Action.setParameters(). Le chiavi e i valori della mappa sono stringhe.

Per i componenti aggiuntivi di Google Workspace, trova queste informazioni nel campo eventObject.commonEventObject.parameters.

eventObject.userCountry string
Deprecato e disattivato per impostazione predefinita. Il codice di due lettere che indica il paese o la regione dell'utente. Può anche essere un codice paese numerico UN M49.

Per i componenti aggiuntivi di Google Workspace, trova queste informazioni nel campo eventObject.commonEventObject.userLocale.

eventObject.userLocale string
Deprecato e disattivato per impostazione predefinita. Il codice ISO 639 a due lettere che indica la lingua dell'utente. Per maggiori dettagli, vedi Accedere alle impostazioni internazionali e al fuso orario dell'utente.

Per i componenti aggiuntivi di Google Workspace, trova queste informazioni nel campo eventObject.commonEventObject.userLocale.

eventObject.userTimezone.id string
Deprecato e disattivato per impostazione predefinita. L' identificatore del fuso orario del fuso orario dell'utente. Esempi: America/New_York, Europe/Vienna e Asia/Seoul. Per maggiori dettagli, consulta Accedere alle impostazioni internazionali e al fuso orario dell'utente.

Per i componenti aggiuntivi di Google Workspace, trova queste informazioni nel campo eventObject.commonEventObject.timeZone.id.

eventObject.userTimezone.offset string
Deprecato e disattivato per impostazione predefinita. La differenza di orario rispetto al fuso orario UTC (Coordinated Universal Time) del fuso orario dell'utente, misurato in millisecondi. Per maggiori dettagli, consulta Accedere alle impostazioni internazionali e al fuso orario dell'utente.

Per i componenti aggiuntivi di Google Workspace, trova queste informazioni nel campo eventObject.commonEventObject.timeZone.offset.

Oggetto evento comune

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

Oltre agli attivatori della home page e contestuali, i componenti aggiuntivi creano e trasmettono 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 una query sull'oggetto evento comune per determinare i contenuti dei widget aperti nel client dell'utente. Ad esempio, il componente aggiuntivo può individuare il testo inserito da un utente in un widget TextInput nell'oggetto eventObject.commentEventObject.formInputs.

Campi di oggetti evento comuni
commonEventObject.platform string
Indica l'origine dell'evento ("WEB", "IOS" o "ANDROID").
commonEventObject.formInputs object
Una mappa contenente i valori correnti dei widget nella scheda visualizzata. Le chiavi mappa sono gli ID stringa assegnati a ogni widget.

La struttura dell'oggetto valore mappa dipende dal tipo di widget:

  • Widget a valore singolo (ad esempio una casella di testo): un elenco di stringhe (un solo elemento).

    Esempio: per un widget di input di testo con employeeName come ID, accedi al valore di input di testo con: e.commonEventObject.formInputs.employeeName.stringInputs.value[0]

  • Widget a più valori (ad esempio, gruppi di caselle di controllo): un elenco di stringhe.

    Esempio: per un widget a più valori con participants come ID, accedi all'array di valori con: e.commonEventObject.formInputs.participants.stringInputs.value.

  • A date-time picker: un DateTimeInput object.

    Esempio: per un selettore con ID myDTPicker, accedi all'oggetto DateTimeInput utilizzando e.commonEventObject.formInputs.myDTPicker.dateTimeInput.

  • A date-only picker: un DateInput object.

    Esempio: per un selettore con ID myDatePicker, accedi all'oggetto DateInput utilizzando e.commonEventObject.formInputs.myDatePicker.dateInput.

  • A time-only picker: un TimeInput object.

    Esempio: per un selettore con ID myTimePicker, accedi all'oggetto TimeInput utilizzando e.commonEventObject.formInputs.myTimePicker.timeInput.
commonEventObject.hostApp string
Indica l'app host in cui è attivo il componente aggiuntivo quando viene generato l'oggetto evento. I valori possibili sono:
  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
commonEventObject.parameters object
Eventuali parametri aggiuntivi forniti a Action utilizzando Action.setParameters().
commonEventObject.userLocale string
Disattivata per impostazione predefinita. L'identificatore della lingua e del paese/della regione dell'utente nel formato ISO 639 codice lingua-ISO 3166 codice paese/regione. Ad esempio, en-US.

Per attivare questo campo, devi impostare addOns.common.useLocaleFromApp su true nel file manifest del componente aggiuntivo. L'elenco degli ambiti del componente aggiuntivo deve includere anche https://www.googleapis.com/auth/script.locale. Per maggiori dettagli, consulta Accedere alle impostazioni internazionali e al fuso orario dell'utente.

commonEventObject.timeZone string
Disattivata per impostazione predefinita. L'ID e la differenza del fuso orario. Per attivare questo campo, devi impostare addOns.common.useLocaleFromApp su true nel file manifest del componente aggiuntivo. L'elenco degli ambiti del componente aggiuntivo deve includere anche https://www.googleapis.com/auth/script.locale. Per maggiori dettagli, consulta Accedere alle impostazioni internazionali e al fuso orario dell'utente.
commonEventObject.timeZone.id string
L' identificatore del fuso orario del fuso orario dell'utente. Esempi: America/New_York, Europe/Vienna e Asia/Seoul. Per attivare questo campo, devi impostare addOns.common.useLocaleFromApp su true nel file manifest del componente aggiuntivo. L'elenco degli ambiti del componente aggiuntivo deve includere anche https://www.googleapis.com/auth/script.locale. Per maggiori dettagli, consulta Accedere alle impostazioni internazionali e al fuso orario dell'utente.
commonEventObject.timeZone.offset string
La differenza di orario rispetto al fuso orario UTC (Coordinated Universal Time) del fuso orario dell'utente, misurato in millisecondi. Per maggiori dettagli, consulta Accedere alle impostazioni internazionali e al fuso orario dell'utente.

Input del modulo del selettore di data e ora

Le funzioni di callback dell'azione possono ricevere i valori correnti del widget nel campo commonEventObject.formInputs. Sono inclusi i valori di data o ora selezionati dall'utente nei widget del selettore di data o ora. Tuttavia, la struttura delle informazioni varia a seconda che il widget sia stato configurato come selettore di data-ora, selettore di sola data o selettore di sola data. Le differenze strutturali sono descritte nella seguente tabella:

Oggetto DateTimeInput
dateTimeInput.hasDate boolean
true se la data e l'ora inserite includono una data; se false è inclusa solo un'ora.
dateTimeInput.hasTime boolean
true se la data e l'ora inserite includono un'ora; se false è inclusa solo una data.
dateTimeInput.msSinceEpoch string
Ora selezionata dall'utente, in millisecondi dall'epoca (00:00:00 UTC il 1° gennaio 1970).
Oggetto DateInput
dateInput.msSinceEpoch string
Ora selezionata dall'utente, in millisecondi dall'epoca (00:00:00 UTC il 1° gennaio 1970).
Oggetto TimeInput
timeInput.hours number
Il numero di ore selezionato dall'utente.
timeInput.minutes number
Il numero dei minuti selezionato dall'utente.

Oggetto evento di calendario

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

La seguente tabella elenca i campi presenti nel campo calendarEventObject di un oggetto evento. I campi contrassegnati come Dati generati dagli utenti sono presenti nell'oggetto evento 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.

Oggetto evento di calendario
calendar.attendees[] list of attendee objects
Dati generati dagli utenti. Un elenco dei partecipanti all'evento nel calendario.
calendar.calendarId string
L'ID del calendario.
calendar.capabilities object
Dati generati dagli utenti. Un oggetto che descrive le funzionalità del componente aggiuntivo per visualizzare o aggiornare le informazioni sugli eventi.
calendar.capabilities.canAddAttendees boolean
Dati generati dagli utenti. true se il componente aggiuntivo può aggiungere nuovi partecipanti all'elenco dei partecipanti all'evento; false in caso contrario.
calendar.capabilities.canSeeAttendees boolean
Dati generati dagli utenti. true se il componente aggiuntivo può leggere l'elenco dei partecipanti all'evento; false in caso contrario.
calendar.capabilities.canSeeConferenceData boolean
Dati generati dagli utenti. true se il componente aggiuntivo può leggere i dati della conferenza dell'evento; false in caso contrario.
calendar.capabilities.canSetConferenceData boolean
Dati generati dagli utenti. true se il componente aggiuntivo può aggiornare i dati della conferenza dell'evento; false in caso contrario.
calendar.capabilities.canAddAttachments boolean
Dati generati dagli utenti. true se il componente aggiuntivo può aggiungere nuovi allegati all'evento; false in caso contrario.
calendar.conferenceData Conference data object
Dati generati dagli utenti. Un oggetto che rappresenta tutti i dati della conferenza associati a questo evento, ad esempio i dettagli della conferenza di Google Meet.
calendar.id string
ID evento.
calendar.organizer object
Un oggetto che rappresenta l'organizzatore dell'evento.
calendar.organizer.email string
Indirizzo email dell'organizzatore dell'evento.
calendar.recurringEventId string
ID di un evento ricorrente.

Partecipante

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

Oggetto partecipante
attendee.additionalGuests number
Il numero di ospiti aggiuntivi che il partecipante ha indicato di portare. Il valore predefinito è zero.
attendee.comment string
Commento di risposta del partecipante, se presente.
attendee.displayName string
Nome visualizzato del partecipante.
attendee.email string
L'indirizzo email del partecipante.
attendee.optional boolean
true se la partecipazione di questo partecipante è contrassegnata come facoltativa; false in caso contrario.
attendee.organizer boolean
true se il partecipante è un organizzatore dell'evento.
attendee.resource boolean
true se il partecipante rappresenta una risorsa, ad esempio una stanza o un'attrezzatura; false altrimenti.
attendee.responseStatus string
Stato della risposta del partecipante. I valori possibili sono:
  • accepted: il partecipante ha accettato l'invito all'evento.
  • declined: il partecipante ha rifiutato l'invito all'evento.
  • needsAction: il partecipante non ha risposto all'invito all'evento.
  • tentative: il partecipante ha accettato provvisoriamente l'invito all'evento.
attendee.self boolean
true se questo partecipante rappresenta il calendario in cui appare l'evento; in caso contrario false.

Dati conferenza

Gli oggetti dati delle conferenze contengono informazioni sulle conferenze allegate agli eventi di Google Calendar. Può trattarsi di soluzioni per conferenze Google, come 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.

Oggetto dati conferenza
conferenceData.conferenceId string
ID della conferenza. Questo ID ha lo scopo di consentire alle applicazioni di tenere traccia delle conferenze; non dovresti mostrarlo agli utenti.
conferenceData.conferenceSolution object
Un oggetto che rappresenta la soluzione per conferenze, ad esempio Hangouts o Google Meet.
conferenceData.conferenceSolution.iconUri string
L'URI dell'icona visibile all'utente che rappresenta questa soluzione di conferenza.
conferenceData.conferenceSolution.key object
La chiave che identifica in modo univoco la soluzione per le conferenze per questo evento.
conferenceData.conferenceSolution.key.type string
Il tipo di soluzione per le conferenze. I valori possibili sono:
  • eventHangout per Hangouts per i consumatori (http://hangouts.google.com).
  • eventNamedHangout per la versione classica di Hangouts per gli utenti di Google Workspace (http://hangouts.google.com).
  • hangoutsMeet per Google Meet (http://meet.google.com).
conferenceData.conferenceSolution.name string
Nome visibile all'utente di questa soluzione di conferenza (non localizzato).
conferenceData.entryPoints[] list of entry point objects
L'elenco dei punti di ingresso alla conferenza, ad esempio URL o numeri di telefono.
conferenceData.notes string
Note aggiuntive (come istruzioni dell'amministratore di dominio o note legali) sulla conferenza da mostrare all'utente. Possono contenere HTML. La lunghezza massima è di 2048 caratteri.
conferenceData.parameters object
Un oggetto contenente una mappa dei dati dei parametri definiti per l'utilizzo da parte del componente aggiuntivo.
conferenceData.parameters.addOnParameters object
Una mappa di chiavi e valori delle stringhe di parametri. Queste chiavi e valori sono definiti dallo sviluppatore del componente aggiuntivo per collegare informazioni a una conferenza specifica per l'utilizzo del componente aggiuntivo.

Punto di ingresso

Gli oggetti punto di ingresso includono informazioni sui mezzi stabiliti per accedere a una determinata conferenza, ad esempio per telefono o video. Queste informazioni sono presenti nell'oggetto evento solo se sono presenti nell'evento di Calendar e se il componente aggiuntivo imposta il campo addOns.calendar.currentEventAccess manifest su READ o READ_WRITE.

Oggetto punto di ingresso
entryPoint.accessCode string
Il codice di accesso utilizzato per accedere alla conferenza. La lunghezza massima è di 128 caratteri. I provider di conferenze in genere utilizzano solo un sottoinsieme di {accessCode, meetingCode, passcode, password, pin} per fornire l'accesso alle conferenze. Abbina e visualizza sempre e solo i campi utilizzati dal fornitore di conferenze.
entryPoint.entryPointFeatures list
Funzionalità del punto di contatto. Al momento queste funzionalità si applicano solo a phone punti di ingresso:
  • toll: il punto di accesso è una telefonata a pagamento.
  • toll_free: il punto di accesso è una telefonata senza costi.
entryPoint.entryPointType string
Il tipo di punto di ingresso. I valori possibili sono i seguenti:
  • more: istruzioni aggiuntive per la partecipazione alla conferenza, ad esempio numeri di telefono alternativi. Una conferenza può avere un solo punto di ingresso more; se presente, è necessario anche almeno un altro tipo di punto di ingresso.
  • phone: partecipa alla conferenza tramite un numero di telefono. Una conferenza può avere zero o più punti di ingresso phone. Google Calendar visualizza solo i primi due punti di accesso del telefono, dopo la formattazione e l'ordinamento in ordine alfabetico.
  • sip: partecipa alla conferenza tramite SIP. Una conferenza può avere al massimo un punto di ingresso sip.
  • video: partecipa alla conferenza tramite HTTP. Una conferenza può avere al massimo un punto di ingresso video.
entryPoint.label string
Etichetta visibile all'utente per l'URI del punto di ingresso (non localizzata).
entryPoint.meetingCode string
Il codice riunione utilizzato per accedere alla conferenza. La lunghezza massima è di 128 caratteri. I provider di conferenze in genere utilizzano solo un sottoinsieme di {accessCode, meetingCode, passcode, password, pin} per fornire l'accesso alle conferenze. Abbina e visualizza sempre e solo i campi utilizzati dal fornitore di conferenze.
entryPoint.passcode string
Il passcode utilizzato per accedere alla conferenza. La lunghezza massima è di 128 caratteri. I provider di conferenze in genere utilizzano solo un sottoinsieme di {accessCode, meetingCode, passcode, password, pin} per fornire l'accesso alle conferenze. Abbina e visualizza sempre e solo i campi utilizzati dal fornitore di conferenze.
entryPoint.password string
La password utilizzata per accedere alla conferenza. La lunghezza massima è di 128 caratteri. I provider di conferenze in genere utilizzano solo un sottoinsieme di {accessCode, meetingCode, passcode, password, pin} per fornire l'accesso alle conferenze. Abbina e visualizza sempre e solo i campi utilizzati dal fornitore di conferenze.
entryPoint.pin string
Il PIN utilizzato per accedere alla conferenza. La lunghezza massima è di 128 caratteri. I provider di conferenze in genere utilizzano solo un sottoinsieme di {accessCode, meetingCode, passcode, password, pin} per fornire l'accesso alle conferenze. Abbina e visualizza sempre e solo i campi utilizzati dal fornitore di conferenze.
entryPoint.regionCode string
Codice regione del numero di telefono. Obbligatorio dagli utenti se l'URI non include un codice paese. I valori si basano sull' elenco CLDR di codici regione pubblico.
entryPoint.uri string
L'URI del punto di ingresso. La lunghezza massima è di 1300 caratteri. La formattazione dipende dal tipo di punto di ingresso:
  • more: uno schema http: o https: è obbligatorio.
  • phone: uno schema tel: è obbligatorio. L'URI deve includere l'intera sequenza di composizione (ad esempio, "tel:+12345678900,,,12345678;1234").
  • sip: uno schema sip: o sips: è obbligatorio. Ad esempio "sip:12345678@mioprovider.com".
  • video: uno schema http: o https: è obbligatorio.

Oggetto evento di Drive

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

Oggetto evento di Drive
drive.activeCursorItem Drive item object
L'elemento di Drive attualmente attivo.
drive.selectedItems[] list of Drive item objects
Un elenco di elementi (file o cartelle) selezionati in Drive.

Elemento di Drive

Gli oggetti elemento di Drive includono informazioni su elementi specifici di Drive, come file o cartelle.

Oggetto elemento di Drive
item.addonHasFileScopePermission boolean
Se true, il componente aggiuntivo ha richiesto e ricevuto https://www.googleapis.com/auth/drive.file l'autorizzazione dell'ambito per questo elemento; altrimenti il campo è false.
item.id string
ID dell'elemento selezionato.
item.iconUrl string
L'URL dell'icona che rappresenta l'elemento selezionato.
item.mimeType string
Il tipo MIME dell'elemento selezionato.
item.title string
Il titolo dell'elemento selezionato.

Oggetto evento Gmail

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

Oggetto evento Gmail
gmail.accessToken string
Token di accesso specifico per Gmail. Puoi utilizzare questo token con il metodo GmailApp.setCurrentMessageAccessToken(accessToken) per concedere al componente aggiuntivo l'accesso temporaneo ai messaggi di Gmail attualmente aperti di un utente o consentire al componente aggiuntivo di scrivere nuove bozze.
gmail.bccRecipients[] list of strings
Disattivata per impostazione predefinita. L'elenco di indirizzi email di destinatari in "Ccn:" attualmente inclusi in una bozza che il componente aggiuntivo sta scrivendo. Per attivare questo campo, devi impostare il campo addOns.gmail.composeTrigger.draftAccess nel file manifest su METADATA.
gmail.ccRecipients[] list of strings
Disattivata per impostazione predefinita. L'elenco di indirizzi email di destinatari in "Cc:" attualmente inclusi nella bozza che il componente aggiuntivo sta scrivendo. Per attivare questo campo, devi impostare il campo addOns.gmail.composeTrigger.draftAccess nel file manifest su METADATA.
gmail.messageId string
L'ID del messaggio Gmail attualmente aperto.
gmail.threadId string
ID del thread di Gmail attualmente aperto.
gmail.toRecipients[] list of strings
Disattivata per impostazione predefinita. L'elenco di indirizzi email di destinatari "A:" attualmente inclusi in una bozza che il componente aggiuntivo sta scrivendo. Per attivare questo campo, devi impostare il campo addOns.gmail.composeTrigger.draftAccess nel file manifest su METADATA.

Oggetto evento di 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.

Oggetto evento di Documenti
docs.id string
È presente solo se l'ambito https://www.googleapis.com/auth/drive.file è stato autorizzato dall'utente.
L'ID del documento aperto nell'interfaccia utente di Documenti.
docs.title string
È presente solo se l'ambito https://www.googleapis.com/auth/drive.file è stato autorizzato dall'utente.
Il titolo del documento si apre nell'interfaccia utente di Documenti.
docs.addonHasFileScopePermission boolean
Se true, il componente aggiuntivo ha richiesto e ricevuto l'autorizzazione per l'ambito https://www.googleapis.com/auth/drive.file per il documento aperto nell'interfaccia utente di Documenti; altrimenti questo campo è false.
docs.matchedUrl.url string
Presenta solo se sono soddisfatte le seguenti condizioni:
  • https://www.googleapis.com/auth/workspace.linkpreview è stato autorizzato dall'utente.
  • L'URL corrisponde al pattern host specificato nell'attivatore LinkPreviewTriggers.

L'URL del link che genera un'anteprima in Documenti Google. Per utilizzare questo campo, devi configurare LinkPreviewTriggers nel file manifest del tuo componente aggiuntivo. Per ulteriori dettagli, consulta Visualizzare l'anteprima dei link con smart chip.

Payload di esempio per quando un utente visualizza l'anteprima del link https://www.example.com/12345: 

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

Oggetto evento di Fogli

L'oggetto evento Fogli è 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 è Fogli Google.

Oggetto evento di Fogli
sheets.id string
Presenta solo se l'ambito https://www.googleapis.com/auth/drive.file è stato autorizzato dall'utente. L'ID del foglio di lavoro aperto nell'interfaccia utente di Fogli.
sheets.title string
Presenta solo se l'ambito https://www.googleapis.com/auth/drive.file è stato autorizzato dall'utente. Il titolo del foglio di lavoro aperto nell'interfaccia utente di Fogli.
sheets.addonHasFileScopePermission boolean
Se true, il componente aggiuntivo ha richiesto e ricevuto l'autorizzazione per l'ambito https://www.googleapis.com/auth/drive.file per il foglio di lavoro aperto nell'interfaccia utente di Fogli; altrimenti, il campo è false.
sheets.matchedUrl.url string
Presenta solo se sono soddisfatte le seguenti condizioni:
  • https://www.googleapis.com/auth/workspace.linkpreview è stato autorizzato dall'utente.
  • L'URL corrisponde al pattern host specificato nell'attivatore LinkPreviewTriggers.

L'URL del link che genera un'anteprima in Fogli Google. Per utilizzare questo campo, devi configurare LinkPreviewTriggers nel file manifest del tuo componente aggiuntivo. Per ulteriori dettagli, consulta Visualizzare l'anteprima dei link con smart chip.

Payload di esempio per quando un utente visualizza l'anteprima del link https://www.example.com/12345:

"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.

Oggetto evento Presentazioni
slides.id string
Presenta solo se l'ambito https://www.googleapis.com/auth/drive.file è stato autorizzato dall'utente. L'ID della presentazione aperta nell'interfaccia utente di Presentazioni.
slides.title string
Presenta solo se l'ambito https://www.googleapis.com/auth/drive.file è stato autorizzato dall'utente. Il titolo della presentazione si apre nell'interfaccia utente di Presentazioni.
slides.addonHasFileScopePermission boolean
Se true, il componente aggiuntivo ha richiesto e ricevuto l'autorizzazione per l'ambito https://www.googleapis.com/auth/drive.file per la presentazione aperta nell'interfaccia utente di Presentazioni; in caso contrario, il campo è false.
slides.matchedUrl.url string
Presenta solo se sono soddisfatte le seguenti condizioni:
  • https://www.googleapis.com/auth/workspace.linkpreview è stato autorizzato dall'utente.
  • L'URL corrisponde al pattern host specificato nell'attivatore LinkPreviewTriggers.

L'URL del link che genera un'anteprima in Presentazioni Google. Per utilizzare questo campo, devi configurare LinkPreviewTriggers nel file manifest del tuo componente aggiuntivo. Per ulteriori dettagli, consulta Visualizzare l'anteprima dei link con smart chip.

Payload di esempio per quando un utente visualizza l'anteprima del link https://www.example.com/12345:

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