Event

Un evento di interazione con l'app di Google Chat che rappresenta e contiene i dati relativi all'interazione di un utente con un'app di 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 relativi alle interazioni degli utenti, le app di Chat possono ricevere eventi relativi a modifiche agli spazi, ad esempio l'aggiunta di un nuovo membro. Per saperne di più 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)
  }
}
Campi
type

enum (EventType)

Il tipo di interazione 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 secret che le app legacy di Chat possono utilizzare per verificare se una richiesta proviene da Google. Google genera il token in modo casuale e il suo valore rimane statico. 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 delle azioni 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 con MESSAGE, si tratta dell'URL a cui gli utenti devono essere reindirizzati dopo aver completato un flusso di autorizzazione o configurazione al di fuori di Google Chat. Per saperne di più, 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 della finestra di dialogo ricevuto.

common

object (CommonEventObject)

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

CommonEventObject

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

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 locale.displayName completo nel formato [codice lingua ISO 639]-[codice paese/regione ISO 3166], ad esempio "it-IT".

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 origine l'evento (WEB, IOS o ANDROID). Non supportata dalle app di chat.

timeZone

object (TimeZone)

L'ID fuso orario e la differenza rispetto al fuso orario UTC (Coordinated Universal Time). Supportate solo per i tipi di evento 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 mappa sono gli ID stringa assegnati a ciascun widget e i valori rappresentano gli input del widget.

Per maggiori dettagli, consulta Elaborare le informazioni inserite dagli utenti.

parameters

map (key: string, value: string)

Parametri personalizzati passati alla funzione richiamata. Le chiavi e i valori devono essere stringhe.

invokedFunction

string

Nome della funzione richiamata 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). Supportate solo per i tipi di evento CARD_CLICKED e SUBMIT_DIALOG.

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

string

Il codice del database del fuso orario IANA TZ, ad esempio "America/Toronto".

offset

integer

Lo scarto del fuso orario dell'utente, in millisecondi, dal fuso orario UTC (Coordinated Universal Time).

Input

Tipi di dati che gli utenti possono inserire nelle schede o nelle 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 di caselle di controllo SelectionInput, l'elenco contiene un oggetto stringa per ogni valore inserito o selezionato dall'utente.

dateTimeInput

object (DateTimeInput)

Data e ora inseriscono i valori da un widget di 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)

Ora i valori di input sono ora disponibili da un widget DateTimePicker che accetta solo valori temporali.

StringInputs

Parametro di input per i widget normali. Per i widget con un valore singolo, si tratta di un elenco di valori singoli. Per i widget a più valori, ad esempio 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 per data e ora.

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

string (int64 format)

Tempo trascorso dall'epoca, in millisecondi.

hasDate

boolean

Se l'input datetime include una data di calendario.

hasTime

boolean

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, in millisecondi.

TimeInput

Valori di input dell'ora.

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

integer

L'ora in un formato a 24 ore.

minutes

integer

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