Event

Un evento di interazione con l'app Google Chat.

Per saperne di più sugli eventi di interazione, consulta Ricevere e rispondere alle interazioni con l'app Google Chat. Per saperne di più sui tipi di eventi, ad esempio sui payload di eventi, consulta l'articolo Tipi di eventi di interazione con l'app Google Chat.

Oltre a ricevere eventi dalle interazioni degli utenti, le app di chat possono ricevere eventi relativi alle modifiche agli spazi, ad esempio quando viene aggiunto un nuovo membro a uno spazio. Per scoprire di più sugli eventi dello spazio, vedi Lavorare con 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 evento di interazione. Per maggiori dettagli, consulta Tipi di eventi di interazione con l'app Google Chat.

eventTime

string (Timestamp format)

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

token

string

Un valore del secret che le app di chat legacy 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 in Google Cloud Console.

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 di Chat per il thread relativo all'evento di interazione. Per saperne di più, visita la pagina spaces.messages.thread.threadKey.

message

object (Message)

Il messaggio che ha attivato l'evento di interazione, se applicabile.

user

object (User)

L'utente che ha attivato l'evento di interazione.

space

object (Space)

Lo spazio in cui si è verificato l'evento di interazione.

action

object (FormAction)

Per gli eventi di interazione CARD_CLICKED, i dati sulle azioni del modulo associati a 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

L'URL a cui l'app di Chat deve reindirizzare l'utente dopo che ha 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, indica se l'utente ha interagito con una finestra di dialogo.

dialogEventType

enum (DialogEventType)

Il tipo di evento di interazione dialog ricevuto.

common

object (CommonEventObject)

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

CommonEventObject

Rappresenta le informazioni sul client dell'utente, come 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 quelli inseriti nelle finestre.

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 locale.displayName completo 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'enumerazione della piattaforma che indica la piattaforma da cui ha avuto origine l'evento (WEB, IOS o ANDROID). Non supportata dalle app di chat.

timeZone

object (TimeZone)

L'ID del fuso orario e la differenza rispetto al fuso orario UTC (Coordinated Universal Time). Funzionalità supportata 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 mappa sono gli ID stringa assegnati a ogni widget e i valori rappresentano gli input del widget.

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

parameters

map (key: string, value: string)

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

invokedFunction

string

Nome della funzione richiamata associata al widget. Impostato solo per le app di chat.

TimeZone

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

La differenza, in millisecondi, per il fuso orario dell'utente rispetto al fuso orario UTC (Coordinated Universal Time).

nascosti

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 di 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 contenente caselle di controllo, l'elenco contiene un oggetto stringa per ogni valore inserito o selezionato dall'utente.

dateTimeInput

object (DateTimeInput)

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

dateInput

object (DateInput)

I valori di input delle date da un widget DateTimePicker che accetta solo valori di data.

timeInput

object (TimeInput)

Valori di input relativi all'ora da un widget DateTimePicker che accetta solo valori temporali.

StringInputs

Parametro di input per i widget normali. Per i widget con 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 di data e ora.

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

string (int64 format)

Tempo trascorso dall'epoca, in millisecondi.

hasDate

boolean

Indica se l'input datetime include una data di calendario.

hasTime

boolean

Se l'input datetime include un timestamp.

DateInput

Valori di input delle date.

Rappresentazione JSON
{
  "msSinceEpoch": string
}
Campi
msSinceEpoch

string (int64 format)

Tempo trascorso dall'epoca, in millisecondi.

TimeInput

Valori di input relativi all'ora.

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

integer

L'ora su un orologio a 24 ore.

minutes

integer

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