EventObject

EventObject

Un evento di interazione con un componente aggiuntivo Google che contiene dati sull'interazione di un utente con un componente aggiuntivo all'interno di un'app host.

L'oggetto evento viene passato come JSON alla funzione di callback o al trigger di un componente aggiuntivo (per Apps Script) o all'endpoint https (per HTTP), quando un utente interagisce con un componente aggiuntivo all'interno di un'app host. L'oggetto evento memorizza un oggetto evento dell'app host definito da ogni app host, nonché un oggetto evento comune contenente alcuni campi comuni correlati all'evento.

Per saperne di più, consulta Oggetti evento.

Rappresentazione JSON
{
  "commonEventObject": {
    object (CommonEventObject)
  },
  "authorizationEventObject": {
    object (AuthorizationEventObject)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "calendar": {
    object (CalendarEventObject)
  },
  "drive": {
    object (DriveEventObject)
  },
  "gmail": {
    object (GmailEventObject)
  },
  "sheets": {
    object (SheetsEventObject)
  },
  "slides": {
    object (SlidesEventObject)
  },
  "docs": {
    object (DocsEventObject)
  },
  "chat": {
    object (ChatEventObject)
  },
  "workflow": {
    object (WorkflowEventObject)
  }
  // End of mutually exclusive fields.
}
Campi
commonEventObject

object (CommonEventObject)

Un oggetto contenente informazioni comuni a tutti gli oggetti evento, indipendentemente dall'applicazione host.

authorizationEventObject

object (AuthorizationEventObject)

Impostato solo per le richieste agli endpoint HTTP

Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
calendar

object (CalendarEventObject)

Presente solo se l'host chiamante è Google Calendar. Un oggetto contenente informazioni su calendari ed eventi.

drive

object (DriveEventObject)

Presente solo se l'host chiamante è Google Drive. Un oggetto contenente informazioni su Drive.

gmail

object (GmailEventObject)

Presente solo se l'host chiamante è Gmail. Un oggetto contenente informazioni di Gmail.

sheets

object (SheetsEventObject)

Presente solo se l'host chiamante è Fogli Google. Un oggetto contenente informazioni su Fogli.

slides

object (SlidesEventObject)

Presente solo se l'host chiamante è Presentazioni Google. Un oggetto contenente informazioni su Presentazioni.

docs

object (DocsEventObject)

Presente solo se l'host chiamante è Documenti Google. Un oggetto contenente informazioni su Documenti.

chat

object (ChatEventObject)

Presente solo se l'host chiamante è Google Chat. Un oggetto contenente informazioni sulla chat.

workflow

object (WorkflowEventObject)

Presente solo se l'host chiamante è Google Workspace Studio. Un oggetto contenente informazioni sul workflow.

Fine dei campi che si escludono a vicenda.

CommonEventObject

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.

Per le app di Chat, il nome della funzione richiamata dall'utente durante l'interazione con un widget.

Rappresentazione JSON
{
  "userLocale": string,
  "hostApp": enum (HostApp),
  "platform": enum (Platform),
  "timeZone": {
    object (TimeZone)
  },
  "formInputs": {
    string: {
      object (Inputs)
    },
    ...
  },
  "parameters": {
    string: string,
    ...
  },
  "invokedFunction": string
}
Campi
userLocale

string

Disattivato 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.

hostApp

enum (HostApp)

Indica l'app host in cui è attivo il componente aggiuntivo quando viene generato l'oggetto evento. I valori possibili sono i seguenti:

  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
  • CHAT
platform

enum (Platform)

L'enum della piattaforma che indica la piattaforma da cui ha origine l'evento (WEB, IOS o ANDROID). Non supportato dalle app di Chat.

timeZone

object (TimeZone)

Disattivato per impostazione predefinita. L'ID del fuso orario e l'offset rispetto al fuso orario UTC (Coordinated Universal Time). 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.

Supportato solo per i tipi di evento CARD_CLICKED e SUBMIT_DIALOG.

formInputs

map (key: string, value: object (Inputs))

Una mappa contenente i valori attuali dei widget nella scheda visualizzata. Le chiavi della mappa sono i valori stringa name assegnati a ogni widget di input (ad esempio TextInput.name, SelectionInput.name, DateTimePicker.name o DecoratedText.SwitchControl.name).

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

Nota: i seguenti esempi sono formattati per il runtime V8 di Apps Script. Se utilizzi il runtime Rhino, devi aggiungere [""] dopo il valore. Ad esempio, anziché e.commonEventObject.formInputs.employeeName.stringInputs.value[0], formatta l'oggetto evento come e.commonEventObject.formInputs.employeeName[""].stringInputs.value[0]. Per scoprire di più sui runtime in Apps Script, consulta la panoramica del runtime V8.

  • Widget con un solo valore (ad esempio un widget TextInput o un widget SelectionInput di tipo DROPDOWN o RADIO_BUTTON): un oggetto StringInputs contenente un elenco di un solo elemento (o un elenco vuoto se non viene effettuata alcuna selezione).

Esempio: per un widget di immissione di testo con employeeName come name, accedi al valore di immissione di testo con: e.commonEventObject.formInputs.employeeName.stringInputs.value[0].

  • Widget con più valori (ad esempio un widget SelectionInput di tipo CHECK_BOX, SWITCH o MULTI_SELECT): un oggetto StringInputs contenente l'elenco delle stringhe value degli elementi selezionati.

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

  • Un widget DecoratedText.SwitchControl: un oggetto StringInputs. Quando selected è true, stringInputs.value contiene il campo value dell'opzione (o "" se value non è stato specificato; se più opzioni condividono lo stesso name, il value di ogni opzione selezionata è incluso nell'elenco). Quando selected è false, l'elemento value dell'opzione viene omesso da stringInputs.value.

  • Un selettore di data e ora (DateTimePickerType.DATE_AND_TIME): un DateTimeInput object.

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

  • Un selettore di sola data (DateTimePickerType.DATE_ONLY): un DateInput object.

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

  • Un selettore solo per l'ora (DateTimePickerType.TIME_ONLY): un TimeInput object.

Esempio: per un selettore con un name di myTimePicker, accedi all'oggetto TimeInput utilizzando e.commonEventObject.formInputs.myTimePicker.timeInput.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

parameters

map (key: string, value: string)

Eventuali parametri aggiuntivi forniti a un'azione utilizzando actionParameters o Action.setParameters().

Anteprima per gli sviluppatori: per i componenti aggiuntivi che estendono 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, vedi Raccogliere ed elaborare le informazioni degli utenti di Google Chat.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

invokedFunction

string

Nome della funzione da richiamare.

Questo campo non viene compilato per i componenti aggiuntivi di Google Workspace che estendono Google Chat. Per ricevere dati delle funzioni come gli identificatori, i componenti aggiuntivi che estendono Chat devono utilizzare il campo parameters. Consulta Crea interfacce interattive per le app di Chat.

HostApp

L'applicazione Google Workspace per un componente aggiuntivo di Google Workspace o un'app di Chat di Google Chat.

Per i componenti aggiuntivi, l'applicazione Workspace da cui viene avviato un componente aggiuntivo di Google Workspace. Per le app di Chat, l'app host è sempre CHAT.

Enum
UNSPECIFIED_HOST_APP Google non riesce a identificare un'app host.
GMAIL Il componente aggiuntivo viene avviato da Gmail.
CALENDAR Il componente aggiuntivo viene avviato da Google Calendar.
DRIVE Il componente aggiuntivo viene avviato da Google Drive.
DEMO Non utilizzato.
DOCS Il componente aggiuntivo viene avviato da Documenti Google.
MEET Il componente aggiuntivo viene avviato da Google Meet.
SHEETS Il componente aggiuntivo viene avviato da Fogli Google.
SLIDES Il componente aggiuntivo viene avviato da Presentazioni Google.
DRAWINGS Il componente aggiuntivo viene avviato da Disegni Google.
CHAT Un'app Google Chat.

Piattaforma

Identifica la piattaforma da cui ha avuto origine la chiamata.

Enum
UNKNOWN_PLATFORM
WEB
IOS
ANDROID

TimeZone

L'ID del fuso orario e l'offset rispetto al fuso orario UTC (Coordinated Universal Time). Supportato solo per i tipi di evento CARD_CLICKED e SUBMIT_DIALOG.

Rappresentazione JSON
{
  "id": string,
  "offset": integer
}
Campi
id

string

Il codice del database dei fusi orari IANA TZ, ad esempio "America/Toronto".

offset

integer

L'offset del fuso orario dell'utente, in millisecondi, rispetto al fuso orario UTC (Coordinated Universal Time).

Input

Tipi di dati che gli utenti possono inserire in schede o finestre di dialogo. Il tipo di input dipende dal tipo di valori accettati dal widget.

Rappresentazione JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "stringInputs": {
    object (StringInputs)
  },
  "dateTimeInput": {
    object (DateTimeInput)
  },
  "dateInput": {
    object (DateInput)
  },
  "timeInput": {
    object (TimeInput)
  }
  // End of mutually exclusive fields.
}
Campi
Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
stringInputs

object (StringInputs)

Un elenco di stringhe che rappresentano i valori inseriti dall'utente in un widget.

Se il widget accetta un solo valore, ad esempio un widget TextInput, l'elenco contiene un oggetto stringa. Se il widget accetta più valori, ad esempio un widget SelectionInput di caselle di controllo, l'elenco contiene un oggetto stringa per ogni valore inserito o selezionato dall'utente.

dateTimeInput

object (DateTimeInput)

Valori di input di data e ora da un widget DateTimePicker che accetta sia una data che un'ora.

dateInput

object (DateInput)

Valori di input della data da un widget DateTimePicker che accetta solo valori di data.

timeInput

object (TimeInput)

Valori di input dell'ora da un widget DateTimePicker che accetta solo valori di ora.

Fine dei campi che si escludono a vicenda.

StringInputs

Parametro di input per i widget normali. Per i widget con un solo valore, si tratta di un elenco di valori singoli. Per i widget con più valori, ad esempio la casella di controllo, vengono presentati tutti i valori.

Rappresentazione JSON
{
  "value": [
    string
  ]
}
Campi
value[]

string

Un elenco di stringhe inserite dall'utente.

DateTimeInput

Valori di input di data e ora.

Rappresentazione JSON
{
  "msSinceEpoch": string,
  "hasDate": boolean,
  "hasTime": boolean
}
Campi
msSinceEpoch

string (int64 format)

Tempo trascorso dall'epoca di Unix, in millisecondi.

hasDate

boolean

Se l'input datetime include una data di calendario.

hasTime

boolean

Indica se l'input datetime include un timestamp.

DateInput

Valori di input della data.

Rappresentazione JSON
{
  "msSinceEpoch": string
}
Campi
msSinceEpoch

string (int64 format)

Tempo trascorso dall'epoca di Unix, in millisecondi.

TimeInput

Valori di input dell'ora.

Rappresentazione JSON
{
  "hours": integer,
  "minutes": integer
}
Campi
hours

integer

L'ora in un orologio di 24 ore.

minutes

integer

Il numero di minuti dopo l'ora. I valori validi sono compresi tra 0 e 59.

AuthorizationEventObject

Incapsula le informazioni di autorizzazione per la richiesta del componente aggiuntivo

Rappresentazione JSON
{
  "userOAuthToken": string,
  "userIdToken": string,
  "systemIdToken": string,
  "authorizedScopes": [
    string
  ]
}
Campi
userOAuthToken

string

Il token di accesso OAuth dell'utente finale, autorizzato con gli ambiti richiesti. (Dopo la separazione del consenso OAuth, l'autorizzazione verrà concessa con gli ambiti autorizzati dall'utente finale)

userIdToken

string

Un token ID utente finale, se vengono richiesti gli ambiti ID appropriati

systemIdToken

string

Un token ID per il service account dei componenti aggiuntivi di G Suite per questo deployment

authorizedScopes[]

string

Elenco degli ambiti OAuth autorizzati dall'utente.

CalendarEventObject

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 l'applicazione host è Google Calendar.

La tabella seguente elenca i campi presenti nel campo calendar 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 del manifest su READ o READ_WRITE.

Rappresentazione JSON
{
  "id": string,
  "recurringEventId": string,
  "calendarId": string,
  "organizer": {
    object (Organizer)
  },
  "attendees": [
    {
      object (Attendee)
    }
  ],
  "conferenceData": {
    object (ConferenceData)
  },
  "capabilities": {
    object (Capabilities)
  }
}
Campi
id

string

L'ID evento.

recurringEventId

string

L'ID di un evento ricorrente.

calendarId

string

L'ID calendario.

organizer

object (Organizer)

Un oggetto che rappresenta l'organizzatore dell'evento.

attendees[]

object (Attendee)

Dati generati dagli utenti. Un elenco dei partecipanti all'evento nel calendario.

conferenceData

object (ConferenceData)

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.

capabilities

object (Capabilities)

Dati generati dagli utenti. Un oggetto che descrive le funzionalità del componente aggiuntivo per visualizzare o aggiornare le informazioni sugli eventi.

Organizzatore

Rappresentazione JSON
{
  "email": string
}
Campi
email

string

L'indirizzo email dell'organizzatore dell'evento.

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 del manifest su READ o READ_WRITE.

Rappresentazione JSON
{
  "email": string,
  "displayName": string,
  "organizer": boolean,
  "self": boolean,
  "resource": boolean,
  "optional": boolean,
  "responseStatus": string,
  "comment": string,
  "additionalGuests": integer
}
Campi
email

string

L'indirizzo email del partecipante.

displayName

string

Il nome visualizzato del partecipante.

organizer

boolean

true se il partecipante è un organizzatore di questo evento.

self

boolean

true se questo partecipante rappresenta il calendario in cui viene visualizzato questo evento; false in caso contrario.

resource

boolean

true se il partecipante rappresenta una risorsa, ad esempio una stanza o un'attrezzatura; false in caso contrario.

optional

boolean

true se la presenza di questo partecipante è contrassegnata come facoltativa; false in caso contrario.

responseStatus

string

Lo stato della risposta del partecipante. I valori possibili sono i seguenti:

  • accepted: il partecipante ha accettato l'invito all'evento.
  • declined: il partecipante ha rifiutato l'invito all'evento.
  • needsAction: il partecipante non ha risposto all'invito all'evento.
  • tentative: il partecipante ha accettato provvisoriamente l'invito all'evento.
comment

string

Il commento di risposta del partecipante, se presente.

additionalGuests

integer

Il numero di ospiti aggiuntivi che il partecipante ha indicato di portare. Il valore predefinito è zero.

ConferenceData

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 nel calendario e il componente aggiuntivo imposta il campo addOns.calendar.currentEventAccess del manifest su READ o READ_WRITE.

Rappresentazione JSON
{
  "conferenceId": string,
  "conferenceSolution": {
    object (ConferenceSolution)
  },
  "entryPoints": [
    {
      object (EntryPoint)
    }
  ],
  "notes": string,
  "parameters": {
    object (Parameters)
  }
}
Campi
conferenceId

string

L'ID della conferenza. Questo ID consente alle applicazioni di tenere traccia delle conferenze; non devi mostrarlo agli utenti.

conferenceSolution

object (ConferenceSolution)

Un oggetto che rappresenta la soluzione per conferenze, ad esempio Hangouts o Google Meet.

entryPoints[]

object (EntryPoint)

L'elenco dei punti di accesso alla conferenza, ad esempio URL o numeri di telefono.

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.

parameters

object (Parameters)

Un oggetto contenente una mappa dei dati dei parametri definiti per l'utilizzo da parte del componente aggiuntivo.

ConferenceSolution

Rappresentazione JSON
{
  "iconUri": string,
  "key": {
    object (Key)
  },
  "name": string
}
Campi
iconUri

string

L'URI dell'icona visibile all'utente che rappresenta questa soluzione per conferenze.

key

object (Key)

La chiave che identifica in modo univoco la soluzione per conferenze per questo evento.

name

string

Il nome di questa soluzione per conferenze visibile all'utente (non localizzato).

Chiave

Rappresentazione JSON
{
  "type": string
}
Campi
type

string

Il tipo di soluzione per conferenze. I valori possibili sono i seguenti:

EntryPoint

Gli oggetti EntryPoint contengono informazioni sui mezzi stabiliti per accedere a una determinata conferenza, ad esempio tramite telefono o video. Queste informazioni sono presenti nell'oggetto evento se e solo se i dati sono presenti nell'evento nel calendario e il componente aggiuntivo imposta il campo addOns.calendar.currentEventAccess del manifest su READ o READ_WRITE.

Rappresentazione JSON
{
  "accessCode": string,
  "entryPointType": string,
  "label": string,
  "meetingCode": string,
  "passcode": string,
  "password": string,
  "pin": string,
  "uri": string,
  "regionCode": string,
  "entryPointFeatures": [
    string
  ]
}
Campi
accessCode

string

Il codice di accesso utilizzato per accedere alla conferenza. La lunghezza massima è di 128 caratteri. I fornitori di conferenze in genere 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.

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 telefonici. 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.
label

string

L'etichetta visibile all'utente per l'URI del punto di accesso (non localizzato).

meetingCode

string

Il codice riunione utilizzato per accedere alla conferenza. La lunghezza massima è di 128 caratteri. I fornitori di conferenze in genere 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.

passcode

string

Il passcode utilizzato per accedere alla conferenza. La lunghezza massima è di 128 caratteri. I fornitori di conferenze in genere 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.

password

string

La password utilizzata per accedere alla conferenza. La lunghezza massima è di 128 caratteri. I fornitori di conferenze in genere 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.

pin

string

Il PIN utilizzato per accedere alla conferenza. La lunghezza massima è di 128 caratteri. I fornitori di conferenze in genere 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.

uri

string

L'URI dell'entry point. 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:.
regionCode

string

Codice regione del numero di telefono. Obbligatorio per gli utenti se l'URI non include un codice paese. I valori si basano sull'elenco pubblico di codici regione CLDR.

entryPointFeatures[]

string

Caratteristiche dell'entry point. Al momento, queste funzionalità si applicano solo ai punti di accesso telefonici:

  • toll: il punto di contatto è una chiamata telefonica a pagamento.
  • toll_free: il punto di contatto è una chiamata a un numero verde.

Parametri

Rappresentazione JSON
{
  "addOnParameters": {
    object (AddOnParameters)
  }
}
Campi
addOnParameters

object (AddOnParameters)

Una mappa di chiavi e valori di stringhe di parametri. Queste chiavi e questi valori sono definiti dallo sviluppatore del componente aggiuntivo per allegare informazioni a una conferenza specifica per l'utilizzo del componente aggiuntivo.

AddOnParameters

Rappresentazione JSON
{
  "parameters": {
    string: string,
    ...
  }
}
Campi
parameters

map (key: string, value: string)

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Funzionalità

Rappresentazione JSON
{
  "canSeeAttendees": boolean,
  "canAddAttendees": boolean,
  "canSeeConferenceData": boolean,
  "canSetConferenceData": boolean,
  "canAddAttachments": boolean
}
Campi
canSeeAttendees

boolean

Dati generati dagli utenti. true se il componente aggiuntivo può leggere l'elenco dei partecipanti all'evento; false in caso contrario.

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.

canSeeConferenceData

boolean

Dati generati dagli utenti. true se il componente aggiuntivo può leggere i dati della conferenza dell'evento; false in caso contrario.

canSetConferenceData

boolean

Dati generati dall'utente. true se il componente aggiuntivo può aggiornare i dati della conferenza dell'evento; false in caso contrario.

canAddAttachments

boolean

Dati generati dagli utenti. true se il componente aggiuntivo può aggiungere nuovi allegati all'evento; false in caso contrario.

DriveEventObject

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 l'applicazione in hosting è Google Drive.

Rappresentazione JSON
{
  "selectedItems": [
    {
      object (DriveItemMetadata)
    }
  ],
  "activeCursorItem": {
    object (DriveItemMetadata)
  }
}
Campi
selectedItems[]

object (DriveItemMetadata)

Un elenco di elementi (file o cartelle) selezionati in Drive.

activeCursorItem

object (DriveItemMetadata)

L'elemento di Drive attualmente attivo.

DriveItemMetadata

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

Rappresentazione JSON
{
  "id": string,
  "iconUrl": string,
  "mimeType": string,
  "title": string,
  "addonHasFileScopePermission": boolean
}
Campi
id

string

L'ID dell'articolo selezionato.

iconUrl

string

L'URL dell'icona che rappresenta l'elemento selezionato.

mimeType

string

Il tipo MIME dell'elemento selezionato.

title

string

Il titolo dell'elemento selezionato.

addonHasFileScopePermission

boolean

Se true, il componente aggiuntivo ha richiesto e ricevuto l'autorizzazione per l'ambito https://www.googleapis.com/auth/drive.file per questo elemento. In caso contrario, questo campo è false.

Se il componente aggiuntivo utilizza un ambito più permissivo, ad esempio https://www.googleapis.com/auth/drive o https://www.googleapis.com/auth/drive.readonly, questo campo non è pertinente. Utilizza sempre gli ambiti meno permissivi possibili quando progetti i componenti aggiuntivi per proteggere le informazioni degli utenti.

GmailEventObject

L'oggetto evento di 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.

Rappresentazione JSON
{
  "messageId": string,
  "threadId": string,
  "accessToken": string,
  "toRecipients": [
    string
  ],
  "ccRecipients": [
    string
  ],
  "bccRecipients": [
    string
  ]
}
Campi
messageId

string

L'ID del messaggio Gmail attualmente aperto.

threadId

string

L'ID del thread di Gmail attualmente aperto.

accessToken

string

Il token di accesso specifico per Gmail. Puoi utilizzare questo token con il metodo GmailApp.setCurrentMessageAccessToken(accessToken) per concedere al componente aggiuntivo l'accesso temporaneo al messaggio Gmail attualmente aperto di un utente o per consentire al componente aggiuntivo di creare nuove bozze.

toRecipients[]

string

Disattivato 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, devi impostare il campo addOns.gmail.composeTrigger.draftAccess nel manifest su METADATA.

ccRecipients[]

string

Disattivato 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, devi impostare il campo addOns.gmail.composeTrigger.draftAccess nel manifest su METADATA.

bccRecipients[]

string

Disattivato 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, devi impostare il campo addOns.gmail.composeTrigger.draftAccess nel manifest su METADATA.

SheetsEventObject

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.

Rappresentazione JSON
{
  "id": string,
  "title": string,
  "addonHasFileScopePermission": boolean,
  "matchedUrl": {
    object (MatchedUrl)
  }
}
Campi
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 nella UI di Fogli.

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 nella UI di Fogli.

addonHasFileScopePermission

boolean

Se true, il componente aggiuntivo ha richiesto e ricevuto l'autorizzazione per l'ambito https://www.googleapis.com/auth/drive.file per il foglio di lavoro aperto nell'interfaccia utente di Fogli; in caso contrario, questo campo è false.

matchedUrl

object (MatchedUrl)

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 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"
  }
}

MatchedUrl

Oggetto evento restituito con le richieste di anteprima dei link.

Rappresentazione JSON
{
  "url": string
}
Campi
url

string

L'URL corrispondente.

SlidesEventObject

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.

Rappresentazione JSON
{
  "id": string,
  "title": string,
  "addonHasFileScopePermission": boolean,
  "matchedUrl": {
    object (MatchedUrl)
  }
}
Campi
id

string

Presente solo se l'ambito https://www.googleapis.com/auth/drive.file è stato autorizzato dall'utente. L'ID della presentazione aperta nella UI di Presentazioni.

title

string

Presente solo se l'ambito https://www.googleapis.com/auth/drive.file è stato autorizzato dall'utente. Il titolo della presentazione aperta nella UI di Presentazioni.

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 nell'UI di Presentazioni; altrimenti questo campo è false.

matchedUrl

object (MatchedUrl)

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 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"
  }
}

DocsEventObject

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.

Rappresentazione JSON
{
  "id": string,
  "title": string,
  "addonHasFileScopePermission": boolean,
  "matchedUrl": {
    object (MatchedUrl)
  }
}
Campi
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.

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.

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.

matchedUrl

object (MatchedUrl)

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"
  }
}

ChatEventObject

Un payload dell'oggetto evento dell'app di Chat di Google inviato dal server Google ai componenti aggiuntivi. I payload possono essere utilizzati per identificare il tipo di evento.

Rappresentazione JSON
{
  "type": enum (EventType),
  "user": {
    object (User)
  },
  "space": {
    object (Space)
  },
  "eventTime": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "messagePayload": {
    object (MessagePayload)
  },
  "addedToSpacePayload": {
    object (AddedToSpacePayload)
  },
  "removedFromSpacePayload": {
    object (RemovedFromSpacePayload)
  },
  "buttonClickedPayload": {
    object (ButtonClickedPayload)
  },
  "widgetUpdatedPayload": {
    object (WidgetUpdatedPayload)
  },
  "appCommandPayload": {
    object (AppCommandPayload)
  },
  "systemCommandPayload": {
    object (SystemCommandPayload)
  }
  // End of mutually exclusive fields.
}
Campi
type

enum (EventType)

Il tipo di evento, compilato solo per gli eventi della home page dell'app nelle app di Chat che non sono componenti aggiuntivi.

user

object (User)

L'utente che interagisce con l'app di Chat.

space

object (Space)

Lo spazio in cui si è verificato l'evento, compilato solo per gli eventi della home page dell'app nelle app di Chat che non sono componenti aggiuntivi.

eventTime

string (Timestamp format)

Il timestamp che indica quando si verifica l'oggetto evento.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

Il payload dell'oggetto evento. I payload dipendono dal tipo di oggetto evento. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
messagePayload

object (MessagePayload)

Un utente invia un messaggio all'app di Chat o @menziona l'app di Chat in uno spazio. Le chiamate dei comandi dell'app (come i comandi slash e i comandi rapidi) vengono invece inviate in appCommandPayload.

addedToSpacePayload

object (AddedToSpacePayload)

Un utente aggiunge l'app di Chat a uno spazio di Chat oppure un amministratore di Google Workspace installa l'app di Chat negli spazi dei messaggi diretti per gli utenti della sua organizzazione.

removedFromSpacePayload

object (RemovedFromSpacePayload)

Un utente rimuove l'app Chat da uno spazio.

buttonClickedPayload

object (ButtonClickedPayload)

Rappresenta i dati del payload quando un utente interagisce con un elemento interattivo di una scheda o di una finestra di dialogo che attiva un callback Action. Nonostante il nome, questo payload viene compilato per tutti i callback di schede e finestre di dialogo Action, non solo per i clic sui pulsanti, ma anche per gli attivatori onChangeAction, le azioni onClick, i clic CardAction e l'invio o l'annullamento delle finestre di dialogo (SUBMIT_DIALOG e CANCEL_DIALOG).

Se un utente interagisce con una finestra di dialogo, il campo isDialogEvent di ButtonClickedPayload viene impostato su true e include un DialogEventType.

Il payload completo include anche commonEventObject.formInputs e commonEventObject.parameters.

widgetUpdatedPayload

object (WidgetUpdatedPayload)

Un utente aggiorna un widget in una scheda in-stream o in una finestra di dialogo.

Il payload completo include anche CommonEventObject.parameters['autocomplete_widget_query'].

appCommandPayload

object (AppCommandPayload)

Un utente richiama un comando dell'app.

systemCommandPayload

object (SystemCommandPayload)

Un utente richiama un comando di sistema.

Fine dei campi che si escludono a vicenda.

EventType

Il tipo di evento, compilato solo per gli eventi della home page dell'app nelle app di Chat che non sono componenti aggiuntivi.

Enum
EVENT_TYPE_UNSPECIFIED Valore predefinito per l'enum. NON UTILIZZARE.
APP_HOME Un utente apre un messaggio diretto da un'app di Chat che utilizza la home dell'app. Per gli eventi di questo tipo sono inclusi solo i campi type, user e space. Per saperne di più, consulta Crea una home page per un'app Google Chat.
SUBMIT_FORM Un utente invia informazioni in una scheda della home page dell'app. Per gli eventi di questo tipo sono inclusi solo i campi type, user e space. Per saperne di più, consulta [Crea una home page per un'app Google Chat]((https://developers.google.com/workspace/chat/send-app-home-card-message).

MessagePayload

Un utente invia un messaggio all'app di Chat o @menziona l'app di Chat in uno spazio. Le chiamate dei comandi dell'app (come i comandi slash e i comandi rapidi) utilizzano invece AppCommandPayload.

Rappresentazione JSON
{
  "space": {
    object (Space)
  },
  "message": {
    object (Message)
  },
  "configCompleteRedirectUri": string
}
Campi
space

object (Space)

Obbligatorio. Lo spazio di Chat in cui si verifica l'oggetto evento.

message

object (Message)

Il messaggio che attiva l'oggetto evento.

configCompleteRedirectUri

string

Facoltativo. L'URL a cui l'app di Chat deve reindirizzare l'utente dopo aver completato un flusso di autorizzazione o configurazione al di fuori di Google Chat. Per saperne di più, vedi Connetti un'app di Chat ad altri servizi e strumenti.

AddedToSpacePayload

Un utente aggiunge l'app Chat a uno spazio o viene creato un DM tra l'app e un utente.

Rappresentazione JSON
{
  "space": {
    object (Space)
  },
  "interactionAdd": boolean,
  "configCompleteRedirectUri": string
}
Campi
space

object (Space)

Obbligatorio. Lo spazio di Chat in cui si verifica l'oggetto evento.

interactionAdd

boolean

Indica se l'app è stata aggiunta allo spazio con un'interazione dell'utente (ad esempio, menzionando l'app Chat con @ o richiamandola con un comando slash). Se questo valore è impostato su true, all'app di Chat verrà inviato un oggetto evento separato associato all'interazione stessa.

configCompleteRedirectUri

string

Facoltativo. L'URL a cui l'app di Chat deve reindirizzare l'utente dopo aver completato un flusso di autorizzazione o configurazione al di fuori di Google Chat. Per saperne di più, vedi Connetti un'app di Chat ad altri servizi e strumenti.

RemovedFromSpacePayload

Un utente rimuove l'app Chat da uno spazio.

Rappresentazione JSON
{
  "space": {
    object (Space)
  }
}
Campi
space

object (Space)

Obbligatorio. Lo spazio di Chat in cui si verifica l'oggetto evento.

ButtonClickedPayload

Un utente interagisce con un elemento interattivo di una scheda o di una finestra di dialogo di un componente aggiuntivo di Chat che attiva un callback Action. Nonostante il nome, questo payload viene compilato per tutti i callback di schede e finestre di dialogo Action, inclusi i clic sui pulsanti, i trigger onChangeAction, le azioni onClick, i clic CardAction e l'invio o l'annullamento delle finestre di dialogo (SUBMIT_DIALOG e CANCEL_DIALOG).

Se un utente interagisce con una finestra di dialogo, il campo isDialogEvent di ButtonClickedPayload viene impostato su true e include un DialogEventType. Questo payload viene mappato ai tipi di eventi SUBMIT_FORM e CARD_CLICKED per le app di Chat che non sono componenti aggiuntivi.

Il payload completo include anche CommonEventObject.form_inputs e CommonEventObject.parameters.

Rappresentazione JSON
{
  "space": {
    object (Space)
  },
  "message": {
    object (Message)
  },
  "isDialogEvent": boolean,
  "dialogEventType": enum (DialogEventType)
}
Campi
space

object (Space)

Obbligatorio. Lo spazio di Chat in cui si verifica l'oggetto evento.

message

object (Message)

Il messaggio che attiva l'oggetto evento.

isDialogEvent

boolean

Per gli oggetti evento ButtonClicked e Message, indica se l'utente sta interagendo o sta per interagire con una finestra di dialogo.

dialogEventType

enum (DialogEventType)

Il tipo di oggetto evento dialog ricevuto.

DialogEventType

Per gli oggetti evento che contengono payload di eventi ButtonClicked o AppCommand, i tipi di interazioni con le finestre di dialogo.

Per scoprire di più sugli oggetti evento delle app Google Chat, consulta Ricevi e rispondi alle interazioni con la tua app Google Chat.

Enum
DIALOG_EVENT_TYPE_UNSPECIFIED Valore predefinito. Non specificato.
REQUEST_DIALOG Un utente apre una finestra di dialogo.
SUBMIT_DIALOG Un utente fa clic su un elemento interattivo 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.
CANCEL_DIALOG Un utente chiude una finestra di dialogo senza inviare informazioni o la finestra di dialogo viene annullata.

WidgetUpdatedPayload

Un utente aggiorna un widget in una scheda o finestra di dialogo in-stream.

Il payload completo include anche CommonEventObject.parameters['autocomplete_widget_query'].

Rappresentazione JSON
{
  "space": {
    object (Space)
  }
}
Campi
space

object (Space)

Obbligatorio. Lo spazio di Chat in cui si verifica l'oggetto evento.

AppCommandPayload

Un utente richiama un comando dell'app.

Rappresentazione JSON
{
  "appCommandMetadata": {
    object (AppCommandMetadata)
  },
  "space": {
    object (Space)
  },
  "thread": {
    object (Thread)
  },
  "message": {
    object (Message)
  },
  "configCompleteRedirectUri": string,
  "isDialogEvent": boolean,
  "dialogEventType": enum (DialogEventType)
}
Campi
appCommandMetadata

object (AppCommandMetadata)

Compilato per i comandi delle app, inclusi i comandi slash e i comandi rapidi.

space

object (Space)

Facoltativo. Lo spazio di Chat in cui si verifica l'oggetto evento.

thread

object (Thread)

Facoltativo. Il thread in cui si verifica l'oggetto evento, se applicabile. Questo campo viene compilato se l'oggetto evento è associato a un messaggio o a un thread specifico.

message

object (Message)

Facoltativo. Il messaggio che attiva l'oggetto evento, se applicabile. Questo campo viene compilato solo per i comandi slash.

configCompleteRedirectUri

string

Facoltativo. L'URL a cui l'utente deve essere reindirizzato dopo aver completato un flusso di autorizzazione o configurazione al di fuori di Google Chat. Per saperne di più, vedi Connetti un'app di Chat ad altri servizi e strumenti.

isDialogEvent

boolean

Facoltativo. Se l'utente sta interagendo o sta per interagire con una finestra di dialogo.

dialogEventType

enum (DialogEventType)

Facoltativo. Il tipo di oggetto evento dialog ricevuto. Questo campo si applica solo se isDialogEvent è true.

AppCommandMetadata

Metadati relativi a un comando dell'app di Chat.

Rappresentazione JSON
{
  "appCommandId": integer,
  "appCommandType": enum (AppCommandType)
}
Campi
appCommandId

integer

L'ID del comando specificato nella configurazione dell'API Chat.

appCommandType

enum (AppCommandType)

Il tipo di comando dell'app di Chat.

AppCommandType

Il tipo di comando dell'app di Chat. Per maggiori dettagli, vedi Tipi di comandi delle app di Chat.

Enum
APP_COMMAND_TYPE_UNSPECIFIED Valore predefinito. Non specificato.
SLASH_COMMAND Un comando slash. L'utente invia il comando in un messaggio chat.
QUICK_COMMAND Un comando rapido. L'utente seleziona il comando dal menu di Chat nell'area di risposta ai messaggi.
MESSAGE_ACTION Un'azione del messaggio. L'utente seleziona il comando dal menu contestuale del messaggio in Chat.

SystemCommandPayload

Un utente richiama un comando di sistema.

Rappresentazione JSON
{
  "systemCommandMetadata": {
    object (SystemCommandMetadata)
  },
  "space": string,
  "thread": {
    object (Thread)
  }
}
Campi
systemCommandMetadata

object (SystemCommandMetadata)

Metadati relativi al comando di sistema richiamato.

space

string

Facoltativo. Lo spazio di Chat in cui si verifica l'oggetto evento.

thread

object (Thread)

Facoltativo. Il thread in cui si verifica l'oggetto evento, se applicabile. Questo campo viene compilato se l'oggetto evento è associato a un messaggio o a un thread specifico.

SystemCommandMetadata

Metadati relativi a un comando di sistema attivato dall'utente.

Rappresentazione JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "cancelStream": {
    object (CancelStream)
  }
  // End of mutually exclusive fields.
}
Campi
Il comando di sistema richiamato. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
cancelStream

object (CancelStream)

Comando per annullare un messaggio di stream attivo.

Fine dei campi che si escludono a vicenda.

CancelStream

Comando per annullare un messaggio di stream attivo.

Rappresentazione JSON
{
  "streamMessage": string
}
Campi
streamMessage

string

Obbligatorio. Il nome della risorsa del messaggio dello stream su cui è stato eseguito il comando di annullamento.

Formato: spaces/{space}/streamMessages/{streamMessage}

WorkflowEventObject

LINT.IfChange L'oggetto evento passato ai componenti aggiuntivi di Workflow.

Rappresentazione JSON
{
  "executionMetadata": {
    object (ExecutionMetadata)
  },
  "triggerEventSource": enum (TriggerEventSource),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "actionInvocation": {
    object (ActionInvocation)
  },
  "triggerCreation": {
    object (TriggerCreation)
  },
  "triggerDeletion": {
    object (TriggerDeletion)
  },
  "resourceRetrieval": {
    object (ResourceRetrieval)
  },
  "elementConfiguration": {
    object (ElementConfiguration)
  },
  "resourceFieldsDefinitionRetrieval": {
    object (ResourceFieldsDefinitionRetrieval)
  },
  "elementUiAutocomplete": {
    object (ElementUiAutocomplete)
  }
  // End of mutually exclusive fields.
}
Campi
executionMetadata

object (ExecutionMetadata)

Metadati relativi all'esecuzione del workflow.

triggerEventSource

enum (TriggerEventSource)

Origine degli eventi di attivazione.

Il tipo di payload dell'evento del workflow. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
actionInvocation

object (ActionInvocation)

Chiamata di un'azione del workflow.

triggerCreation

object (TriggerCreation)

Creazione di un trigger del workflow.

triggerDeletion

object (TriggerDeletion)

Eliminazione di un trigger del workflow.

resourceRetrieval

object (ResourceRetrieval)

Recupero di una risorsa (utilizzato per l'inflazione delle variabili).

elementConfiguration

object (ElementConfiguration)

Configurazione di un elemento del workflow.

resourceFieldsDefinitionRetrieval

object (ResourceFieldsDefinitionRetrieval)

Il recupero delle definizioni dei campi supportate da una risorsa.

elementUiAutocomplete

object (ElementUiAutocomplete)

Suggerimenti di completamento automatico per la scheda attualmente visualizzata.

Fine dei campi che si escludono a vicenda.

ActionInvocation

Chiamata di un'azione del workflow.

Rappresentazione JSON
{
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "triggerId": string,
  "flowLevelContext": {
    object (FlowLevelContext)
  }
}
Campi
inputs

map (key: string, value: object (VariableData))

Mappa delle variabili di input con chiave in base al nome della variabile di input.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

triggerId

string

ID trigger da utilizzare per le risposte alle azioni asincrone.

flowLevelContext

object (FlowLevelContext)

Facoltativo. Contesto a livello di flusso dai passaggi precedenti.

VariableData

Rappresenta dati variabili, che possono contenere più valori di tipi diversi.

Rappresentazione JSON
{
  "booleanValues": [
    boolean
  ],
  "integerValues": [
    string
  ],
  "floatValues": [
    number
  ],
  "stringValues": [
    string
  ],
  "timestampValues": [
    string
  ],
  "resourceReferences": [
    {
      object (ResourceReference)
    }
  ],
  "emailAddressValues": [
    string
  ],
  "googleUserValues": [
    string
  ],
  "textFormatValues": [
    {
      object (WorkflowTextFormat)
    }
  ]
}
Campi
booleanValues[]

boolean

Valori booleani.

integerValues[]

string (int64 format)

Valori interi.

floatValues[]

number

Valori in virgola mobile.

stringValues[]

string

Valori stringa.

timestampValues[]

string (Timestamp format)

Valori timestamp.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

resourceReferences[]

object (ResourceReference)

Riferimenti alle risorse (ID).

emailAddressValues[]

string

Valori degli indirizzi email.

googleUserValues[]

string

Valori utente Google nel formato users/{user}.

textFormatValues[]

object (WorkflowTextFormat)

Valori del formato di testo del workflow.

ResourceReference

Valore ID della risorsa specifica dell'applicazione.

Rappresentazione JSON
{
  "resourceType": {
    object (ResourceType)
  },
  "resourceId": string
}
Campi
resourceType

object (ResourceType)

Il tipo di risorsa a cui punta questo ID.

resourceId

string

ID della risorsa.

ResourceType

Nome del tipo di risorsa personalizzata.

Rappresentazione JSON
{
  "workflowBundleId": string,
  "workflowResourceDefinitionId": string
}
Campi
workflowBundleId

string

ID del bundle del workflow proprietario di questo tipo di risorsa. Questo campo è facoltativo e, se vuoto, viene considerato lo stesso bundle in cui viene utilizzato.

workflowResourceDefinitionId

string

Identificatore univoco della risorsa. Deve essere univoco solo all'interno dello stesso bundle.

WorkflowTextFormat

Un blocco di testo con opzioni di formattazione avanzate, tra cui stili, link ipertestuali ed elementi interattivi.

Rappresentazione JSON
{
  "textFormatElements": [
    {
      object (TextFormatElement)
    }
  ]
}
Campi
textFormatElements[]

object (TextFormatElement)

Una raccolta di elementi di formattazione del testo.

TextFormatElement

Un singolo elemento all'interno di un messaggio WorkflowTextFormat, che può essere un chip, un testo con stile, un link ipertestuale o un contenitore di elenchi.

Rappresentazione JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "text": string,
  "chip": {
    object (Chip)
  },
  "styledText": {
    object (StyledText)
  },
  "hyperlink": {
    object (Hyperlink)
  },
  "listContainer": {
    object (ListContainer)
  }
  // End of mutually exclusive fields.
}
Campi
Elemento che rappresenta uno dei diversi elementi di formattazione del testo possibili. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
text

string

Testo nel formato testo.

chip

object (Chip)

Chip cliccabile nel formato di testo.

styledText

object (StyledText)

Testo con stile nel formato di testo.

listContainer

object (ListContainer)

Contenitore di elenchi nel formato di testo.

Fine dei campi che si escludono a vicenda.

Chip

Un chip cliccabile nel formato di testo.

Rappresentazione JSON
{
  "icon": {
    object (Icon)
  },
  "label": string,
  "url": string
}
Campi
icon

object (Icon)

L'icona visualizzata nel chip.

label

string

Il testo visualizzato nel chip.

url

string

L'URL a cui accedere quando si fa clic sul chip.

Icona

Un'icona nel chip.

Rappresentazione JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "iconUrl": string,
  "materialIconName": string
  // End of mutually exclusive fields.
}
Campi
L'icona visualizzata nel chip. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
iconUrl

string

Visualizza un'icona personalizzata ospitata su un URL HTTPS.

Ad esempio:

"iconUrl":
"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png"

I tipi di file supportati includono .png e .jpg.

materialIconName

string

Il nome dell'icona definito nell'icona Material di Google, ad esempio check_box. I nomi non validi vengono abbandonati e sostituiti con una stringa vuota, il che impedisce il rendering dell'icona.

Fine dei campi che si escludono a vicenda.

StyledText

Elemento di testo con stili come grassetto, corsivo e colore.

Rappresentazione JSON
{
  "text": string,
  "styles": [
    enum (Style)
  ],
  "fontWeight": enum (FontWeight),
  "color": {
    object (Color)
  },
  "wrapStyle": enum (WrapStyle)
}
Campi
text

string

Il contenuto principale del testo.

styles[]

enum (Style)

Una raccolta di stili applicati al testo.

fontWeight

enum (FontWeight)

Lo spessore del carattere del testo.

color

object (Color)

Il colore del testo.

wrapStyle

enum (WrapStyle)

Lo stile di ritorno a capo del testo.

Stile

Enum per diversi stili di testo, ad esempio corsivo, sottolineato e così via.

Enum
STYLE_UNSPECIFIED Nessuno stile applicato. NON UTILIZZARE.
ITALIC Stile corsivo.
UNDERLINE Stile sottolineatura.
STRIKETHROUGH Stile barrato.
LINE_BREAK Interruzione di riga.
UPPERCASE Stile maiuscolo.
CODE Codifica.
CODE_BLOCK Blocco di codice.

FontWeight

Enum per diversi spessori dei caratteri.

Enum
FONT_WEIGHT_UNSPECIFIED Peso standard con spessore normale. NON UTILIZZARE.
LIGHT Più leggero e con uno spessore ridotto.
MEDIUM Spessore intermedio tra leggero e grassetto.
BOLD Peso maggiore con spessore aumentato.

WrapStyle

Enum per diversi stili di ritorno a capo.

Enum
WRAP_STYLE_UNSPECIFIED Nessuno stile di ritorno a capo specificato.
NO_WRAP Nessuno stile di ritorno a capo.

ListContainer

Contenitore per gli elementi dell'elenco, in cui ogni elemento dell'elenco può contenere più TextFormatElement.

Rappresentazione JSON
{
  "listNestLevel": string,
  "listType": enum (ListType),
  "listItems": [
    {
      object (ListItem)
    }
  ]
}
Campi
listNestLevel

string (int64 format)

Il livello di nidificazione dell'elenco. Inizia da 0 per il livello superiore e aumenta di 1 per ogni elenco nidificato.

listType

enum (ListType)

Il tipo di elenco.

listItems[]

object (ListItem)

Una raccolta di elementi dell'elenco.

ListType

Enum per diversi tipi di elenco.

Enum
LIST_TYPE_UNSPECIFIED Nessun tipo di elenco specificato. NON UTILIZZARE.
ORDERED Elenco ordinato.
UNORDERED Elenco non ordinato.
BLOCKQUOTE Rappresenta un elenco di citazioni.

ListItem

Un elemento dell'elenco.

Rappresentazione JSON
{
  "textFormatElements": [
    {
      object (TextFormatElement)
    }
  ]
}
Campi
textFormatElements[]

object (TextFormatElement)

Una raccolta di elementi di formattazione del testo.

FlowLevelContext

Contesto a livello di flusso contenente gli output dei passaggi precedenti.

Rappresentazione JSON
{
  "stepContexts": [
    {
      object (StepContext)
    }
  ]
}
Campi
stepContexts[]

object (StepContext)

Facoltativo. Elenco dei passaggi precedenti. L'ordine è importante, quindi assicurati che l'ordine di esecuzione venga mantenuto in questo elenco.

StepContext

Metadati e output del contesto del passaggio per il contesto a livello di flusso.

Rappresentazione JSON
{
  "stepId": string,
  "outputs": {
    string: {
      object (VariableData)
    },
    ...
  }
}
Campi
stepId

string

Facoltativo. ID univoco del passaggio nel grafico del workflow.

outputs

map (key: string, value: object (VariableData))

Facoltativo. Mappa delle variabili di output prodotte da questo passaggio, con chiave in base al nome della variabile.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

TriggerCreation

Creazione di un trigger del workflow.

Rappresentazione JSON
{
  "triggerId": string,
  "triggerType": enum (TriggerType),
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "notifyUri": string
}
Campi
triggerId

string

Identificatore univoco del trigger fornito durante la creazione.

triggerType

enum (TriggerType)

Tipo di trigger.

inputs

map (key: string, value: object (VariableData))

Mappa delle variabili di input con chiave in base al nome della variabile di input.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

notifyUri

string

L'endpoint che verrà chiamato quando viene attivato il trigger.

TriggerType

Tipo di trigger.

Enum
TRIGGER_TYPE_UNDEFINED Valore predefinito. NON UTILIZZARE.
REPEATING L'attivatore si attiva ogni volta che vengono soddisfatte le condizioni di input.

TriggerDeletion

Eliminazione di un trigger del workflow.

Rappresentazione JSON
{
  "triggerId": string
}
Campi
triggerId

string

Identificatore univoco del trigger fornito durante la creazione.

ResourceRetrieval

Recupero di una risorsa.

Rappresentazione JSON
{
  "resourceReference": {
    object (ResourceReference)
  }
}
Campi
resourceReference

object (ResourceReference)

Tipo e ID della risorsa da recuperare.

ElementConfiguration

Chiamata durante la configurazione di un elemento del workflow.

Rappresentazione JSON
{
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "displayDestination": enum (DisplayDestination),
  "nodeId": string,
  "workflowId": string,
  "availableVariables": [
    {
      object (VariableReference)
    }
  ]
}
Campi
inputs

map (key: string, value: object (VariableData))

Mappa delle variabili di input con chiave in base al nome della variabile di input. Questa mappa potrebbe essere vuota. Utilizzato durante la configurazione di un singolo elemento del workflow (trigger o azione) nella home page del workflow.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

displayDestination

enum (DisplayDestination)

La destinazione della scheda di configurazione dell'elemento. Gli elementi possono utilizzare questo campo per restituire layout di schede di configurazione diversi in base alla destinazione.

nodeId

string

L'ID nodo della configurazione primitiva di cui viene eseguito il rendering.

workflowId

string

L'ID workflow della configurazione primitiva di cui viene eseguito il rendering.

availableVariables[]

object (VariableReference)

Variabili disponibili ordinate in base alla posizione del nodo.

DisplayDestination

Indica dove verrà visualizzata la scheda di configurazione dell'elemento di ritorno.

Enum
DISPLAY_DESTINATION_UNSPECIFIED Valore predefinito. NON UTILIZZARE.
DISPLAY_DESTINATION_SIDE_PANEL La scheda di configurazione deve essere visualizzata nel riquadro laterale.
DISPLAY_DESTINATION_FULL_SCREEN La scheda di configurazione deve essere visualizzata nell'app a schermo intero.

VariableReference

Un riferimento a una variabile nel workflow.

Rappresentazione JSON
{
  "parentElementId": string,
  "nodeId": string,
  "path": string,
  "dataType": {
    object (DataType)
  },
  "iconUrl": string,
  "stepNumber": integer,
  "descriptionText": string,
  "displayText": string
}
Campi
parentElementId

string

L'ID primitivo dell'elemento che produce la variabile. Se necessario, possiamo espanderlo a WorkflowElement o a un proto di metadati più dettagliato.

nodeId

string

ID riferimento nodo

path

string

La firma del percorso del selettore di variabili

dataType

object (DataType)

Il tipo di dati della variabile

iconUrl

string

L'URL dell'icona della primitiva che produce questa variabile.

stepNumber

integer

Il numero del passaggio della primitiva che produce questa variabile.

descriptionText

string

La descrizione della variabile.

displayText

string

Il testo visualizzato del chip di variabile.

DataType

Tipo di variabile.

Rappresentazione JSON
{
  "valueMetadata": {
    object (ValueMetadata)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "basicType": enum (BasicType),
  "resourceType": {
    object (ResourceType)
  }
  // End of mutually exclusive fields.
}
Campi
valueMetadata

object (ValueMetadata)

Metadati sui potenziali valori di una variabile.

Il tipo di dati. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
basicType

enum (BasicType)

Tipo di dati di base.

resourceType

object (ResourceType)

Tipo di ID risorsa dell'applicazione.

Fine dei campi che si escludono a vicenda.

BasicType

Tipi di dati generici di base.

Enum
BASIC_TYPE_UNSPECIFIED Valore predefinito. NON UTILIZZARE.
STRING Una stringa di caratteri.
INTEGER Un numero intero.
FLOAT Un numero con rappresentazione in virgola mobile.
TIMESTAMP Timestamp in formato ISO 8601.
BOOLEAN Un valore che può essere vero o falso.
EMAIL_ADDRESS Un indirizzo email, ovvero una stringa nel formato di un indirizzo email.
GOOGLE_USER Utente dei servizi Google, nel formato users/{user}.
FILE Riferimento file.
FORMATTED_TEXT Testo con formattazione RTF.

ValueMetadata

Informazioni sui potenziali valori di una variabile.

Rappresentazione JSON
{
  "enumValues": [
    string
  ],
  "dynamicTypes": [
    enum (BasicType)
  ],
  "semanticDescriptors": [
    {
      object (SemanticDescriptor)
    }
  ],
  "dynamicSchema": {
    object (DynamicSchema)
  },
  "defaultValue": string
}
Campi
enumValues[]

string

Facoltativo. Specifica i valori consentiti per una stringa. Questo valore può essere impostato solo se DataType è STRING.

dynamicTypes[]

enum (BasicType)

Facoltativo. Specifica i tipi consentiti che possono essere sottoposti a cast dinamico per una variabile. Questo valore può essere impostato solo se DataType è una stringa e la variabile è un output.

semanticDescriptors[]

object (SemanticDescriptor)

Facoltativo. Aiuta a descrivere il significato semantico di una variabile.

dynamicSchema

object (DynamicSchema)

Facoltativo. Configurazione per la risoluzione dinamica dello schema di questa variabile.

defaultValue

string

Facoltativo. Stringa che specifica il valore predefinito per questa variabile. Ad esempio, per i valori booleani, defaultValue può essere impostato su true o false.

SemanticDescriptor

Metadati sul significato semantico di una variabile.

Rappresentazione JSON
{
  "resourceAttribute": string,
  "disallowedResourceAttributes": [
    string
  ]
}
Campi
resourceAttribute

string

Indica che la variabile corrisponde a un attributo specifico di una risorsa. Questo è particolarmente utile per le variabili che rappresentano un identificatore per una risorsa (ID, URL, chiave e così via).

Il formato consigliato è: - "{brand}/{appName}/{resource}:{attribute}" {brand} è facoltativo e deve essere omesso se corrisponde a {appName}.

Esempi: - "google/drive/file:id" - "google/drive/folder:id" - "google/docs/document:id" - "google/sheets/spreadsheet:id" - "jira/issue:key" - "slack/channel:id" ecc.

Il client utilizzerà queste informazioni per suggerire all'utente quali variabili di output sono compatibili con un determinato input.

disallowedResourceAttributes[]

string

Facoltativo. Applicabile solo agli input e ignorato per gli output. Attributi non consentiti che corrispondono a questo descrittore semantico. Il client impedirà esplicitamente la selezione delle variabili per gli output che corrispondono a uno di questi attributi delle risorse non consentiti.

DynamicSchema

Configurazione per la risoluzione dinamica dello schema di questa variabile in fase di runtime.

Rappresentazione JSON
{
  "requiredInputIds": [
    string
  ],
  "strictEnum": boolean
}
Campi
requiredInputIds[]

string

ID delle variabili di input di pari livello che devono essere forniti prima che lo schema di questa variabile possa essere risolto in modo dinamico.

strictEnum

boolean

Se impostato su true, il valore della variabile deve corrispondere a uno dei valori enum risolti dinamicamente. Se il valore è false, i valori risolti dinamicamente vengono trattati come suggerimenti non rigidi.

ResourceFieldsDefinitionRetrieval

Recupera la definizione dei campi supportati da una risorsa.

Rappresentazione JSON
{
  "elementId": string,
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  }
}
Campi
elementId

string

Specifica l'ID dell'elemento di cui recuperare lo schema della risorsa dinamica.

inputs

map (key: string, value: object (VariableData))

Sono inclusi gli input dei campi del nodo che fornisce la variabile. Mappa delle variabili di input con chiave in base al nome della variabile di input.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

ElementUiAutocomplete

Suggerimenti di completamento automatico per la scheda attualmente visualizzata.

Rappresentazione JSON
{
  "query": string,
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "invokedFunction": string,
  "resourceId": string,
  "operationId": string
}
Campi
query

string

La query da completare automaticamente.

inputs

map (key: string, value: object (VariableData))

Mappa delle variabili di input con chiave in base al nome della variabile di input.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

invokedFunction

string

La funzione richiamata associata al widget.

resourceId

string

L'ID risorsa per cui deve essere eseguito il completamento automatico. Questo è un campo facoltativo e potrebbe non essere impostato.

operationId

string

L'ID dell'operazione che ha fornito la risorsa da completare automaticamente. Questo è un campo facoltativo e potrebbe non essere impostato.

ExecutionMetadata

Metadati relativi all'esecuzione del workflow.

Rappresentazione JSON
{
  "versionId": integer,
  "timeZone": string,
  "stepNumber": integer
}
Campi
versionId

integer

La versione dell'elemento del workflow richiamato.

timeZone

string

Il fuso orario del workflow in fase di salvataggio, ad esempio "America/Los_Angeles".

stepNumber

integer

Rappresenta il numero del passaggio della primitiva richiamata.

TriggerEventSource

Origine dell'evento trigger che ha attivato questa esecuzione.

Enum
TRIGGER_EVENT_SOURCE_UNSPECIFIED Valore predefinito. NON UTILIZZARE.
TRIGGER_EVENT_SOURCE_AUTOMATED L'esecuzione viene attivata automaticamente dagli eventi.
TRIGGER_EVENT_SOURCE_TEST_RUN L'esecuzione viene attivata tramite l'esecuzione del test.