Event

Un evento di interazione con l'app Google Chat che rappresenta e contiene dati sull'interazione di un utente con un'app Chat. Per configurare l'app Chat in modo che riceva gli eventi di interazione, consulta Ricevere e rispondere alle interazioni degli utenti.

Oltre a ricevere eventi dalle interazioni degli utenti, le app di Chat possono ricevere eventi relativi alle modifiche degli spazi, ad esempio quando viene aggiunto un nuovo membro a uno spazio. Per informazioni sugli eventi dello spazio, vedi Utilizzare gli eventi di Google Chat.

Rappresentazione JSON 
{
  "type": enum (EventType),
  "eventTime": string,
  "token": string,
  "threadKey": string,
  "message": {
    object (Message)
  },
  "user": {
    object (User)
  },
  "space": {
    object (Space)
  },
  "action": {
    object (FormAction)
  },
  "configCompleteRedirectUrl": string,
  "isDialogEvent": boolean,
  "dialogEventType": enum (DialogEventType),
  "common": {
    object (CommonEventObject)
  },
  "appCommandMetadata": {
    object (AppCommandMetadata)
  }
}
Campi
type

enum (EventType)

Il tipo di interazione dell'utente con l'app Chat, ad esempio MESSAGE o ADDED_TO_SPACE.
eventTime

string (Timestamp format)

Il timestamp che indica quando si è verificato l'evento di interazione.
token

string

Un valore segreto che le app Chat precedenti possono utilizzare per verificare se una richiesta proviene da Google. Google genera il token in modo casuale e il suo valore rimane invariato. Puoi ottenere, revocare o rigenerare il token dalla pagina di configurazione dell'API Chat nella console Google Cloud.

Le app di Chat moderne non utilizzano questo campo. Non è presente nelle risposte dell'API e nella pagina di configurazione dell'API Chat.
threadKey

string

La chiave definita dall'app Chat per il thread relativo all'evento di interazione. Per ulteriori informazioni, visita la pagina spaces.messages.thread.threadKey.
message

object (Message)

Per gli eventi di interazione ADDED_TO_SPACE, CARD_CLICKED e MESSAGE, il messaggio che ha attivato l'evento di interazione, se applicabile.
user

object (User)

L'utente che ha interagito con l'app Chat.
space

object (Space)

Lo spazio in cui l'utente ha interagito con l'app Chat.
action

object (FormAction)

Per gli eventi di interazione CARD_CLICKED, i dati sull'azione del modulo associati quando un utente fa clic su una scheda o una finestra di dialogo. Per scoprire di più, consulta Leggere i dati dei moduli inseriti dagli utenti nelle schede.
configCompleteRedirectUrl

string

Per gli eventi di interazione MESSAGE, l'URL a cui gli utenti devono essere reindirizzati dopo aver completato un flusso di autorizzazione o configurazione al di fuori di Google Chat. Per ulteriori informazioni, vedi Collegare un'app di Chat ad altri servizi e strumenti.
isDialogEvent

boolean

Per gli eventi di interazione CARD_CLICKED e MESSAGE, indica se l'utente sta interagendo o sta per interagire con una finestra di dialogo.
dialogEventType

enum (DialogEventType)

Il tipo di evento di interazione con la finestra di dialogo ricevuto.
common

object (CommonEventObject)

Rappresenta informazioni sul client dell'utente, ad esempio le impostazioni internazionali, l'app host e la piattaforma. Per le app di chat, CommonEventObject include le informazioni inviate dagli utenti che interagiscono con le dialoghe, ad esempio i dati inseriti in una scheda.
appCommandMetadata

object (AppCommandMetadata)

Viene compilato per i comandi delle app, inclusi i comandi slash e i comandi rapidi.

CommonEventObject

Rappresenta informazioni sul client dell'utente, ad esempio le impostazioni internazionali, l'app host e la piattaforma. Per le app di Chat, CommonEventObject include i dati inviati dagli utenti che interagiscono con le schede, ad esempio i dati inseriti nelle dialoghe.

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

Il valore completo di locale.displayName nel formato [codice lingua ISO 639]-[codice paese/regione ISO 3166], ad esempio "en-US".
hostApp

enum (HostApp)

L'enum hostApp che indica l'app da cui viene richiamato il componente aggiuntivo. Sempre CHAT per le app di chat.
platform

enum (Platform)

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

object (TimeZone)

L'ID fuso orario e la differenza rispetto al fuso orario UTC (Coordinated Universal Time). Supportato solo per i tipi di eventi CARD_CLICKED e SUBMIT_DIALOG.
formInputs

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

Una mappa contenente i valori inseriti da un utente in un widget da una scheda o una finestra di dialogo. Le chiavi della mappa sono gli ID stringa assegnati a ciascun widget e i valori rappresentano gli input al widget.

Per maggiori dettagli, vedi Elaborare le informazioni inserite dagli utenti.
parameters

map (key: string, value: string)

Parametri personalizzati passati alla funzione invocata. Sia le chiavi che i valori devono essere stringhe.
invokedFunction

string

Nome della funzione invocata associata al widget. Impostato solo per le app di Chat.

TimeZone

L'ID fuso orario e la differenza rispetto al fuso orario UTC (Coordinated Universal Time). Supportato solo per i tipi di eventi 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

Lo scostamento del fuso orario dell'utente, in millisecondi, dal tempo universale coordinato (UTC).

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 
{

  // Union field inputs can be only one of the following:
  "stringInputs": {
    object (StringInputs)
  },
  "dateTimeInput": {
    object (DateTimeInput)
  },
  "dateInput": {
    object (DateInput)
  },
  "timeInput": {
    object (TimeInput)
  }
  // End of list of possible types for union field inputs.
}
Campi

Campo unione inputs.

inputs può essere solo uno dei seguenti:
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 immissione di data e ora da un widget DateTimePicker che accetta sia una data che un'ora.
dateInput

object (DateInput)

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

object (TimeInput)

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

StringInputs

Parametro di input per i widget normali. Per i widget con un solo valore, si tratta di un elenco con un solo valore. Per i widget con più valori, come le caselle 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 dall'ora di inizio, in millisecondi.
hasDate

boolean

Indica 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 dall'ora di inizio, in millisecondi.

TimeInput

Valori di input relativi all'ora.

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

integer

L'ora su un orologio 24 ore.
minutes

integer

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

AppCommandMetadata

Metadati associati ai comandi dell'app. I comandi dell'app consentono agli utenti di richiamare e interagire con un'app di Chat. Possono essere comandi slash digitati nella casella di composizione o elementi selezionati direttamente dal menu di integrazione.

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

integer

L'ID comando per l'interazione con l'app in questione.
appCommandType

enum (AppCommandType)

Il tipo di comando dell'app.