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:

    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
eventObject.commonEventObject Common fields object
Un oggetto contenente informazioni comuni a tutti gli oggetti evento, indipendentemente dall'applicazione host.
eventObject.calendar Calendar event object
Presente solo se l'organizzatore della chiamata è Google Calendar. Un oggetto contenenti informazioni su calendari ed eventi.
eventObject.drive Drive event object
Presente solo se l'host chiamante è Google Drive. Un oggetto contenenti informazioni su Drive.
eventObject.gmail Gmail event object
Presente solo se l'host chiamante è Gmail. Un oggetto contenente informazioni su Gmail.
eventObject.docs Docs event object
Presente solo se l'organizzatore che effettua la chiamata è Documenti Google. Un oggetto contenenti informazioni su Documenti.
eventObject.sheets Sheets event object
Presente solo se l'host chiamante è Fogli Google. Un oggetto contenenti le informazioni di Fogli.
eventObject.slides Slides event object
Presente solo se l'organizzatore della chiamata è Presentazioni Google. Un oggetto contenente informazioni su Presentazioni.
Campi aggiuntivi dei componenti aggiuntivi di Gmail originali
eventObject.messageMetadata.accessToken string
Deprecato. 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, puoi trovare queste informazioni nella sezione eventObject.gmail.accessToken .

eventObject.messageMetadata.messageId string
Ritiro previsto. 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
Ritiro previsto. Indica la piattaforma di 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
Deprecato. Una mappa dei valori correnti di tutti i widget di modulo nella scheda, limitata a un valore per widget. La le chiavi sono gli ID stringa associati ai widget, mentre i valori stringhe. L'oggetto evento fornisce formInput come comodità quando devi leggere i dati da più widget con valori singolari previsti, come input di testo e pulsanti. Per widget a più valori come le caselle di controllo, puoi leggere ogni valore formInputs in alternativa.

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

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

Per i componenti aggiuntivi di Google Workspace, puoi trovare queste informazioni nella sezione eventObject.commonEventObject.formInputs .

eventObject.parameters object
Deprecato. Una mappa di eventuali i parametri che fornisci ai clienti Action con Action.setParameters(). Le chiavi e i valori della mappa sono stringhe.

Per i componenti aggiuntivi di Google Workspace, puoi trovare queste informazioni nella sezione eventObject.commonEventObject.parameters .

eventObject.userCountry string
Deprecato e disabilitato 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 disabilitato per impostazione predefinita. La due lettere ISO 639 che indica la lingua dell'utente. Per ulteriori dettagli, consulta Accedere alle impostazioni di lingua e fuso orario dell'utente.

Per i componenti aggiuntivi di Google Workspace, puoi trovare queste informazioni nella sezione 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. Consulta: Accesso alle impostazioni internazionali e al fuso orario dell'utente per ulteriori dettagli.

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

eventObject.userTimezone.offset string
Deprecato e disabilitato per impostazione predefinita. L'offset in ore rispetto al tempo universale coordinato (UTC) del fuso orario dell'utente, misurato in millisecondi. Consulta: Accesso alle impostazioni internazionali e al fuso orario dell'utente per ulteriori dettagli.

Per i componenti aggiuntivi di Google Workspace, puoi trovare queste informazioni nella sezione 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 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.

Campi degli oggetti evento comuni
commonEventObject.platform string
Indica la piattaforma da cui ha avuto origine l'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 ciascun 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 ID employeeName, accedi al valore di input di testo con: e.commonEventObject.formInputs.employeeName.stringInputs.value[0]

  • Widget con più valori (ad es. gruppi di caselle di controllo): un elenco di stringhe.

    Esempio: per un widget multivalore con participants come ID, accedi al valore array con: e.commonEventObject.formInputs.participants.stringInputs.value.

  • A date-time picker: un DateTimeInput object

    Esempio: per un selettore con ID myDTPicker, accedi al Oggetto DateTimeInput utilizzando e.commonEventObject.formInputs.myDTPicker.dateTimeInput.

  • A date-only picker: a DateInput object.

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

  • A time-only picker: a 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 seguenti:
  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
commonEventObject.parameters object
Eventuali parametri aggiuntivi che che viene fornito a Action utilizzando Action.setParameters().
commonEventObject.userLocale string
Disattivato per impostazione predefinita. La lingua dell'utente e l'identificatore del paese/della regione nel formato ISO 639 codice lingua-ISO 3166 del tuo paese/regione. Ad esempio, en-US.

Per attivare questo campo, devi impostare addOns.common.useLocaleFromApp su true nel manifest del componente aggiuntivo. L'elenco dell'ambito del componente aggiuntivo deve includere anche https://www.googleapis.com/auth/script.locale. Vedi Accesso alle impostazioni internazionali e al fuso orario dell'utente per ulteriori dettagli.

commonEventObject.timeZone string
Disattivato per impostazione predefinita. L'ID e la compensazione del fuso orario. Per attivare questo campo, devi impostare Da addOns.common.useLocaleFromApp a 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 ulteriori dettagli, consulta Accedere alle impostazioni internazionali e al fuso orario dell'utente.
commonEventObject.timeZone.id string
Il identificatore del fuso orario del fuso orario dell'utente. Esempi: America/New_York, Europe/Vienna e Asia/Seoul. Per attivare questo campo, devi impostare Da addOns.common.useLocaleFromApp a true nel file manifest del componente aggiuntivo. L'elenco dell'ambito del componente aggiuntivo deve includere anche https://www.googleapis.com/auth/script.locale. Per ulteriori dettagli, consulta Accedere alle impostazioni internazionali e al fuso orario dell'utente.
commonEventObject.timeZone.offset string
L' offset dal tempo universale coordinato (UTC) del fuso orario dell'utente, misurato in millisecondi. Consulta: Accesso alle impostazioni internazionali e al fuso orario dell'utente per ulteriori dettagli.

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 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
Il tempo selezionato dall'utente, in millisecondi dall'epoca (00:00:00 UTC il 1° gennaio 1970).
Oggetto DateInput
dateInput.msSinceEpoch string
L'ora selezionata dall'utente, in millisecondi dall'epoca (00:00:00 UTC del 1° gennaio 1970).
Oggetto TimeInput
timeInput.hours number
Il numero dell'ora selezionata 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 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.

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 calendario.
calendar.capabilities object
Dati generati dagli utenti. Un oggetto che descrive le capacità del componente aggiuntivo di visualizzare o aggiornare l'evento informazioni.
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 altrimenti.
calendar.capabilities.canSetConferenceData boolean
Dati generati dagli utenti. true se il componente aggiuntivo può aggiornare i dati della 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 negli altri casi.
calendar.conferenceData Conference data object
Dati generati dagli utenti. Un oggetto che rappresenta i dati della conferenza associati a questo evento, ad esempio i dettagli della conferenza di Google Meet.
calendar.id string
L'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
L'ID di un evento ricorrente.

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.

Oggetto partecipante
attendee.additionalGuests number
Il numero di ospiti aggiuntivi che il partecipante ha ricevuto indicato che stanno portando. Il valore predefinito è zero.
attendee.comment string
L'eventuale commento della risposta del partecipante.
attendee.displayName string
Nome visualizzato del partecipante.
attendee.email string
L'indirizzo email del partecipante.
attendee.optional boolean
true se la partecipazione a questo evento il partecipante sia contrassegnato come facoltativo; false negli altri casi.
attendee.organizer boolean
true se il partecipante è un organizzatore di questo evento.
attendee.resource boolean
true se il partecipante rappresenta un risorse, come una stanza o un'attrezzatura; false negli altri casi.
attendee.responseStatus string
Lo stato della risposta del partecipante. Possibile includono i seguenti:
  • 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 il partecipante rappresenta il calendario in cui viene visualizzato questo evento; false in caso contrario.

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.

Oggetto dati conferenza
conferenceData.conferenceId string
L'ID della conferenza. Questo ID è pensato per consentire alle applicazioni di tenere traccia delle conferenze. Non devi mostrarlo agli utenti.
conferenceData.conferenceSolution object
Un oggetto che rappresenta la soluzione per le conferenze, ad esempio Hangouts o Google Meet.
conferenceData.conferenceSolution.iconUri string
L'URI dell'icona visibile all'utente che rappresenta questa soluzione per le conferenze.
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 conferenze. I valori possibili includono quanto segue:
  • eventHangout per Hangouts per i consumatori (http://hangouts.google.com).
  • eventNamedHangout per la versione classica di Hangouts per Utenti di 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 conferenza soluzione (non localizzata).
conferenceData.entryPoints[] list of entry point objects
L'elenco dei punti di accesso alla conferenza, ad esempio URL o numeri di telefono.
conferenceData.notes string
Note aggiuntive (ad esempio istruzioni dell'amministratore del dominio o notifiche legali) sulla conferenza da mostrare all'utente. Può contenere HTML. La lunghezza massima è 2048 caratteri.
conferenceData.parameters object
Un oggetto contenente una mappa di per l'utilizzo da parte del componente aggiuntivo.
conferenceData.parameters.addOnParameters object
Una mappa di chiavi e valori di stringhe di parametri. Queste chiavi e questi valori vengono definiti dallo sviluppatore del componente aggiuntivo per associare informazioni a una conferenza specifica per l'utilizzo del componente aggiuntivo.

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 punto di contatto
entryPoint.accessCode string
Il codice di accesso utilizzato per accedere alla conferenza. La lunghezza massima è di 128 caratteri. I fornitori di conferenze solitamente utilizzano solo un sottoinsieme di {accessCode, meetingCode, passcode, password, pin} per fornire accesso alle conferenze. Crea corrispondenze e visualizza solo i campi utilizzato dal fornitore del servizio di conferenza.
entryPoint.entryPointFeatures list
Funzionalità dell'entry point. Al momento queste funzionalità si applicano solo ai punti di contatto phone:
  • toll: il punto di contatto è una chiamata a pagamento.
  • toll_free: il punto di accesso è una telefonata.
entryPoint.entryPointType string
Il tipo di punto di accesso. I valori possibili sono:
  • more: istruzioni aggiuntive per partecipare alla conferenza, ad esempio numeri di telefono alternativi. Una conferenza può avere un solo Punto di ingresso di more; se presente almeno un altro tipo del punto di ingresso.
  • phone: partecipa alla conferenza tramite un numero di telefono. R La conferenza può avere zero o più punti di ingresso phone. Google Calendar mostra solo i primi due punti di contatto telefonico, dopo averli formattati e ordinati 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 contatto video.
entryPoint.label string
L'etichetta visibile dall'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 fornitori di conferenze utilizza solo un sottoinsieme di {accessCode, meetingCode, passcode, password, pin} per offrono l'accesso alle conferenze. Crea corrispondenze e visualizza solo i campi utilizzato dal fornitore del servizio di conferenza.
entryPoint.passcode string
Il passcode utilizzato per accedere alla conferenza. La lunghezza massima è di 128 caratteri. I fornitori di conferenze solitamente utilizzano solo un sottoinsieme di {accessCode, meetingCode, passcode, password, pin} per fornire accesso alle conferenze. Corrispondere e mostrare solo i campi utilizzati dal fornitore della conferenza.
entryPoint.password string
La password utilizzata per accedere alla conferenza. La lunghezza massima è di 128 caratteri. In genere i fornitori di conferenze utilizza solo un sottoinsieme di {accessCode, meetingCode, passcode, password, pin} per offrono l'accesso alle conferenze. Crea corrispondenze e visualizza solo i campi utilizzato dal fornitore del servizio di conferenza.
entryPoint.pin string
Il PIN utilizzato per accedere alla conferenza. La lunghezza massima è di 128 caratteri. In genere i fornitori di conferenze utilizza solo un sottoinsieme di {accessCode, meetingCode, passcode, password, pin} per offrono l'accesso alle conferenze. Crea corrispondenze e visualizza solo i campi utilizzato dal fornitore del servizio di conferenza.
entryPoint.regionCode string
Codice regione del numero di telefono. Richiesta da utenti se l'URI non include un codice paese. I valori si basano su il pubblico Elenco CLDR dei codici regione.
entryPoint.uri string
L'URI del punto di accesso. La lunghezza massima è di 1300 caratteri. La formattazione dipende dal punto di ingresso tipo:
  • more: un http: o https: lo schema è obbligatorio.
  • phone: è richiesto uno schema tel:. L'URI deve includere l'intera sequenza di tasti (ad esempio, "tel:+12345678900,,,12345678;1234").
  • sip: è obbligatorio uno schema sip: o sips:. Ad esempio, "sip:12345678@mioprovider.com".
  • video: è obbligatorio uno schema http: o https:.

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.

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 elemento di Drive contengono informazioni su elementi di Drive specifici, ad esempio file o cartelle.

Oggetto elemento Drive
item.addonHasFileScopePermission boolean
Se true, il componente aggiuntivo ha richiesto e ricevuto l'autorizzazione di ambito https://www.googleapis.com/auth/drive.file per questo elemento; altrimenti questo campo è false.
item.id string
L'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 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 Gmail
gmail.accessToken string
Il token di accesso specifico di Gmail. Puoi utilizzare questo token con il metodo GmailApp.setCurrentMessageAccessToken(accessToken) per concedere al tuo componente aggiuntivo l'accesso temporaneo al messaggio di Gmail attualmente aperto di un utente o consentire al componente aggiuntivo di scrivere nuove bozze.
gmail.bccRecipients[] list of strings
Disattivata per impostazione predefinita. L'elenco degli indirizzi email dei destinatari "Ccn" attualmente inclusi in una bozza in fase di composizione del componente aggiuntivo. Per attivare questo campo, devi impostare il valore addOns.gmail.composeTrigger.draftAccess nel file manifest per METADATA.
gmail.ccRecipients[] list of strings
Disattivato per impostazione predefinita. Elenco di "Cc:" gli indirizzi email dei destinatari attualmente inclusi in una bozza componente aggiuntivo in fase di scrittura. Per attivare questo campo, devi impostare il campo addOns.gmail.composeTrigger.draftAccess nel manifest su METADATA.
gmail.messageId string
L'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. Elenco di "A:" gli indirizzi email dei destinatari attualmente inclusi in una bozza componente aggiuntivo in fase di scrittura. Per attivare questo campo, devi impostare il campo addOns.gmail.composeTrigger.draftAccess nel manifest su METADATA.

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.

Oggetto evento 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 aperto nell'interfaccia utente di Documenti.
docs.addonHasFileScopePermission boolean
Se true, il componente aggiuntivo ha richiesto e ricevuto l'autorizzazione di 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
Presente solo se vengono soddisfatte le seguenti condizioni:
  • L'utente ha autorizzato https://www.googleapis.com/auth/workspace.linkpreview.
  • 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 componente aggiuntivo. Per ulteriori dettagli, consulta la sezione 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 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.

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 in Fogli nell'interfaccia utente.
sheets.addonHasFileScopePermission boolean
Se true, il componente aggiuntivo ha richiesto e ricevuto l'autorizzazione di ambito https://www.googleapis.com/auth/drive.file per il foglio di lavoro aperto nell'interfaccia utente di Fogli; altrimenti questo campo è false.
sheets.matchedUrl.url string
Presente solo se sono soddisfatte le seguenti condizioni:
  • L'utente ha autorizzato https://www.googleapis.com/auth/workspace.linkpreview.
  • 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 componente aggiuntivo. Per ulteriori dettagli, consulta la sezione Visualizzare l'anteprima dei link con smart chip.

Payload di esempio 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 di Presentazioni
slides.id string
Presente solo se l'ambito https://www.googleapis.com/auth/drive.file è stato autorizzato dall'utente. L'ID della presentazione aperta nell'UI 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 aperta nel UI di Presentazioni.
slides.addonHasFileScopePermission boolean
Se true, il componente aggiuntivo ha richiesto e ricevuto l'autorizzazione di ambito https://www.googleapis.com/auth/drive.file per la presentazione aperta nell'interfaccia utente di Presentazioni; altrimenti questo campo è false.
slides.matchedUrl.url string
Presente solo se sono soddisfatte le seguenti condizioni:
  • L'utente ha autorizzato https://www.googleapis.com/auth/workspace.linkpreview.
  • 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 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"
  }
}