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 alle funzioni di attivazione o di callback quando un utente interagisce con un componente aggiuntivo. Gli oggetti evento trasmettono informazioni lato client sull'app host e sul contesto corrente alla funzione di callback lato server del componente aggiuntivo.

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

  • Trigger della home page. A ogni funzione homepageTrigger definita viene passato automaticamente un oggetto evento quando viene attivata la funzione di attivatore 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 vengono attivati i trigger della home page non contengono tutti i campi inclusi negli altri casi; i campi relativi ai widget e alle informazioni contestuali vengono omessi.

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

    Quando viene attivato un trigger contestuale, l'applicazione in hosting chiama il runFunction corrispondente elencato nel manifest del componente aggiuntivo, passandogli un oggetto evento come parametro. Gli oggetti evento creati quando vengono attivati i trigger contestuali contengono tutti i campi inclusi negli oggetti evento trigger della home page, oltre ai campi contenenti informazioni contestuali.

  • Azioni widget. Gli oggetti evento forniscono 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 dei widget, gli stessi oggetti Action e le stesse risposte alle azioni. Nei componenti aggiuntivi di Google Workspace, gli oggetti evento di azione includono ulteriori informazioni su cui una funzione di callback può agire.

    Gli oggetti evento creati dalle azioni dei widget contengono tutti i campi inclusi negli oggetti evento dei trigger contestuali, oltre ai campi contenenti informazioni sui widget.

  • Attivatori di 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 di URL specifici. Quando gli utenti interagiscono con un link che corrisponde al pattern, viene attivato linkPreviewTriggers e un oggetto evento contenente il link viene passato alla funzione di callback dell'attivatore. Il componente aggiuntivo può utilizzare questo oggetto evento per creare uno smart chip e una scheda che mostrano informazioni sul link all'interno dell'applicazione in hosting. Puoi anche creare azioni dei widget in modo che gli utenti possano interagire con la scheda di anteprima e i relativi contenuti.

  • Trigger dell'app Google Chat. In Google Chat, il tuo componente aggiuntivo viene visualizzato dagli utenti come un'app di Chat, con cui possono interagire aggiungendola agli spazi, inviando messaggi, utilizzando i comandi slash e altro ancora. Per creare funzionalità interattive, devi configurare e utilizzare vari trigger dell'app di Chat. Ogni trigger invia un payload dell'oggetto evento diverso che ti aiuta a elaborare o rispondere a ogni tipo di interazione.

Struttura dell'oggetto evento

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

Per la compatibilità con le versioni precedenti, gli oggetti evento dei componenti aggiuntivi di Google Workspace includono i campi originali utilizzati negli oggetti evento di azione dei componenti aggiuntivi di Gmail. Questi campi si trovano in "Campi del componente aggiuntivo Gmail originale" e non fanno parte di commonEventObject.

I campi originali del componente aggiuntivo di Gmail sono deprecati. Quando sviluppi o esegui la migrazione di un componente aggiuntivo di Google Workspace, utilizza invece la nuova struttura dell'oggetto evento. Questi campi potrebbero essere rimossi in un aggiornamento futuro.

Oggetto Event
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'host chiamante è Google Calendar. Un oggetto contenente informazioni su calendari ed eventi.
eventObject.chat Chat event object
Presente solo se l'host della chiamata è Google Chat. Un oggetto contenente informazioni sulla chat.
eventObject.drive Drive event object
Presente solo se l'host chiamante è Google Drive. Un oggetto contenente informazioni su Drive.
eventObject.gmail Gmail event object
Presente solo se l'host chiamante è Gmail. Un oggetto contenente informazioni di Gmail.
eventObject.docs Docs event object
Presente solo se l'host chiamante è Documenti Google. Un oggetto contenente informazioni su Documenti.
eventObject.sheets Sheets event object
Presente solo se l'host chiamante è Fogli Google. Un oggetto contenente informazioni su Fogli.
eventObject.slides Slides event object
Presente solo se l'host chiamante è Presentazioni Google. Un oggetto contenente informazioni sulle slide.
Campi del componente aggiuntivo di Gmail originale
eventObject.messageMetadata.accessToken string
Deprecato. Un token di accesso. Puoi utilizzarlo per attivare l'accesso ai dati utente utilizzando gli ambiti temporanei dei componenti aggiuntivi di Gmail.

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

eventObject.messageMetadata.messageId string
Deprecato. L'ID messaggio del thread aperto nella UI di Gmail.

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

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

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

eventObject.formInput object
Deprecato. Una mappa dei valori correnti 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 fornisce formInput per comodità quando devi leggere i dati da più widget con valori singoli previsti, come input di testo e switch. Per i widget con più valori, come le caselle di controllo, leggi ogni valore da formInputs.

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

eventObject.formInputs object
Deprecato. 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 a valore singolo, il valore viene presentato in un array a un solo elemento. 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, queste informazioni sono disponibili nel campo eventObject.commonEventObject.formInputs.

eventObject.parameters object
Deprecato. 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, queste informazioni sono disponibili 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 numerico.

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

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

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

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

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

eventObject.userTimezone.offset string
Deprecato e disattivato per impostazione predefinita. L' offset temporale rispetto al tempo universale coordinato (UTC) del fuso orario dell'utente, misurato in millisecondi. Per ulteriori dettagli, consulta la sezione Accesso alle impostazioni internazionali e al fuso orario dell'utente.

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

Oggetto evento comune

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

Oltre ai trigger della home page e contestuali, i componenti aggiuntivi creano e passano oggetti evento alle funzioni di callback delle azioni 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 dell'oggetto evento comune
commonEventObject.platform string
Indica l'origine dell'evento (`WEB`, `IOS` o `ANDROID`).
commonEventObject.formInputs object
Una mappa contenente i valori attuali dei widget nella scheda visualizzata. Le chiavi della mappa sono gli ID stringa assegnati a ogni widget.

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

  • Widget con un singolo 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 immissione di testo con: e.commonEventObject.formInputs.employeeName.stringInputs.value[0]

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

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

  • A date-time picker: un DateTimeInput object.

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

  • A date-only picker: un DateInput object.

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

  • A time-only picker: un TimeInput object.

    Esempio: per un selettore con un 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 quanto segue:
  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
commonEventObject.parameters object
Eventuali parametri aggiuntivi che fornisci a un'azione utilizzando actionParameters o Action.setParameters.

Anteprima per gli sviluppatori : per le app Google Chat, per suggerire elementi in base a ciò che gli utenti digitano nei menu a selezione multipla, utilizza il valore della chiave "autocomplete_widget_query" (event.commonEventObject.parameters["autocomplete_widget_query"]). Puoi utilizzare questo valore per eseguire query su un database e suggerire elementi selezionabili agli utenti mentre digitano. Per maggiori dettagli, consulta Raccogli ed elabora le informazioni degli utenti di Google Chat.
commonEventObject.userLocale string
Disabilitata per impostazione predefinita. L'identificatore della lingua e del paese/della regione dell'utente nel formato del codice lingua ISO 639-codice paese/regione ISO 3166. Ad esempio, en-US.

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

commonEventObject.timeZone string
Disabilitata per impostazione predefinita. L'ID e l'offset del fuso orario. Per attivare questo campo, devi impostare addOns.common.useLocaleFromApp su true nel manifest del componente aggiuntivo. L'elenco degli ambiti del componente aggiuntivo deve includere anche https://www.googleapis.com/auth/script.locale. Per maggiori dettagli, consulta Accesso alle impostazioni internazionali e al fuso orario dell'utente.
commonEventObject.timeZone.id string
L' identificatore del fuso orario dell'utente. Esempi: America/New_York, Europe/Vienna e Asia/Seoul. Per attivare questo campo, devi impostare addOns.common.useLocaleFromApp su true nel 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 la sezione Accesso alle impostazioni internazionali e al fuso orario dell'utente.
commonEventObject.timeZone.offset string
L' offset temporale rispetto al fuso orario UTC (Coordinated Universal Time) dell'utente, misurato in millisecondi. Per ulteriori dettagli, consulta la sezione Accesso alle impostazioni internazionali e al fuso orario dell'utente.

Input del modulo del selettore di data e ora

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

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
L'ora selezionata dall'utente, in millisecondi dall'epoca (00:00:00 UTC del 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 selezionato dall'utente.
timeInput.minutes number
Il numero di minuti selezionato dall'utente.

Oggetto evento di Chat

L'oggetto evento di Chat è la parte dell'oggetto evento complessivo che contiene informazioni sulle interazioni di un utente con un'app di Chat. È presente in un oggetto evento solo se il componente aggiuntivo estende Google Chat.

Chat
chat.user object (User)
L'utente di Chat che ha interagito con l'app Chat.
chat.space object (Space)
Lo spazio di Chat in cui un utente ha interagito con l'app Chat.
chat.eventTime

string (Timestamp format)

L'ora in cui si è verificata l'interazione.

Campo unione payload. Per un trigger App Home (quando un utente apre la scheda Home), payload non è impostato e chat contiene chat.user e chat.eventTime.

payload può essere solo uno dei seguenti tipi:
chat.messagePayload

object (MessagePayload)

Il payload che le app di Chat ricevono da un trigger Messaggio.
chat.addedToSpacePayload

object (AddedToSpacePayload)

Il payload che le app di Chat ricevono da un trigger Aggiunta allo spazio.
chat.removedFromSpacePayload

object (RemovedFromSpacePayload)

Il payload che le app di Chat ricevono da un trigger Rimosso dallo spazio.
chat.buttonClickedPayload

object (ButtonClickedPayload)

Il payload che le app di Chat ricevono quando gli utenti fanno clic su un pulsante di un messaggio o di una scheda. Se un utente fa clic su un pulsante per inviare informazioni, l'oggetto commonEventObject.formInputs contiene i valori raccolti dall'utente. Per maggiori dettagli, consulta Raccogliere informazioni dagli utenti di Google Chat.
chat.widgetUpdatedPayload

object (WidgetUpdatedPayload)

Il payload che le app di Chat ricevono quando gli utenti digitano testo nel menu di selezione multipla di un widget selectionInput. Le app di Chat possono utilizzare questo oggetto evento per compilare gli elementi suggeriti da un'origine dati dinamica. Ad esempio, per compilare le richieste di assistenza da un'origine dati esterna, un'app di Chat può eseguire query sull'origine dati in base a ciò che l'utente digita nel menu, quindi restituire le richieste di assistenza corrispondenti come elementi selezionabili.

L'oggetto CommonEventObject.parameters['autocomplete_widget_query'] contiene il valore stringa digitato dall'utente nel menu.

chat.appCommandPayload

object (AppCommandPayload)

Il payload che le app di Chat ricevono quando un utente utilizza un comando dell'app di Chat.

Payload

A seconda del tipo di interazione con l'app di Chat, l'evento contiene un payload con una o più risorse dell'API Chat.

Payload del messaggio
MessagePayload
chat.messagePayload.message object (Message)
Il messaggio chat che ha attivato l'evento.
chat.messagePayload.space object (Space)
Lo spazio di Chat in cui un utente ha inviato il messaggio che ha richiamato l'app di Chat.
chat.messagePayload.configCompleteRedirectUri string
L'URL a cui l'app di Chat deve reindirizzare l'utente dopo che ha completato un flusso di autorizzazione o configurazione al di fuori di Google Chat. Per saperne di più, consulta Collegare il componente aggiuntivo di Google Workspace a un servizio di terze parti.
Payload di aggiunta allo spazio
AddedToSpacePayload
chat.addedToSpacePayload.space object (Space)
Lo spazio di Chat in cui l'utente ha aggiunto o installato l'app di Chat.

Quando gli amministratori installano le app di Chat, il campo space.adminInstalled viene impostato su true.

chat.addedToSpacePayload.interactionAdd boolean
Indica se un utente aggiunge l'app Chat a uno spazio utilizzando un messaggio. Ad esempio, @menziona l'app Chat o utilizza un comando. Se true, Chat invia un altro oggetto evento con un messagePayload che contiene informazioni sul messaggio.
chat.addedToSpacePayload.configCompleteRedirectUri string
L'URL a cui l'app di Chat deve reindirizzare l'utente dopo che ha completato un flusso di autorizzazione o configurazione al di fuori di Google Chat. Per saperne di più, consulta Collegare il componente aggiuntivo di Google Workspace a un servizio di terze parti.
Payload di rimozione dallo spazio
RemovedFromSpacePayload
chat.removedFromSpacePayload.space object (Space)
Lo spazio di Chat da cui l'utente ha rimosso o disinstallato l'app Chat.

Quando gli amministratori disinstallano le app di Chat, il campo space.adminInstalled viene impostato su false.

Payload del pulsante selezionato
ButtonClickedPayload
chat.buttonClickedPayload.message object (Message)
Il messaggio chat che contiene il pulsante su cui un utente ha fatto clic.
chat.buttonClickedPayload.space object (Space)
Lo spazio di Chat in cui l'utente ha fatto clic su un pulsante di un messaggio dell'app Chat.
chat.buttonClickedPayload.isDialogEvent boolean
Indica se l'utente ha fatto clic sul pulsante per interagire con una finestra di dialogo.
chat.buttonClickedPayload.dialogEventType enum (DialogEventType)
Se isDialogEvent è true, il tipo di interazione in una finestra di dialogo.

Enum DialogEventType.

Il valore di dialogEventType può essere solo uno dei seguenti:
TYPE_UNSPECIFIED Valore predefinito. Non specificato.
REQUEST_DIALOG Un utente richiede una finestra di dialogo. Ad esempio, utilizza un comando o fa clic su un pulsante di un messaggio.
SUBMIT_DIALOG Un utente fa clic su un elemento interattivo all'interno di una finestra di dialogo. Ad esempio, un utente compila le informazioni in una finestra di dialogo e fa clic su un pulsante per inviarle.
Payload aggiornato del widget
WidgetUpdatedPayload
chat.widgetUpdatedPayload.space object (Space)
Lo spazio di Chat in cui è avvenuta l'interazione.
Payload del comando dell'app
AppCommandPayload
chat.appCommandPayload.appCommandMetadata object (AppCommandMetadata)
Metadati relativi al comando utilizzato dall'utente e al modo in cui lo ha attivato.
chat.appCommandPayload.space object (Space)
Lo spazio di Chat in cui un utente ha utilizzato il comando.
chat.appCommandPayload.thread object (Thread)
Se l'interazione è avvenuta in un thread, il thread di Chat in cui l'utente ha utilizzato il comando.
chat.appCommandPayload.message object (Message)
Per i comandi slash, il messaggio con il comando slash.
chat.appCommandPayload.configCompleteRedirectUri string
Se per il comando è richiesta l'autorizzazione o la configurazione, un URL a cui reindirizzare l'utente dopo aver completato la procedura al di fuori di Google Chat.
chat.appCommandPayload.isDialogEvent boolean
Indica se il comando apre una finestra di dialogo.
chat.appCommandPayload.dialogEventType enum (DialogEventType)
Il tipo di interazione con una finestra di dialogo.

Enum DialogEventType.

Il valore di dialogEventType può essere solo uno dei seguenti:
TYPE_UNSPECIFIED Valore predefinito. Non specificato.
REQUEST_DIALOG Un utente richiede una finestra di dialogo. Ad esempio, utilizza un comando o fa clic su un pulsante di un messaggio.
SUBMIT_DIALOG Un utente fa clic su un elemento interattivo all'interno di una finestra di dialogo. Ad esempio, un utente compila le informazioni in una finestra di dialogo e fa clic su un pulsante per inviarle.
Metadati dei comandi delle app
AppCommandMetadata
chat.appCommandPayload.appCommandMetadata.appCommandId

string (int64 format)

L'ID comando.
chat.appCommandPayload.appCommandMetadata.appCommandType enum (AppCommandType)
Il tipo di comando.

Enum AppCommandType.

Il valore di AppCommandType può essere solo uno dei seguenti:
APP_COMMAND_TYPE_UNSPECIFIED Valore predefinito. Non specificato.
SLASH_COMMAND Un utente utilizza il comando inviando un messaggio che inizia con una barra /.
QUICK_COMMAND L'utente seleziona il comando dal menu di Chat nell'area di risposta ai messaggi.

Oggetto evento nel calendario

L'oggetto evento di Calendar è la parte dell'oggetto evento complessivo che contiene informazioni sul calendario e sugli eventi nel calendario di un utente. È presente in un oggetto evento solo se il componente aggiuntivo estende Google Calendar.

La tabella seguente 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 i dati sono presenti nell'evento nel calendario e il componente aggiuntivo imposta il campo addOns.calendar.currentEventAccess manifest su READ o READ_WRITE.

Per molti dei campi di questo oggetto e delle relative sottostrutture, esiste una mappatura diretta ai campi della risorsa Evento dell'API Calendar con lo stesso nome. Se le descrizioni dei campi sono diverse, le informazioni nella tabella seguente sono corrette.

Oggetto evento nel 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 funzionalità del componente aggiuntivo per visualizzare o aggiornare le informazioni sugli eventi.
calendar.capabilities.canAddAttendees boolean
Dati generati dagli utenti. true se il componente aggiuntivo può aggiungere nuovi partecipanti all'elenco dei partecipanti all'evento; false in caso contrario.
calendar.capabilities.canSeeAttendees boolean
Dati generati dagli utenti. true se il componente aggiuntivo può leggere l'elenco dei partecipanti all'evento; false altrimenti.
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 in caso contrario.
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 Attendee contengono informazioni sui singoli partecipanti agli eventi di Google Calendar. Queste informazioni sono presenti nell'oggetto evento se e solo se i dati sono presenti nell'evento nel calendario e il componente aggiuntivo imposta il campo addOns.calendar.currentEventAccess manifest su READ o READ_WRITE.

Oggetto Attendee
attendee.additionalGuests number
Il numero di ospiti aggiuntivi che il partecipante ha indicato di portare. Il valore predefinito è zero.
attendee.comment string
Il commento di risposta del partecipante, se presente.
attendee.displayName string
Il nome visualizzato del partecipante.
attendee.email string
L'indirizzo email del partecipante.
attendee.optional boolean
true se la presenza di 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
Lo stato della risposta del partecipante. 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 accettato provvisoriamente l'invito all'evento.
attendee.self boolean
true se questo partecipante rappresenta il calendario in cui viene visualizzato questo evento; false in caso contrario.

Dati della conferenza

Gli oggetti dati della conferenza contengono informazioni sulle conferenze allegate agli eventi di Google Calendar. Può trattarsi di soluzioni per conferenze di Google, come Google Meet, o di 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 del manifest su READ o READ_WRITE.

Oggetto di dati della conferenza
conferenceData.conferenceId string
L'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, ad esempio Hangouts o Google Meet.
conferenceData.conferenceSolution.iconUri string
L'URI dell'icona visibile all'utente che rappresenta questa soluzione per conferenze.
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 la versione classica di Hangouts per gli utenti di Google Workspace (http://hangouts.google.com).
  • hangoutsMeet per Google Meet (http://meet.google.com).
conferenceData.conferenceSolution.name string
Il nome di questa soluzione per conferenze visibile all'utente (non localizzato).
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 di dominio o 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 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 allegare informazioni a una conferenza specifica per l'utilizzo del componente aggiuntivo.

Punto di ingresso

Gli oggetti del punto di accesso contengono informazioni sui mezzi di accesso stabiliti per 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 entry point
entryPoint.accessCode string
Il codice di accesso utilizzato per accedere alla conferenza. La lunghezza massima è di 128 caratteri. In genere, i fornitori di conferenze utilizzano solo un sottoinsieme di {accessCode, meetingCode, passcode, password, pin} per fornire l'accesso alle conferenze. Abbina e visualizza solo i campi utilizzati dal fornitore di conferenze.
entryPoint.entryPointFeatures list
Caratteristiche dell'entry point. Al momento queste funzionalità si applicano solo ai punti di accesso phone:
  • toll: il punto di accesso è una chiamata a pagamento.
  • toll_free: il punto di contatto è una chiamata a un numero verde.
entryPoint.entryPointType string
Il tipo di punto di accesso. I valori possibili sono i seguenti:
  • more: istruzioni aggiuntive per partecipare alla conferenza, ad esempio numeri di telefono alternativi. Una conferenza può avere un solo punto di contatto more; se presente, è necessario anche almeno un altro tipo di punto di contatto.
  • phone: partecipa alla conferenza tramite un numero di telefono. Una conferenza può avere zero o più punti di accesso phone. Google Calendar mostra solo i primi due punti di accesso telefonici, dopo la formattazione e l'ordinamento alfabetico.
  • sip: partecipa alla conferenza tramite SIP. Una conferenza può avere al massimo un punto di accesso sip.
  • video: partecipa alla conferenza tramite HTTP. Una conferenza può avere al massimo un punto di accesso video.
entryPoint.label string
L'etichetta visibile all'utente per l'URI del punto di accesso (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 utilizzano solo un sottoinsieme di {accessCode, meetingCode, passcode, password, pin} per fornire l'accesso alle conferenze. Abbina e visualizza solo i campi utilizzati dal fornitore di conferenze.
entryPoint.passcode string
Il passcode utilizzato per accedere alla conferenza. La lunghezza massima è di 128 caratteri. In genere, i fornitori di conferenze utilizzano solo un sottoinsieme di {accessCode, meetingCode, passcode, password, pin} per fornire l'accesso alle conferenze. Abbina e visualizza solo i campi utilizzati dal fornitore di conferenze.
entryPoint.password string
La password utilizzata per accedere alla conferenza. La lunghezza massima è di 128 caratteri. In genere, i fornitori di conferenze utilizzano solo un sottoinsieme di {accessCode, meetingCode, passcode, password, pin} per fornire l'accesso alle conferenze. Abbina e visualizza solo i campi utilizzati dal fornitore di conferenze.
entryPoint.pin string
Il PIN utilizzato per accedere alla conferenza. La lunghezza massima è di 128 caratteri. In genere, i fornitori di conferenze utilizzano solo un sottoinsieme di {accessCode, meetingCode, passcode, password, pin} per fornire l'accesso alle conferenze. Abbina e visualizza solo i campi utilizzati dal fornitore di conferenze.
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 pubblico di codici regione CLDR.
entryPoint.uri string
L'URI del punto di accesso. La lunghezza massima è di 1300 caratteri. La formattazione dipende dal tipo di punto di accesso:
  • more: è richiesto 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: è richiesto uno schema sip: o sips:. Ad esempio "sip:12345678@myprovider.com".
  • video: è richiesto uno schema http: o https:.

Oggetto evento di Drive

L'oggetto evento di Drive è la parte dell'oggetto evento complessivo che contiene informazioni su Google Drive di un utente e sui relativi contenuti. È presente in un oggetto evento solo se il componente aggiuntivo estende Google Drive.

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

Elemento Drive

Gli oggetti degli elementi di Drive contengono informazioni su elementi di Drive specifici, come file o cartelle.

Oggetto elemento di Drive
item.addonHasFileScopePermission boolean
Se true, il componente aggiuntivo ha richiesto e ricevuto l'autorizzazione dell'ambito https://www.googleapis.com/auth/drive.file per questo elemento; in caso contrario, questo campo è false.
item.id string
L'ID dell'articolo 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 di Gmail

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

Oggetto evento di Gmail
gmail.accessToken string
Il token di accesso specifico di Gmail. Utilizza questo token con il metodo GmailApp.setCurrentMessageAccessToken per concedere al tuo componente aggiuntivo l'accesso temporaneo a un messaggio Gmail attualmente aperto di un utente o per consentire al tuo componente aggiuntivo di creare nuove bozze.
gmail.bccRecipients[] list of strings
Disabilitata per impostazione predefinita. L'elenco degli indirizzi email dei destinatari "Ccn:" attualmente inclusi in una bozza che il componente aggiuntivo sta scrivendo. Per attivare questo campo, imposta il campo addOns.gmail.composeTrigger.draftAccess nel manifest su METADATA.
gmail.ccRecipients[] list of strings
Disabilitata per impostazione predefinita. L'elenco degli indirizzi email dei destinatari "Cc:" attualmente inclusi in una bozza che il componente aggiuntivo sta scrivendo. Per attivare questo campo, imposta 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 del thread di Gmail attualmente aperto.
gmail.toRecipients[] list of strings
Disabilitata per impostazione predefinita. L'elenco degli indirizzi email dei destinatari "A:" attualmente inclusi in una bozza che il componente aggiuntivo sta scrivendo. Per attivare questo campo, imposta il campo addOns.gmail.composeTrigger.draftAccess nel manifest su METADATA.

Oggetto evento di Documenti

L'oggetto evento di Documenti è 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 il componente aggiuntivo estende Documenti Google.

Oggetto evento di Documenti
docs.id string
Presente solo se l'ambito https://www.googleapis.com/auth/drive.file è stato autorizzato dall'utente.
L'ID del documento aperto nella UI 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 nella UI di Documenti.
docs.addonHasFileScopePermission boolean
Se true, il componente aggiuntivo ha richiesto e ricevuto l'autorizzazione dell'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 sono soddisfatte le seguenti condizioni:
  • https://www.googleapis.com/auth/workspace.linkpreview è stato autorizzato dall'utente.
  • L'URL corrisponde al pattern host specificato nell'attivatore LinkPreviewTriggers.

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

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

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

Oggetto evento di Fogli

L'oggetto evento di 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 il componente aggiuntivo estende Fogli Google.

Oggetto evento di 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 ricevuto l'autorizzazione dell'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:
  • https://www.googleapis.com/auth/workspace.linkpreview è stato autorizzato dall'utente.
  • L'URL corrisponde al pattern host specificato nell'attivatore LinkPreviewTriggers.

L'URL del link che genera un'anteprima in Fogli Google. Per utilizzare questo campo, configura LinkPreviewTriggers nel manifest del componente aggiuntivo. Per maggiori dettagli, consulta Visualizza l'anteprima dei link con smart chip.

Esempio di payload 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 di Presentazioni è 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 il componente aggiuntivo estende 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 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 aperta nell'interfaccia utente di Presentazioni.
slides.addonHasFileScopePermission boolean
Se true, il componente aggiuntivo ha richiesto e ricevuto l'autorizzazione dell'ambito https://www.googleapis.com/auth/drive.file per la presentazione aperta nella UI di Presentazioni; altrimenti questo campo è false.
slides.matchedUrl.url string
Presente solo se sono soddisfatte le seguenti condizioni:
  • https://www.googleapis.com/auth/workspace.linkpreview è stato autorizzato dall'utente.
  • L'URL corrisponde al pattern host specificato nell'attivatore LinkPreviewTriggers.

L'URL del link che genera un'anteprima in Presentazioni Google. Per utilizzare questo campo, configura LinkPreviewTriggers nel manifest del componente aggiuntivo. Per maggiori dettagli, consulta Visualizza l'anteprima dei link con smart chip.

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

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