Oggetti evento

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

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 nei seguenti punti:

  • 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 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 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 attivatori contestuali che vengono attivati quando l'utente accede a 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 vengono attivati gli attivatori contestuali contengono tutti i campi inclusi negli oggetti evento di attivazione della home page, oltre ai campi contenenti informazioni contestuali.

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

    Gli oggetti evento creati come risultato delle azioni dei widget contengono tutti i campi inclusi negli oggetti evento di trigger contestuale, oltre ai campi contenenti informazioni sui 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 uno smart chip e una scheda che mostrano informazioni sul link all'interno dell'applicazione ospitante. Puoi anche creare azioni dei widget per consentire agli utenti di interagire con la scheda di anteprima e i relativi contenuti.

  • Attivazione app Google Chat (anteprima per sviluppatori). In Google Chat, il tuo componente aggiuntivo appare agli utenti come un'app di Chat e possono interagire con esso aggiungendolo agli spazi, inviando messaggi, utilizzando i comandi slash e altro ancora. Per creare funzionalità interattive, devi configurare e utilizzare vari trigger per le app di chat. Ogni attivatore invia un diverso payload dell'oggetto evento 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 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 per l'host, determinato dall'app host attiva: gmailEventObject, calendarEventObject o driveEventObject.

Per la compatibilità con le versioni precedenti, gli oggetti evento dei componenti aggiuntivi di Google Workspace includono anche tutti i campi originali utilizzati negli oggetti evento dell'azione dei componenti aggiuntivi di Gmail. Questi campi sono elencati nella tabella sottostante 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'host che chiama è Google Calendar. Un oggetto contenente informazioni su calendari ed eventi.
eventObject.chat Chat event object
Presente solo se l'organizzatore della chiamata è Google Chat. Un oggetto contenente informazioni su 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 su 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 di Fogli.
eventObject.slides Slides event object
Presente solo se l'organizzatore della chiamata è Presentazioni Google. Un oggetto contenente informazioni su Presentazioni.
Campi del componente aggiuntivo di Gmail originale
eventObject.messageMetadata.accessToken string
Ritiro previsto. 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, queste informazioni sono disponibili nel eventObject.gmail.accessToken campo.

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

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

eventObject.clientPlatform string
Ritiro previsto. Indica la piattaforma di origine dell'evento (web, iOS o Android).

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

eventObject.formInput object
Ritiro previsto. Una mappa dei valori correnti di tutti i widget di 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 come comodità quando devi leggere i dati da più widget con valori singolari previsti, come input di testo e pulsanti. Per i widget con più valori, come le caselle di controllo, puoi leggere ogni valore da formInputs.

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, il valore viene presentato in un array a un 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 eventObject.commonEventObject.formInputs campo.

eventObject.parameters object
Ritiro previsto. Una mappa di eventuali parametri aggiuntivi forniti al 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 eventObject.commonEventObject.parameters campo.

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, queste informazioni sono disponibili nel eventObject.commonEventObject.userLocale campo.

eventObject.userLocale string
Deprecato e disabilitato per impostazione predefinita. Il codice ISO 639 di due lettere 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, queste informazioni sono disponibili nel eventObject.commonEventObject.userLocale campo.

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

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

eventObject.userTimezone.offset string
Deprecato e disabilitato per impostazione predefinita. Il décalage dall'ora universale coordinata (UTC) del fuso orario dell'utente, misurato in millisecondi. Per ulteriori dettagli, consulta Accedere alle impostazioni internazionali e al fuso orario dell'utente.

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

Oggetto evento comune

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

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 tuo componente aggiuntivo può eseguire query sull'oggetto evento comune per determinare i contenuti dei widget aperti nel client dell'utente. Ad esempio, il tuo componente aggiuntivo può individuare il testo inserito da un utente in un widget TextInput nell'objettivo eventObject.commentEventObject.formInputs.

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

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

  • Widget con un solo valore (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 con più valori con ID participants, accedi all'array di valori con: e.commonEventObject.formInputs.participants.stringInputs.value.

  • A date-time picker: a DateTimeInput object.

    Esempio: per un selettore con ID myDTPicker, accedi all'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 includono quanto segue:
  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
commonEventObject.parameters object
Qualsiasi parametro aggiuntivo fornito a un'azione utilizzando actionParameters o Action.setParameters().

Anteprima per sviluppatori: per i componenti aggiuntivi che estendono Google Chat, per suggerire elementi in base a ciò che gli utenti digitano nei menu di 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 agli utenti elementi selezionabili mentre digitano. Per maggiori dettagli, consulta Raccogliere ed elaborare informazioni degli utenti di Google Chat.
commonEventObject.userLocale string
Disattivato per impostazione predefinita. La lingua e l'identificatore del paese/della regione dell'utente nel formato ISO 639 codice lingua-ISO 3166 codice paese/regione. Ad esempio, en-US.

Per attivare questo campo, devi impostare addOns.common.useLocaleFromApp su true nel manifest del tuo 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 string
Disattivato per impostazione predefinita. L'ID e la differenza di fuso orario. Per attivare questo campo, devi impostare addOns.common.useLocaleFromApp su 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.id string
L' identificatore del fuso orario del fuso orario dell'utente. Esempi: America/New_York, Europe/Vienna e Asia/Seoul. Per attivare questo campo, devi impostare addOns.common.useLocaleFromApp su true nel file manifest del componente aggiuntivo. L'elenco 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. Per ulteriori dettagli, consulta Accedere alle impostazioni internazionali e al fuso orario dell'utente.

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 della data o dell'ora selezionati dall'utente nei widget di selezione della data o dell'ora. Tuttavia, la struttura delle informazioni varia a seconda che il widget sia stato configurato come selettore di data e ora, selettore solo di data o selettore solo di ora. 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
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 selezionata dall'utente.
timeInput.minutes number
Il numero di minuti selezionato dall'utente.

Oggetto evento chat

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

Chat
chat.user object (User)
L'utente 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.

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

object (MessagePayload)

Il payload che le app di Chat ricevono da un attivatore Message.
chat.addedToSpacePayload

object (AddedToSpacePayload)

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

object (RemovedFromSpacePayload)

Il payload che le app Chat ricevono da un attivatore 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 del testo nel menu di selezione multipla di un selectionInput widget. 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 Chat può eseguire query sull'origine dati in base a quanto digitato dall'utente nel menu e poi restituire le richieste di assistenza corrispondenti come elementi selezionabili.

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

chat.appCommandPayload

object (AppCommandPayload)

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

Payload

A seconda del tipo di interazione con l'app 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 di 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 Chat.
chat.messagePayload.configCompleteRedirectUri string
L'URL a cui l'app 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ù, vedi Collegare il componente aggiuntivo di Google Workspace a un servizio di terze parti.

Aggiunta al payload dello spazio
AddedToSpacePayload
chat.addedToSpacePayload.space object (Space)
Lo spazio di Chat a cui l'utente ha aggiunto o installato l'app 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 contenente informazioni sul messaggio.
chat.addedToSpacePayload.configCompleteRedirectUri string
L'URL a cui l'app 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ù, vedi Collegare il componente aggiuntivo di Google Workspace a un servizio di terze parti.

Rimosso dal payload dello spazio
RemovedFromSpacePayload
chat.removedFromSpacePayload.space object (Space)
Lo spazio 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 clic sul pulsante
ButtonClickedPayload
chat.buttonClickedPayload.message object (Message)
Il messaggio di Chat contenente 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 da 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 un 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 del widget aggiornato
WidgetUpdatedPayload
chat.widgetUpdatedPayload.space object (Space)
Lo spazio di Chat in cui si è verificata l'interazione.

Payload del comando 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 si è verificata in un thread, il thread Chat in cui l'utente ha utilizzato il comando.
chat.appCommandPayload.message object (Message)
Per i comandi slash, il messaggio che contiene il comando slash.
chat.appCommandPayload.configCompleteRedirectUri string
Se per il comando è richiesta l'autorizzazione o la configurazione, un URL a cui indirizzare l'utente al termine della 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 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 slash /.
QUICK_COMMAND L'utente seleziona il comando dal menu Chat nell'area di risposta al messaggio.

Oggetto evento di calendario

L'oggetto evento di calendario è la parte dell'oggetto evento complessivo che contiene informazioni sul calendario e sugli eventi di 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 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 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 Partecipanti 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 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 l'organizzatore ha indicato di voler 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 dell'evento.
attendee.resource boolean
true se il partecipante rappresenta una risorsa, ad esempio una stanza o un'attrezzatura; false in caso contrario.
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 di dati delle conferenze contengono informazioni sulle conferenze allegate agli eventi di Google Calendar. Possono essere soluzioni per conferenze di Google, come Google Meet, o conferenze di terze parti. Queste informazioni sono presenti nell'oggetto evento se e solo se i dati sono presenti nell'evento di Calendar e il componente aggiuntivo imposta il campo addOns.calendar.currentEventAccess manifest su READ o READ_WRITE.

Oggetto dati della 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 gli 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 soluzione di conferenza (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 norme legali) sulla conferenza da mostrare all'utente. Può contenere HTML. La lunghezza massima è di 2048 caratteri.
conferenceData.parameters object
Un oggetto contenente una mappa di dati parametro definiti da utilizzare dal 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 nell'oggetto evento se e solo se i dati sono presenti nell'evento di Calendar e il componente aggiuntivo imposta il campo addOns.calendar.currentEventAccess manifest su READ o READ_WRITE.

Oggetto punto di 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. Abbina e mostra solo i campi utilizzati dal fornitore della conferenza.
entryPoint.entryPointFeatures list
Funzionalità dell'entry point. Al momento queste funzionalità si applicano solo agli entry point phone:
  • toll: il punto di contatto è una chiamata a pagamento.
  • toll_free: il punto di contatto è una chiamata senza costi.
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 more punto di contatto; se presente, è obbligatorio 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 contatto dello smartphone, dopo averli formattati e ordinati in ordine alfabetico.
  • sip: partecipa alla conferenza tramite SIP. Una conferenza può avere al massimo un punto di contatto sip.
  • video: partecipa alla conferenza tramite HTTP. Una conferenza può avere al massimo un punto di contatto video.
entryPoint.label string
L'etichetta visibile all'utente per l'URI del punto di contatto (non localizzato).
entryPoint.meetingCode string
Il codice riunione 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. Abbina e mostra solo i campi utilizzati dal fornitore della 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. Abbina e mostra solo i campi utilizzati dal fornitore della conferenza.
entryPoint.password string
La password utilizzata 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. Abbina e mostra solo i campi utilizzati dal fornitore della conferenza.
entryPoint.pin string
Il PIN 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. Abbina e mostra solo i campi utilizzati dal fornitore della conferenza.
entryPoint.regionCode string
Codice regione del numero di telefono. Obbligatorio per gli utenti se l'URI non include un codice paese. I valori si basano sul elenco pubblico dei codici regionali 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: è obbligatorio uno schema http: o https:.
  • phone: è necessario 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@myprovider.com".
  • video: è obbligatorio uno schema http: o https:.

Oggetto evento Drive

L'oggetto evento 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 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 di 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. In caso contrario, 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 Gmail è la parte dell'oggetto evento complessivo che contiene informazioni sui messaggi Gmail di un utente. È presente in un oggetto evento solo se l'applicazione host è Gmail.

Oggetto evento Gmail
gmail.accessToken string
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
Disattivato 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 campo addOns.gmail.composeTrigger.draftAccess nel manifest su METADATA.
gmail.ccRecipients[] list of strings
Disattivato per impostazione predefinita. L'elenco degli indirizzi email dei destinatari "Cc" attualmente inclusi in una bozza in fase di composizione da parte del plug-in. Per attivare questo campo, devi impostare il campo addOns.gmail.composeTrigger.draftAccess nel manifest su METADATA.
gmail.messageId string
L'ID del messaggio di Gmail attualmente aperto.
gmail.threadId string
L'ID thread di Gmail attualmente aperto.
gmail.toRecipients[] list of strings
Disattivato per impostazione predefinita. L'elenco degli indirizzi email dei destinatari "A" attualmente inclusi in una bozza in fase di composizione da parte del plug-in. Per attivare questo campo, devi impostare il campo addOns.gmail.composeTrigger.draftAccess nel manifest su METADATA.

Oggetto evento Documenti

L'oggetto evento Docs è 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 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 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 tuo 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: 

"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 il componente aggiuntivo estende Fogli Google.

Oggetto evento Fogli
sheets.id string
Presente solo se l'ambito https://www.googleapis.com/auth/drive.file è stato autorizzato dall'utente. L'ID del foglio di lavoro aperto nell'interfaccia utente di Fogli.
sheets.title string
Presente solo se l'ambito https://www.googleapis.com/auth/drive.file è stato autorizzato dall'utente. Il titolo del foglio di lavoro aperto nell'interfaccia utente di Fogli.
sheets.addonHasFileScopePermission boolean
Se true, il componente aggiuntivo ha richiesto e 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:
  • https://www.googleapis.com/auth/workspace.linkpreview è stato autorizzato dall'utente.
  • L'URL corrisponde al pattern host specificato nell'attivatore LinkPreviewTriggers.

L'URL del link che genera un'anteprima in Fogli Google. Per utilizzare questo campo, devi configurare LinkPreviewTriggers nel manifest del tuo 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 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'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 nell'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:
  • https://www.googleapis.com/auth/workspace.linkpreview è stato autorizzato dall'utente.
  • L'URL corrisponde al pattern host specificato nell'attivatore LinkPreviewTriggers.

L'URL del link che genera un'anteprima in Presentazioni Google. Per utilizzare questo campo, devi configurare LinkPreviewTriggers nel manifest del tuo 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:

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