- EventObject
- CommonEventObject
- HostApp
- Piattaforma
- TimeZone
- Input
- StringInputs
- DateTimeInput
- DateInput
- TimeInput
- AuthorizationEventObject
- CalendarEventObject
- Organizzatore
- Partecipante
- ConferenceData
- ConferenceSolution
- Chiave
- EntryPoint
- Parametri
- AddOnParameters
- Funzionalità
- DriveEventObject
- DriveItemMetadata
- GmailEventObject
- SheetsEventObject
- MatchedUrl
- SlidesEventObject
- DocsEventObject
- ChatEventObject
- EventType
- MessagePayload
- AddedToSpacePayload
- RemovedFromSpacePayload
- ButtonClickedPayload
- DialogEventType
- WidgetUpdatedPayload
- AppCommandPayload
- AppCommandMetadata
- AppCommandType
- SystemCommandPayload
- SystemCommandMetadata
- CancelStream
- WorkflowEventObject
- ActionInvocation
- VariableData
- ResourceReference
- ResourceType
- WorkflowTextFormat
- TextFormatElement
- Chip
- Icona
- StyledText
- Stile
- FontWeight
- WrapStyle
- Hyperlink
- ListContainer
- ListType
- ListItem
- FlowLevelContext
- StepContext
- TriggerCreation
- TriggerType
- TriggerDeletion
- ResourceRetrieval
- ElementConfiguration
- DisplayDestination
- VariableReference
- DataType
- BasicType
- ValueMetadata
- SemanticDescriptor
- DynamicSchema
- ResourceFieldsDefinitionRetrieval
- ElementUiAutocomplete
- ExecutionMetadata
- TriggerEventSource
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 ( |
| Campi | |
|---|---|
commonEventObject |
Un oggetto contenente informazioni comuni a tutti gli oggetti evento, indipendentemente dall'applicazione host. |
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 |
Presente solo se l'host chiamante è Google Calendar. Un oggetto contenente informazioni su calendari ed eventi. |
drive |
Presente solo se l'host chiamante è Google Drive. Un oggetto contenente informazioni su Drive. |
gmail |
Presente solo se l'host chiamante è Gmail. Un oggetto contenente informazioni di Gmail. |
sheets |
Presente solo se l'host chiamante è Fogli Google. Un oggetto contenente informazioni su Fogli. |
slides |
Presente solo se l'host chiamante è Presentazioni Google. Un oggetto contenente informazioni su Presentazioni. |
docs |
Presente solo se l'host chiamante è Documenti Google. Un oggetto contenente informazioni su Documenti. |
chat |
Presente solo se l'host chiamante è Google Chat. Un oggetto contenente informazioni sulla chat. |
workflow |
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 ( |
| Campi | |
|---|---|
userLocale |
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: Per attivare questo campo, devi impostare |
hostApp |
Indica l'app host in cui è attivo il componente aggiuntivo quando viene generato l'oggetto evento. I valori possibili sono i seguenti:
|
platform |
L'enum della piattaforma che indica la piattaforma da cui ha origine l'evento ( |
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 Supportato solo per i tipi di evento |
formInputs |
Una mappa contenente i valori attuali dei widget nella scheda visualizzata. Le chiavi della mappa sono i valori stringa 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
Esempio: per un widget di immissione di testo con
Esempio: per un widget con più valori con
Esempio: per un selettore con un
Esempio: per un selettore con un
Esempio: per un selettore con un Un oggetto contenente un elenco di coppie |
parameters |
Eventuali parametri aggiuntivi forniti a un'azione utilizzando 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 Un oggetto contenente un elenco di coppie |
invokedFunction |
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 |
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 |
Il codice del database dei fusi orari IANA TZ, ad esempio "America/Toronto". |
offset |
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 ( |
| Campi | |
|---|---|
| Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi: | |
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 |
dateTimeInput |
Valori di input di data e ora da un widget |
dateInput |
Valori di input della data da un widget |
timeInput |
Valori di input dell'ora da un widget |
| 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[] |
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 |
Tempo trascorso dall'epoca di Unix, in millisecondi. |
hasDate |
Se l'input |
hasTime |
Indica se l'input |
DateInput
Valori di input della data.
| Rappresentazione JSON |
|---|
{ "msSinceEpoch": string } |
| Campi | |
|---|---|
msSinceEpoch |
Tempo trascorso dall'epoca di Unix, in millisecondi. |
TimeInput
Valori di input dell'ora.
| Rappresentazione JSON |
|---|
{ "hours": integer, "minutes": integer } |
| Campi | |
|---|---|
hours |
L'ora in un orologio di 24 ore. |
minutes |
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 |
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 |
Un token ID utente finale, se vengono richiesti gli ambiti ID appropriati |
systemIdToken |
Un token ID per il service account dei componenti aggiuntivi di G Suite per questo deployment |
authorizedScopes[] |
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 ( |
| Campi | |
|---|---|
id |
L'ID evento. |
recurringEventId |
L'ID di un evento ricorrente. |
calendarId |
L'ID calendario. |
organizer |
Un oggetto che rappresenta l'organizzatore dell'evento. |
attendees[] |
Dati generati dagli utenti. Un elenco dei partecipanti all'evento nel calendario. |
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 |
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 |
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 |
L'indirizzo email del partecipante. |
displayName |
Il nome visualizzato del partecipante. |
organizer |
true se il partecipante è un organizzatore di questo evento. |
self |
true se questo partecipante rappresenta il calendario in cui viene visualizzato questo evento; false in caso contrario. |
resource |
true se il partecipante rappresenta una risorsa, ad esempio una stanza o un'attrezzatura; false in caso contrario. |
optional |
true se la presenza di questo partecipante è contrassegnata come facoltativa; false in caso contrario. |
responseStatus |
Lo stato della risposta del partecipante. I valori possibili sono i seguenti:
|
comment |
Il commento di risposta del partecipante, se presente. |
additionalGuests |
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 ( |
| Campi | |
|---|---|
conferenceId |
L'ID della conferenza. Questo ID consente alle applicazioni di tenere traccia delle conferenze; non devi mostrarlo agli utenti. |
conferenceSolution |
Un oggetto che rappresenta la soluzione per conferenze, ad esempio Hangouts o Google Meet. |
entryPoints[] |
L'elenco dei punti di accesso alla conferenza, ad esempio URL o numeri di telefono. |
notes |
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 |
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 ( |
| Campi | |
|---|---|
iconUri |
L'URI dell'icona visibile all'utente che rappresenta questa soluzione per conferenze. |
key |
La chiave che identifica in modo univoco la soluzione per conferenze per questo evento. |
name |
Il nome di questa soluzione per conferenze visibile all'utente (non localizzato). |
Chiave
| Rappresentazione JSON |
|---|
{ "type": string } |
| Campi | |
|---|---|
type |
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 |
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 |
Il tipo di punto di accesso. I valori possibili sono i seguenti:
|
label |
L'etichetta visibile all'utente per l'URI del punto di accesso (non localizzato). |
meetingCode |
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 |
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 |
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 |
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 |
L'URI dell'entry point. La lunghezza massima è di 1300 caratteri. La formattazione dipende dal tipo di punto di accesso:
|
regionCode |
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[] |
Caratteristiche dell'entry point. Al momento, queste funzionalità si applicano solo ai punti di accesso telefonici:
|
Parametri
| Rappresentazione JSON |
|---|
{
"addOnParameters": {
object ( |
| Campi | |
|---|---|
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 |
Un oggetto contenente un elenco di coppie |
Funzionalità
| Rappresentazione JSON |
|---|
{ "canSeeAttendees": boolean, "canAddAttendees": boolean, "canSeeConferenceData": boolean, "canSetConferenceData": boolean, "canAddAttachments": boolean } |
| Campi | |
|---|---|
canSeeAttendees |
Dati generati dagli utenti. true se il componente aggiuntivo può leggere l'elenco dei partecipanti all'evento; false in caso contrario. |
canAddAttendees |
Dati generati dagli utenti. true se il componente aggiuntivo può aggiungere nuovi partecipanti all'elenco dei partecipanti all'evento; false in caso contrario. |
canSeeConferenceData |
Dati generati dagli utenti. true se il componente aggiuntivo può leggere i dati della conferenza dell'evento; false in caso contrario. |
canSetConferenceData |
Dati generati dall'utente. true se il componente aggiuntivo può aggiornare i dati della conferenza dell'evento; false in caso contrario. |
canAddAttachments |
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 ( |
| Campi | |
|---|---|
selectedItems[] |
Un elenco di elementi (file o cartelle) selezionati in Drive. |
activeCursorItem |
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 |
L'ID dell'articolo selezionato. |
iconUrl |
L'URL dell'icona che rappresenta l'elemento selezionato. |
mimeType |
Il tipo MIME dell'elemento selezionato. |
title |
Il titolo dell'elemento selezionato. |
addonHasFileScopePermission |
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 |
L'ID del messaggio Gmail attualmente aperto. |
threadId |
L'ID del thread di Gmail attualmente aperto. |
accessToken |
Il token di accesso specifico per Gmail. Puoi utilizzare questo token con il metodo |
toRecipients[] |
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 |
ccRecipients[] |
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 |
bccRecipients[] |
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 |
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 ( |
| Campi | |
|---|---|
id |
Presente solo se l'ambito |
title |
Presente solo se l'ambito |
addonHasFileScopePermission |
Se |
matchedUrl |
Presente solo se sono soddisfatte le seguenti condizioni:
L'URL del link che genera un'anteprima in Fogli Google. Per utilizzare questo campo, devi configurare Esempio di payload per quando un utente visualizza l'anteprima del link |
MatchedUrl
Oggetto evento restituito con le richieste di anteprima dei link.
| Rappresentazione JSON |
|---|
{ "url": string } |
| Campi | |
|---|---|
url |
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 ( |
| Campi | |
|---|---|
id |
Presente solo se l'ambito |
title |
Presente solo se l'ambito |
addonHasFileScopePermission |
Se |
matchedUrl |
Presente solo se sono soddisfatte le seguenti condizioni:
L'URL del link che genera un'anteprima in Presentazioni Google. Per utilizzare questo campo, devi configurare Esempio di payload per quando un utente visualizza l'anteprima del link |
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 ( |
| Campi | |
|---|---|
id |
Presente solo se l'ambito |
title |
Presente solo se l'ambito |
addonHasFileScopePermission |
Se |
matchedUrl |
Presente solo se sono soddisfatte le seguenti condizioni:
L'URL del link che genera un'anteprima in Documenti Google. Per utilizzare questo campo, devi configurare Esempio di payload per quando un utente visualizza l'anteprima del link |
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 ( |
| Campi | |
|---|---|
type |
Il tipo di evento, compilato solo per gli eventi della home page dell'app nelle app di Chat che non sono componenti aggiuntivi. |
user |
L'utente che interagisce con l'app di Chat. |
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 |
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: |
| 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 |
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 |
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 |
Un utente rimuove l'app Chat da uno spazio. |
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 Se un utente interagisce con una finestra di dialogo, il campo Il payload completo include anche |
widgetUpdatedPayload |
Un utente aggiorna un widget in una scheda in-stream o in una finestra di dialogo. Il payload completo include anche |
appCommandPayload |
Un utente richiama un comando dell'app. |
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 ( |
| Campi | |
|---|---|
space |
Obbligatorio. Lo spazio di Chat in cui si verifica l'oggetto evento. |
message |
Il messaggio che attiva l'oggetto evento. |
configCompleteRedirectUri |
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 ( |
| Campi | |
|---|---|
space |
Obbligatorio. Lo spazio di Chat in cui si verifica l'oggetto evento. |
interactionAdd |
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 |
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 ( |
| Campi | |
|---|---|
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 ( |
| Campi | |
|---|---|
space |
Obbligatorio. Lo spazio di Chat in cui si verifica l'oggetto evento. |
message |
Il messaggio che attiva l'oggetto evento. |
isDialogEvent |
Per gli oggetti evento |
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 ( |
| Campi | |
|---|---|
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 ( |
| Campi | |
|---|---|
appCommandMetadata |
Compilato per i comandi delle app, inclusi i comandi slash e i comandi rapidi. |
space |
Facoltativo. Lo spazio di Chat in cui si verifica l'oggetto evento. |
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 |
Facoltativo. Il messaggio che attiva l'oggetto evento, se applicabile. Questo campo viene compilato solo per i comandi slash. |
configCompleteRedirectUri |
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 |
Facoltativo. Se l'utente sta interagendo o sta per interagire con una finestra di dialogo. |
dialogEventType |
Facoltativo. Il tipo di oggetto evento dialog ricevuto. Questo campo si applica solo se |
AppCommandMetadata
Metadati relativi a un comando dell'app di Chat.
| Rappresentazione JSON |
|---|
{
"appCommandId": integer,
"appCommandType": enum ( |
| Campi | |
|---|---|
appCommandId |
L'ID del comando specificato nella configurazione dell'API Chat. |
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 ( |
| Campi | |
|---|---|
systemCommandMetadata |
Metadati relativi al comando di sistema richiamato. |
space |
Facoltativo. Lo spazio di Chat in cui si verifica l'oggetto evento. |
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 ( |
| 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 |
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 |
Obbligatorio. Il nome della risorsa del messaggio dello stream su cui è stato eseguito il comando di annullamento. Formato: |
WorkflowEventObject
LINT.IfChange L'oggetto evento passato ai componenti aggiuntivi di Workflow.
| Rappresentazione JSON |
|---|
{ "executionMetadata": { object ( |
| Campi | |
|---|---|
executionMetadata |
Metadati relativi all'esecuzione del workflow. |
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 |
Chiamata di un'azione del workflow. |
triggerCreation |
Creazione di un trigger del workflow. |
triggerDeletion |
Eliminazione di un trigger del workflow. |
resourceRetrieval |
Recupero di una risorsa (utilizzato per l'inflazione delle variabili). |
elementConfiguration |
Configurazione di un elemento del workflow. |
resourceFieldsDefinitionRetrieval |
Il recupero delle definizioni dei campi supportate da una risorsa. |
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 ( |
| Campi | |
|---|---|
inputs |
Mappa delle variabili di input con chiave in base al nome della variabile di input. Un oggetto contenente un elenco di coppie |
triggerId |
ID trigger da utilizzare per le risposte alle azioni asincrone. |
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 ( |
| Campi | |
|---|---|
booleanValues[] |
Valori booleani. |
integerValues[] |
Valori interi. |
floatValues[] |
Valori in virgola mobile. |
stringValues[] |
Valori stringa. |
timestampValues[] |
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: |
resourceReferences[] |
Riferimenti alle risorse (ID). |
emailAddressValues[] |
Valori degli indirizzi email. |
googleUserValues[] |
Valori utente Google nel formato |
textFormatValues[] |
Valori del formato di testo del workflow. |
ResourceReference
Valore ID della risorsa specifica dell'applicazione.
| Rappresentazione JSON |
|---|
{
"resourceType": {
object ( |
| Campi | |
|---|---|
resourceType |
Il tipo di risorsa a cui punta questo ID. |
resourceId |
ID della risorsa. |
ResourceType
Nome del tipo di risorsa personalizzata.
| Rappresentazione JSON |
|---|
{ "workflowBundleId": string, "workflowResourceDefinitionId": string } |
| Campi | |
|---|---|
workflowBundleId |
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 |
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 ( |
| Campi | |
|---|---|
textFormatElements[] |
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 ( |
| 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 |
Testo nel formato testo. |
chip |
Chip cliccabile nel formato di testo. |
styledText |
Testo con stile nel formato di testo. |
hyperlink |
Link ipertestuale nel formato di testo. |
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 ( |
| Campi | |
|---|---|
icon |
L'icona visualizzata nel chip. |
label |
Il testo visualizzato nel chip. |
url |
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 |
Visualizza un'icona personalizzata ospitata su un URL HTTPS. Ad esempio: I tipi di file supportati includono |
materialIconName |
Il nome dell'icona definito nell'icona Material di Google, ad esempio |
| 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 ( |
| Campi | |
|---|---|
text |
Il contenuto principale del testo. |
styles[] |
Una raccolta di stili applicati al testo. |
fontWeight |
Lo spessore del carattere del testo. |
color |
Il colore del testo. |
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. |
Link ipertestuale
Elemento link ipertestuale con testo e link.
| Rappresentazione JSON |
|---|
{ "link": string, "text": string } |
| Campi | |
|---|---|
link |
L'URL di destinazione del link ipertestuale. |
text |
Il testo del link ipertestuale. |
ListContainer
Contenitore per gli elementi dell'elenco, in cui ogni elemento dell'elenco può contenere più TextFormatElement.
| Rappresentazione JSON |
|---|
{ "listNestLevel": string, "listType": enum ( |
| Campi | |
|---|---|
listNestLevel |
Il livello di nidificazione dell'elenco. Inizia da 0 per il livello superiore e aumenta di 1 per ogni elenco nidificato. |
listType |
Il tipo di elenco. |
listItems[] |
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 ( |
| Campi | |
|---|---|
textFormatElements[] |
Una raccolta di elementi di formattazione del testo. |
FlowLevelContext
Contesto a livello di flusso contenente gli output dei passaggi precedenti.
| Rappresentazione JSON |
|---|
{
"stepContexts": [
{
object ( |
| Campi | |
|---|---|
stepContexts[] |
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 ( |
| Campi | |
|---|---|
stepId |
Facoltativo. ID univoco del passaggio nel grafico del workflow. |
outputs |
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 |
TriggerCreation
Creazione di un trigger del workflow.
| Rappresentazione JSON |
|---|
{ "triggerId": string, "triggerType": enum ( |
| Campi | |
|---|---|
triggerId |
Identificatore univoco del trigger fornito durante la creazione. |
triggerType |
Tipo di trigger. |
inputs |
Mappa delle variabili di input con chiave in base al nome della variabile di input. Un oggetto contenente un elenco di coppie |
notifyUri |
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 |
Identificatore univoco del trigger fornito durante la creazione. |
ResourceRetrieval
Recupero di una risorsa.
| Rappresentazione JSON |
|---|
{
"resourceReference": {
object ( |
| Campi | |
|---|---|
resourceReference |
Tipo e ID della risorsa da recuperare. |
ElementConfiguration
Chiamata durante la configurazione di un elemento del workflow.
| Rappresentazione JSON |
|---|
{ "inputs": { string: { object ( |
| Campi | |
|---|---|
inputs |
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 |
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 |
L'ID nodo della configurazione primitiva di cui viene eseguito il rendering. |
workflowId |
L'ID workflow della configurazione primitiva di cui viene eseguito il rendering. |
availableVariables[] |
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 ( |
| Campi | |
|---|---|
parentElementId |
L'ID primitivo dell'elemento che produce la variabile. Se necessario, possiamo espanderlo a WorkflowElement o a un proto di metadati più dettagliato. |
nodeId |
ID riferimento nodo |
path |
La firma del percorso del selettore di variabili |
dataType |
Il tipo di dati della variabile |
iconUrl |
L'URL dell'icona della primitiva che produce questa variabile. |
stepNumber |
Il numero del passaggio della primitiva che produce questa variabile. |
descriptionText |
La descrizione della variabile. |
displayText |
Il testo visualizzato del chip di variabile. |
DataType
Tipo di variabile.
| Rappresentazione JSON |
|---|
{ "valueMetadata": { object ( |
| Campi | |
|---|---|
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 |
Tipo di dati di base. |
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 ( |
| Campi | |
|---|---|
enumValues[] |
Facoltativo. Specifica i valori consentiti per una stringa. Questo valore può essere impostato solo se |
dynamicTypes[] |
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[] |
Facoltativo. Aiuta a descrivere il significato semantico di una variabile. |
dynamicSchema |
Facoltativo. Configurazione per la risoluzione dinamica dello schema di questa variabile. |
defaultValue |
Facoltativo. Stringa che specifica il valore predefinito per questa variabile. Ad esempio, per i valori booleani, |
SemanticDescriptor
Metadati sul significato semantico di una variabile.
| Rappresentazione JSON |
|---|
{ "resourceAttribute": string, "disallowedResourceAttributes": [ string ] } |
| Campi | |
|---|---|
resourceAttribute |
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 è: - Esempi: - Il client utilizzerà queste informazioni per suggerire all'utente quali variabili di output sono compatibili con un determinato input. |
disallowedResourceAttributes[] |
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[] |
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 |
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 ( |
| Campi | |
|---|---|
elementId |
Specifica l'ID dell'elemento di cui recuperare lo schema della risorsa dinamica. |
inputs |
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 |
ElementUiAutocomplete
Suggerimenti di completamento automatico per la scheda attualmente visualizzata.
| Rappresentazione JSON |
|---|
{
"query": string,
"inputs": {
string: {
object ( |
| Campi | |
|---|---|
query |
La query da completare automaticamente. |
inputs |
Mappa delle variabili di input con chiave in base al nome della variabile di input. Un oggetto contenente un elenco di coppie |
invokedFunction |
La funzione richiamata associata al widget. |
resourceId |
L'ID risorsa per cui deve essere eseguito il completamento automatico. Questo è un campo facoltativo e potrebbe non essere impostato. |
operationId |
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 |
La versione dell'elemento del workflow richiamato. |
timeZone |
Il fuso orario del workflow in fase di salvataggio, ad esempio "America/Los_Angeles". |
stepNumber |
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. |