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 come componente aggiuntivo. Gli oggetti evento contengono informazioni sul lato client sull'app host e il contesto 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. Ogni funzione homepageTrigger che definisci viene passato automaticamente un 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 si attiva l'attivazione della home page non contengono tutti i i campi inclusi negli altri due casi: campi relativi a widget le informazioni contestuali vengono omesse.

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

    Quando si attiva un attivatore contestuale, l'applicazione host chiama il valore runFunction corrispondente elencato nel manifest del componente aggiuntivo, passando un 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 interattività, utilizzando lo stesso modello di azione utilizzato dai componenti aggiuntivi di Gmail per gli utilizzi odierni. I componenti aggiuntivi di Google Workspace usano le stesse funzioni di gestore dei widget, Action oggetti e azione diverse. 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.

  • Attivatori dei link di anteprima: In Documenti, Fogli e Presentazioni Google puoi: configurare le anteprime dei link per i servizi di terze parti in base a pattern URL specifici. Quando gli utenti interagiscono con un link che soddisfa lo schema, linkPreviewTriggers si attiva e un oggetto evento che contiene il link viene passato al parametro di chiamata. 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 Oggetti evento dei componenti aggiuntivi di Google Workspace. L'evento che include un commonEventObject di primo livello 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 riportata di seguito in "Campi del componente aggiuntivo originale di Gmail". 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, a prescindere 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'organizzatore della chiamata è Google Drive. Un oggetto contenenti informazioni su Drive.
eventObject.gmail Gmail event object
Presente solo se l'host della chiamata è Gmail. Un oggetto contenenti informazioni di 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'organizzatore della chiamata è Fogli Google. Un oggetto contenenti le informazioni di Fogli.
eventObject.slides Slides event object
Presenta solo se l'organizzatore della chiamata è Presentazioni Google. Un oggetto contenenti informazioni su Presentazioni.
Campi aggiuntivi dei componenti aggiuntivi di Gmail originali
eventObject.messageMetadata.accessToken string
Deprecato. Un token di accesso. Puoi utilizzare questo per attivare l'accesso ai dati utente utilizzando gli 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
Deprecato. L'ID messaggio del thread si aprono nella UI di Gmail.

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

eventObject.clientPlatform string
Deprecato. Indica dove si trova l'evento (Web, iOS o Android).

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

eventObject.formInput object
Deprecato. Una mappa dei valori correnti di tutti i widget dei moduli nella scheda, limitati 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 un per poter leggere i dati di più widget con i valori singolari previsti, come input di testo e sensori. Per widget a più valori come le caselle di controllo, puoi leggere ogni valore formInputs in alternativa.

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

eventObject.formInputs object
Deprecato. Una mappa dei valori correnti di widget nella scheda, presentati come elenchi di stringhe. Le chiavi sono gli ID stringa associati al widget. Per i widget a valore singolo, viene presentato in un array composto da un singolo elemento Per widget a più valori ad esempio 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 stringhe.

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

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

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

eventObject.userLocale string
Deprecato e disattivato per impostazione predefinita. La due lettere ISO 639 che indica la lingua dell'utente. Consulta Accesso all'utente impostazioni internazionali e fuso orario per ulteriori dettagli.

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. La identificatore del fuso orario dell'utente. Ecco alcuni 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, puoi trovare queste informazioni nella sezione eventObject.commonEventObject.timeZone.id .

eventObject.userTimezone.offset string
Deprecato e disattivato per impostazione predefinita. La rispetto al fuso orario UTC (Coordinated Universal Time) del fuso orario dell'utente fuso orario, 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 del contesto, i componenti aggiuntivi costruiscono e trasmettono alle funzioni di callback di 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 che un utente ha inserito in una Widget TextInput nel eventObject.commentEventObject.formInputs oggetto.

Campi degli oggetti evento comuni
commonEventObject.platform string
Indica l'origine dell'evento ("WEB", "IOS" o "ANDROID").
commonEventObject.formInputs object
Una mappa contenente i valori correnti dell'elemento widget nella scheda visualizzata. Le chiavi mappa sono gli ID stringa assegnati con 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 per l'input di testo con employeeName come ID, accedi al testo valore di input 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 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: un DateInput object

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

  • A time-only picker: un TimeInput object

    Esempio: per un selettore con ID myTimePicker, accedi al l'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 file manifest del componente aggiuntivo. Anche l'elenco degli ambiti del componente aggiuntivo deve includi 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 fuso orario e offset. 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. Vedi Accesso alle impostazioni internazionali e al fuso orario dell'utente per ulteriori dettagli.
commonEventObject.timeZone.id string
Il . identificatore del fuso orario del fuso orario dell'utente. Ecco alcuni 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 degli ambiti del componente aggiuntivo deve includere anche https://www.googleapis.com/auth/script.locale. Consulta Accesso alle impostazioni internazionali e al fuso orario dell'utente per ulteriori dettagli.
commonEventObject.timeZone.offset string
Il . rispetto al fuso orario UTC (Coordinated Universal Time) della durata fuso orario, misurato in millisecondi. Consulta Accesso alle impostazioni internazionali e al fuso orario dell'utente per ulteriori dettagli.

Input del modulo del selettore di data e ora

Funzioni di callback delle azioni può ricevere i valori correnti del 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 seguente tabella:

Oggetto DateTimeInput
dateTimeInput.hasDate boolean
true se la data e l'ora di input include una data; se false è incluso solo un orario.
dateTimeInput.hasTime boolean
true se la data e l'ora di input include un orario; 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
Il tempo selezionato 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 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. È solo presente in un oggetto evento se l'applicazione host è Google Calendar.

La seguente tabella elenca i campi presenti nell'elemento calendarEventObject di un oggetto evento. I campi contrassegnati come Dati generati dagli utenti presenti nell'oggetto evento solo se i dati sono presenti nel calendario. e il componente aggiuntivo imposta i suoi 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 al calendario .
calendar.calendarId string
L'ID del 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 negli altri casi.
calendar.capabilities.canSeeAttendees boolean
Dati generati dagli utenti. true se il componente aggiuntivo è in grado di leggere l'elenco dei partecipanti all'evento; false negli altri casi.
calendar.capabilities.canSeeConferenceData boolean
Dati generati dagli utenti. true se il componente aggiuntivo può leggere i dati della conferenza dell'evento; false negli altri casi.
calendar.capabilities.canSetConferenceData boolean
Dati generati dagli utenti. true se il componente aggiuntivo può aggiornare i dati della conferenza dell'evento; false negli altri casi.
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 qualsiasi dato di conferenza associate 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
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 solo se i dati è presente nell'evento di Calendar e il componente aggiuntivo imposta 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
Stato della risposta del partecipante. Possibile includono i seguenti:
  • accepted: il partecipante ha accettato l'evento .
  • declined: il partecipante ha rifiutato l'evento .
  • needsAction: Il partecipante non ha risposto al invito all'evento.
  • tentative: Il partecipante ha accettato provvisoriamente il invito all'evento.
attendee.self boolean
true se questo partecipante rappresenta il calendario in cui appare l'evento; false negli altri casi.

Dati della conferenza

Gli oggetti dati conferenza contengono informazioni sulle conferenze collegate agli eventi di Google Calendar. Può trattarsi di soluzioni Google per conferenze, Google Meet o conferenze di terze parti. Queste informazioni sono presenti solo se i dati sono presenti nell'evento Calendar e il componente aggiuntivo imposta il proprio addOns.calendar.currentEventAccess manifest su READ o READ_WRITE.

Oggetto dati conferenza
conferenceData.conferenceId string
L'ID della conferenza. Questo ID indica consentire alle applicazioni di tenere traccia delle conferenze; non dovresti mostrare questo ID agli utenti.
conferenceData.conferenceSolution object
Un oggetto che rappresenta la conferenza come Hangouts o Google Meet.
conferenceData.conferenceSolution.iconUri string
L'URI dell'icona visibile all'utente che rappresenta di questa soluzione per conferenze.
conferenceData.conferenceSolution.key object
La chiave che identifica in modo univoco soluzione di videoconferenza per questo evento.
conferenceData.conferenceSolution.key.type string
Il tipo di soluzione per conferenze. Valori possibili include:
  • 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 di l'amministratore di dominio o le note legali) riguardo alla conferenza mostrare all'utente. Può contenere codice 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 delle chiavi e dei valori delle stringhe dei parametri. Queste chiavi e valori vengono definiti dallo sviluppatore del componente aggiuntivo da collegare informazioni a una conferenza specifica per l'utilizzo del componente aggiuntivo.

Punto di ingresso

Gli oggetti entry point contengono informazioni sui metodi stabiliti per l'accesso. durante 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 ingresso
entryPoint.accessCode string
Il codice di accesso 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.entryPointFeatures list
Funzionalità del punto di ingresso. Attualmente questi le 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.
entryPoint.entryPointType string
Il tipo di punto di ingresso. I valori possibili sono le seguenti:
  • 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 accesso 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. R La conferenza può avere al massimo un punto di ingresso 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. 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.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 ingresso. Il valore massimo è di 1300 caratteri. La formattazione dipende dal punto di ingresso tipo:
  • more: un http: o https: lo schema è obbligatorio.
  • phone: è obbligatorio uno schema tel:. La L'URI deve includere l'intera sequenza di composizione (ad esempio, "tel:+12345678900,,,12345678;1234").
  • sip: un sip: o sips: lo schema è obbligatorio. Ad esempio "sip:12345678@mioprovider.com".
  • video: un http: o https: lo schema è obbligatorio.

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

Oggetto elemento di Drive
item.addonHasFileScopePermission boolean
Se true, il componente aggiuntivo ha richiesto e ha ricevuto https://www.googleapis.com/auth/drive.file autorizzazione dell'ambito 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 per Gmail. Puoi utilizzare questo token con GmailApp.setCurrentMessageAccessToken(accessToken) per concedere al componente aggiuntivo l'accesso temporaneo all'account di un utente apri un messaggio di Gmail o lascia che il componente aggiuntivo componga nuove bozze.
gmail.bccRecipients[] list of strings
Disattivato per impostazione predefinita. Elenco di "Ccn:" gli indirizzi email dei destinatari attualmente inclusi in una bozza componente aggiuntivo in fase di scrittura. 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 valore addOns.gmail.composeTrigger.draftAccess nel file manifest per METADATA.
gmail.messageId string
L'ID del messaggio Gmail attualmente aperto.
gmail.threadId string
ID thread di Gmail attualmente aperto.
gmail.toRecipients[] list of strings
Disattivato 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 valore addOns.gmail.composeTrigger.draftAccess nel file manifest per 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 solo in 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 ha ricevuto https://www.googleapis.com/auth/drive.file autorizzazione dell'ambito per il documento aperto nell'interfaccia utente di Documenti; altrimenti questo è 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.
di Gemini Advanced.
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 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 trasporta informazioni sul documento di un utente e sui suoi contenuti. È presente solo in 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 ha ricevuto https://www.googleapis.com/auth/drive.file autorizzazione dell'ambito per il foglio di lavoro aperto nell'interfaccia utente di Fogli; altrimenti questo campo è false.
sheets.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.
di Gemini Advanced.
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 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 solo in 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 aperta in Presentazioni nell'interfaccia utente.
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 ha ricevuto https://www.googleapis.com/auth/drive.file autorizzazione dell'ambito per la presentazione aperta nell'interfaccia utente di Presentazioni; altrimenti questo campo è false.
slides.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.
di Gemini Advanced.
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"
  }
}