Oggetti evento

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

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

I componenti aggiuntivi di Google Workspace utilizzano oggetti evento nei seguenti punti:

  • Trigger della home page. Ogni funzione homepageTrigger che definisci viene passata automaticamente a un oggetto evento quando viene attivata la funzione di attivazione della home page. Puoi utilizzare questo oggetto nella funzione di attivazione 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 viene attivato l'attivazione della home page non contengono tutti i campi inclusi negli altri due casi; i campi relativi a widget e informazioni contestuali vengono omessi.

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

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

  • Azioni widget. Gli oggetti Evento vengono utilizzati anche per fornire l'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 del gestore di 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ò intervenire una funzione di callback.

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

  • Attivatori di link di anteprima (anteprima per sviluppatori). In Documenti Google, puoi configurare l'anteprima dei link per i servizi di terze parti in base a pattern URL specifici. Quando gli utenti interagiscono con un link che soddisfa il pattern, viene attivato previewLinkTrigger e un oggetto evento che contiene il link viene passato alla funzione di callback del trigger. Il componente aggiuntivo può utilizzare questo oggetto evento per creare uno smart chip e una scheda che mostrano informazioni sul link all'interno dell'applicazione host. Puoi anche creare azioni del widget per consentire agli utenti di interagire con la scheda di anteprima e i suoi contenuti.

Struttura di oggetti evento

La seguente tabella descrive la struttura di primo livello degli oggetti degli eventi 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, determinato dall'app host attiva: gmailEventObject, calendarEventObject o driveEventObject.

Per la compatibilità con le versioni precedenti, gli oggetti evento dei componenti aggiuntivi di Google Workspace includono anche tutti i campi originali utilizzati negli oggetti evento delle azioni dei componenti aggiuntivi di Gmail. Questi campi sono elencati nella tabella riportata di seguito in "Campi aggiuntivi del componente aggiuntivo Gmail"; le informazioni in questi campi vengono riprodotte nella nuova struttura a 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
Presenta 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 di Documenti.
eventObject.sheets Sheets event object
Presenta solo se l'organizzatore della chiamata è Fogli Google. Un oggetto contenente informazioni di Fogli.
eventObject.slides Slides event object
Presenta solo se l'organizzatore della chiamata è Presentazioni Google. Un oggetto contenente informazioni su Presentazioni.
Campi originali dei componenti aggiuntivi di Gmail
eventObject.messageMetadata.accessToken string
Obsoleto. Un token di accesso. Puoi utilizzarlo per attivare l'accesso ai dati utente utilizzando gli ambiti aggiuntivi dei componenti aggiuntivi di Gmail.

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

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

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

eventObject.clientPlatform string
Obsoleto. Indica la provenienza dell'evento (web, iOS o Android).

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

eventObject.formInput object
Obsoleto. Una mappa dei valori attuali di tutti i widget del modulo nella scheda, limitata a un valore per widget. Le chiavi sono gli ID stringa associati ai widget e i valori sono stringhe. L'oggetto evento offre formInput come praticità per quando devi leggere i dati da più widget con valori singolari previsti, come input di testo e sensori. Per i widget a più valori, come le caselle di controllo, puoi leggere ogni valore da formInputs.

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

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

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

eventObject.parameters object
Obsoleto. Una mappa di eventuali 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, cerca 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 UN M49.

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

eventObject.userLocale string
Deprecato e disattivato per impostazione predefinita. Il codice ISO 639 di due lettere per indicare la lingua dell'utente. Per maggiori dettagli, consulta Accesso alle impostazioni internazionali e al fuso orario dell'utente.

Per i componenti aggiuntivi di Google Workspace, cerca 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. Alcuni esempi sono: America/New_York, Europe/Vienna e Asia/Seoul. Per maggiori dettagli, consulta Accesso alle impostazioni internazionali e al fuso orario dell'utente.

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

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

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

Oggetto evento comune

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

Oltre agli attivatori di home page e contestuali, i componenti aggiuntivi creano e trasmettono gli oggetti evento alle funzioni di callback di azione quando l'utente interagisce con i widget. La funzione di callback del componente aggiuntivo può eseguire 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 oggetto oggetto 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 con un unico valore (ad esempio, una casella di testo): un elenco di stringhe (un solo elemento).

    Esempio: per un widget di immissione 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 multivalore con ID participants, 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 includono:
  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
commonEventObject.parameters object
Eventuali parametri aggiuntivi forniti a Action mediante Action.setParameters().
commonEventObject.userLocale string
Disattivata per impostazione predefinita. L'identificatore del paese e della regione associato all'utente nel formato ISO 639 del codice lingua-Codice ISO 3166 del paese/della regione. Ad esempio, en-US.

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

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

Input del selettore della data e dell'ora

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

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

Oggetto evento Calendar

L'oggetto evento Calendar è la parte dell'oggetto evento complessivo che contiene informazioni sul calendario e sugli 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 se e solo se sono presenti nell'evento di Calendar e il componente aggiuntivo imposta il campo addOns.calendar.currentEventAccess manifest su READ o READ_WRITE.

Oggetto evento Calendar
calendar.attendees[] list of attendee objects
Dati generati dagli utenti. Un elenco dei partecipanti all'evento nel calendario.
calendar.calendarId string
ID 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 altrimenti.
calendar.capabilities.canSeeAttendees boolean
Dati generati dagli utenti. true se il componente aggiuntivo può leggere l'elenco dei partecipanti all'evento; false altrimenti.
calendar.capabilities.canSeeConferenceData boolean
Dati generati dagli utenti. true se il componente aggiuntivo può leggere i dati sulla conferenza dell'evento; false altrimenti.
calendar.capabilities.canSetConferenceData boolean
Dati generati dagli utenti. true se il componente aggiuntivo può aggiornare i dati sulla conferenza dell'evento; false altrimenti.
calendar.capabilities.canAddAttachments boolean
Dati generati dagli utenti. true se il componente aggiuntivo può aggiungere nuovi allegati all'evento; false altrimenti.
calendar.conferenceData Conference data object
Dati generati dagli utenti. Un oggetto che rappresenta tutti i dati sulla 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
L'indirizzo email dell'organizzatore dell'evento.
calendar.recurringEventId string
ID di un evento ricorrente.

Partecipante

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

Oggetto partecipante
attendee.additionalGuests number
Il numero di ospiti aggiuntivi che il partecipante aveva indicato di portare. Il valore predefinito è zero.
attendee.comment string
eventuale commento di risposta dell'invitato.
attendee.displayName string
Il nome visualizzato dell'invitato.
attendee.email string
L'indirizzo email del partecipante.
attendee.optional boolean
true se la partecipazione per questo partecipante è contrassegnata come facoltativa; false in caso contrario.
attendee.organizer boolean
true se il partecipante è un organizzatore di questo evento.
attendee.resource boolean
true se il partecipante rappresenta una risorsa, ad esempio una stanza o un'attrezzatura; false altrimenti.
attendee.responseStatus string
Stato di risposta dell'invitato. I valori possibili includono:
  • 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 temporaneamente accettato l'invito all'evento.
attendee.self boolean
true se questo invitato rappresenta il calendario in cui compare questo evento; false in caso contrario.

Dati conferenza

Gli oggetti dati delle conferenze contengono informazioni sulle conferenze collegate agli eventi di Google Calendar. Possono essere soluzioni per conferenze di 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 devi mostrare questo ID agli utenti.
conferenceData.conferenceSolution object
Un oggetto che rappresenta la soluzione per conferenze, come 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 conferenze per questo evento.
conferenceData.conferenceSolution.key.type string
Il tipo di soluzione per conferenze. I valori possibili includono:
  • eventHangout per Hangouts per i consumatori (http://hangouts.google.com).
  • eventNamedHangout per gli utenti che utilizzano la versione classica di Hangouts per Google Workspace (http://hangouts.google.com).
  • hangoutsMeet per Google Meet (http://meet.google.com).
conferenceData.conferenceSolution.name string
Il nome visibile all'utente di questa soluzione per conferenze (non localizzata).
conferenceData.entryPoints[] list of entry point objects
L'elenco di punti di contatto della conferenza, come URL o numeri di telefono.
conferenceData.notes string
Note aggiuntive (ad esempio istruzioni fornite dall'amministratore di dominio o da note legali) sulla conferenza da mostrare all'utente. Può contenere HTML. La lunghezza massima è di 2048 caratteri.
conferenceData.parameters object
Un oggetto contenente una mappa dei dati dei parametri definiti utilizzati dal componente aggiuntivo.
conferenceData.parameters.addOnParameters object
Una mappa delle chiavi e dei valori delle stringhe di parametri. Le chiavi e i valori sono definiti dallo sviluppatore del componente aggiuntivo per allegare informazioni a una conferenza specifica per l'utilizzo del componente.

Punto di ingresso

Gli oggetti dei punti di contatto contengono informazioni sui mezzi stabiliti per accedere a una determinata conferenza, ad esempio tramite telefono o video. 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 punto di ingresso
entryPoint.accessCode string
Il codice di accesso utilizzato per accedere alla conferenza. La lunghezza massima è di 128 caratteri. In genere, i provider di conferenze utilizzano un sottoinsieme di {accessCode, meetingCode, passcode, password, pin} per fornire l'accesso alle conferenze. Corrispondenza e visualizzazione dei campi sempre utilizzati dal fornitore di servizi di conferenza.
entryPoint.entryPointFeatures list
Funzionalità del punto di contatto. Attualmente queste funzionalità si applicano solo ai punti di ingresso phone:
  • toll: il punto di accesso è una telefonata a pagamento.
  • toll_free: il punto di accesso è una telefonata al numero verde.
entryPoint.entryPointType string
Il tipo di punto di ingresso. I valori possibili sono i seguenti:
  • more: istruzioni aggiuntive per partecipare alle conferenze, ad esempio numeri di telefono alternativi. Una conferenza può avere un solo more punto di ingresso; se presente, è richiesto almeno un altro tipo di punto di ingresso.
  • phone: partecipa alla conferenza tramite un numero di telefono. Una conferenza può avere zero o più phone punti di ingresso. Google Calendar mostra solo i primi due punti di ingresso del telefono, dopo la formattazione e l'ordinamento in ordine alfabetico.
  • sip: partecipa alla conferenza tramite SIP. Una conferenza può avere al massimo sip punto di accesso.
  • video: partecipa alla conferenza tramite HTTP. Una conferenza può avere al massimo video punto di accesso.
entryPoint.label string
L'etichetta visibile all'utente per l'URI del punto di ingresso (non localizzato).
entryPoint.meetingCode string
Il codice riunione utilizzato per accedere alla conferenza. La lunghezza massima è di 128 caratteri. In genere, i provider di conferenze utilizzano un sottoinsieme di {accessCode, meetingCode, passcode, password, pin} per fornire l'accesso alle conferenze. Corrispondenza e visualizzazione dei campi sempre utilizzati dal fornitore di servizi di conferenza.
entryPoint.passcode string
Il passcode utilizzato per accedere alla conferenza. La lunghezza massima è di 128 caratteri. In genere, i provider di conferenze utilizzano un sottoinsieme di {accessCode, meetingCode, passcode, password, pin} per fornire l'accesso alle conferenze. Corrispondenza e visualizzazione dei campi sempre utilizzati dal fornitore di servizi di conferenza.
entryPoint.password string
La password usata per accedere alla conferenza. La lunghezza massima è di 128 caratteri. In genere, i provider di conferenze utilizzano un sottoinsieme di {accessCode, meetingCode, passcode, password, pin} per fornire l'accesso alle conferenze. Corrispondenza e visualizzazione dei campi sempre utilizzati dal fornitore di servizi di conferenza.
entryPoint.pin string
Il PIN utilizzato per accedere alla conferenza. La lunghezza massima è di 128 caratteri. In genere, i provider di conferenze utilizzano un sottoinsieme di {accessCode, meetingCode, passcode, password, pin} per fornire l'accesso alle conferenze. Corrispondenza e visualizzazione dei campi sempre utilizzati dal fornitore di servizi di conferenza.
entryPoint.regionCode string
Codice regione del numero di telefono. Necessario per gli utenti se l'URI non include un codice paese. I valori si basano sull' elenco CLDR pubblico dei codici a livello di regione.
entryPoint.uri string
L'URI del punto di contatto. La lunghezza massima è di 1300 caratteri. La formattazione dipende dal tipo di punto di accesso:
  • more: è obbligatorio uno schema http: o https:.
  • phone: è richiesto uno schema tel:. L'URI deve includere l'intera sequenza di composizione (ad esempio "tel:+12345678900,,,12345678;1234").
  • sip: è obbligatorio uno schema sip: o sips:. Ad esempio "sip:12345678@myprovider.com".
  • video: è obbligatorio uno schema http: o https:.

Oggetto evento Drive

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

Oggetto evento 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 di Drive contengono informazioni su elementi di Drive specifici, come file o cartelle.

Oggetto elemento Drive
item.addonHasFileScopePermission boolean
Se true, il componente aggiuntivo ha richiesto e ha ricevuto l'autorizzazione all'ambito di https://www.googleapis.com/auth/drive.file per questo elemento; altrimenti questo 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 solo in un oggetto evento se l'applicazione host è Gmail.

Oggetto evento Gmail
gmail.accessToken string
Il token di accesso specifico per Gmail. Puoi utilizzare questo token con il metodo GmailApp.setCurrentMessageAccessToken(accessToken) per concedere al componente aggiuntivo l'accesso temporaneo al messaggio di Gmail aperto dall'utente o consentire al componente aggiuntivo di scrivere nuove bozze.
gmail.bccRecipients[] list of strings
Disattivata per impostazione predefinita. L'elenco di indirizzi email dei 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 dei destinatari "CC:" 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.messageId string
ID del messaggio Gmail attualmente aperto.
gmail.threadId string
L'ID thread di Gmail attualmente aperto.
gmail.toRecipients[] list of strings
Disattivata per impostazione predefinita. L'elenco di indirizzi email dei 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 Documenti

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

Oggetto evento Documenti
docs.id string
Presenta 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
Presenta 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 ha ricevuto l'autorizzazione di ambito https://www.googleapis.com/auth/drive.file per il documento aperto nell'interfaccia utente di Documenti; in caso contrario, questo campo è false.
docs.matchedUrl.url string
Presente solo se vengono 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 maggiori dettagli, vedi Visualizzare l'anteprima dei link in Documenti Google.

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 Fogli

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

Oggetto evento Fogli
sheets.id string
Presente 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
Presente 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 ha ricevuto l'autorizzazione di ambito https://www.googleapis.com/auth/drive.file per il foglio di lavoro aperto nell'interfaccia utente di Fogli; in caso contrario, questo campo è false.

Oggetto evento Presentazioni

L'oggetto evento Presentazioni è la parte dell'oggetto evento complessivo che contiene 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
Presente solo se l'ambito https://www.googleapis.com/auth/drive.file è stato autorizzato dall'utente. L'ID della presentazione aperto nell'interfaccia utente di Presentazioni.
slides.title string
Presente 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 ha ricevuto l'autorizzazione all'ambito di https://www.googleapis.com/auth/drive.file per la presentazione aperta nell'interfaccia utente di Presentazioni, altrimenti questo campo è false.