Event

Ein Interaktionsereignis mit einer Google Chat-App.

Weitere Informationen zu Interaktionsereignissen finden Sie unter Interaktionen mit der Google Chat-App empfangen und darauf reagieren. Informationen zu Ereignistypen und z. B. Ereignisnutzlasten finden Sie unter Arten von App-Interaktionsereignissen in Google Chat.

JSON-Darstellung
{
  "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)
  }
}
Felder
type

enum (EventType)

Die Art des Interaktionsereignisses. Weitere Informationen finden Sie im Hilfeartikel Arten von Interaktionsereignissen in Google Chat-Apps.

eventTime

string (Timestamp format)

Zeitstempel, der angibt, wann das Interaktionsereignis aufgetreten ist

token

string

Ein geheimer Wert, mit dem alte Chat-Apps prüfen können, ob eine Anfrage von Google stammt. Google generiert das Token nach dem Zufallsprinzip. Sein Wert bleibt statisch. Sie können das Token auf der Konfigurationsseite für die Chat API in der Google Cloud Console abrufen, widerrufen oder neu generieren.

In modernen Chat-Apps wird dieses Feld nicht verwendet. Er fehlt in den API-Antworten und auf der Konfigurationsseite für die Chat API.

threadKey

string

Der von der Chat-App definierte Schlüssel für den Thread, der mit dem Interaktionsereignis verknüpft ist. Weitere Informationen finden Sie unter spaces.messages.thread.threadKey.

message

object (Message)

Die Nachricht, die das Interaktionsereignis ausgelöst hat, falls zutreffend.

user

object (User)

Nutzer, der das Interaktionsereignis ausgelöst hat

space

object (Space)

Bereich, in dem das Interaktionsereignis aufgetreten ist

action

object (FormAction)

Bei CARD_CLICKED-Interaktionsereignissen die Formularaktionsdaten, die verknüpft werden, wenn ein Nutzer auf eine Karte oder einen Dialog klickt. Weitere Informationen finden Sie unter Von Nutzern auf Karten eingegebene Formulardaten lesen.

configCompleteRedirectUrl

string

Die URL, an die der Nutzer von der Chat-App weitergeleitet werden soll, nachdem er eine Autorisierung oder Konfiguration außerhalb von Google Chat abgeschlossen hat. Weitere Informationen finden Sie im Hilfeartikel Chat-App mit anderen Diensten und Tools verbinden.

isDialogEvent

boolean

Bei CARD_CLICKED-Interaktionsereignissen gibt dieser Wert an, ob der Nutzer mit einem Dialog interagiert hat.

dialogEventType

enum (DialogEventType)

Der Typ des empfangenen dialog-Interaktionsereignisses.

common

object (CommonEventObject)

Informationen zum Client des Nutzers, z. B. Sprache, Host-App und Plattform. Bei Chat-Apps enthält CommonEventObject Informationen von Nutzern, die mit Dialogfeldern interagieren, z. B. Daten, die auf einer Karte eingegeben wurden.

CommonEventObject

Informationen zum Client des Nutzers, z. B. Sprache, Host-App und Plattform. Bei Chat-Apps enthält CommonEventObject Daten von Nutzern, die mit Karten interagieren, z. B. Daten, die in Dialogfelder eingegeben werden.

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

string

Der vollständige locale.displayName im Format [ISO 639-Sprachcode]-[ISO 3166-Länder-/Regionscode], z. B. „en-US“.

hostApp

enum (HostApp)

Die hostApp-Enum, die die App angibt, über die das Add-on aufgerufen wird Bei Chat-Apps immer CHAT.

platform

enum (Platform)

Die Plattform-Enum, die die Plattform angibt, von der das Ereignis stammt (WEB, IOS oder ANDROID). Wird von Chat-Apps nicht unterstützt.

timeZone

object (TimeZone)

Die Zeitzonen-ID und die Abweichung von der koordinierten Weltzeit (UTC). Wird nur für die Ereignistypen CARD_CLICKED und SUBMIT_DIALOG unterstützt.

formInputs

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

Eine Karte mit den Werten, die ein Nutzer auf einer Karte oder einem Dialogfeld in ein Widget eingibt. Die Kartenschlüssel sind die String-IDs, die jedem Widget zugewiesen sind, und die Werte stellen Eingaben für das Widget dar.

Weitere Informationen finden Sie unter Von Nutzern eingegebene Verarbeitungsinformationen.

parameters

map (key: string, value: string)

Benutzerdefinierte Parameter, die an die aufgerufene Funktion übergeben werden. Sowohl Schlüssel als auch Werte müssen Strings sein.

invokedFunction

string

Name der aufgerufenen Funktion, die mit dem Widget verknüpft ist. Nur für Chat-Apps festgelegt.

TimeZone

Die Zeitzonen-ID und die Abweichung von der koordinierten Weltzeit (UTC). Wird nur für die Ereignistypen CARD_CLICKED und SUBMIT_DIALOG unterstützt.

JSON-Darstellung
{
  "id": string,
  "offset": integer
}
Felder
id

string

Der Code der IANA TZ-Zeitzone, z. B. „America/Toronto“.

offset

integer

Die Zeitzone des Nutzers in Millisekunden gegenüber der koordinierten Weltzeit (UTC).

Eingaben

Datentypen, die Nutzer in Karten oder Dialogfeldern eingeben können. Der Eingabetyp hängt vom Typ der Werte ab, die das Widget akzeptiert.

JSON-Darstellung
{

  // 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.
}
Felder

Union-Feld inputs.

Für inputs ist nur einer der folgenden Werte zulässig:

stringInputs

object (StringInputs)

Eine Liste von Strings, die die Werte darstellen, die der Nutzer in ein Widget eingibt.

Wenn für das Widget nur ein Wert akzeptiert wird, z. B. ein TextInput-Widget, enthält die Liste ein Stringobjekt. Wenn im Widget mehrere Werte akzeptiert werden, z. B. ein SelectionInput-Widget mit Kästchen, enthält die Liste ein Stringobjekt für jeden Wert, den der Nutzer eingibt oder auswählt.

dateTimeInput

object (DateTimeInput)

Eingabewerte für Datum und Uhrzeit aus einem DateTimePicker-Widget, das sowohl ein Datum als auch eine Uhrzeit akzeptiert.

dateInput

object (DateInput)

Datumseingabewerte aus einem DateTimePicker-Widget, das nur Datumswerte akzeptiert.

timeInput

object (TimeInput)

Zeiteingabewerte aus einem DateTimePicker-Widget, das nur Zeitwerte akzeptiert.

StringInputs

Eingabeparameter für normale Widgets. Bei einwertigen Widgets handelt es sich um eine Einzelwertliste. Bei Widgets mit mehreren Werten, z. B. „Kästchen“, werden alle Werte angezeigt.

JSON-Darstellung
{
  "value": [
    string
  ]
}
Felder
value[]

string

Eine Liste von Strings, die vom Nutzer eingegeben wurden.

DateTimeInput

Eingabewerte für Datum und Uhrzeit.

JSON-Darstellung
{
  "msSinceEpoch": string,
  "hasDate": boolean,
  "hasTime": boolean
}
Felder
msSinceEpoch

string (int64 format)

Zeit seit Epochenzeit in Millisekunden.

hasDate

boolean

Gibt an, ob die datetime-Eingabe ein Kalenderdatum enthält.

hasTime

boolean

Gibt an, ob die datetime-Eingabe einen Zeitstempel enthält.

DateInput

Datumseingabewerte.

JSON-Darstellung
{
  "msSinceEpoch": string
}
Felder
msSinceEpoch

string (int64 format)

Zeit seit Epochenzeit in Millisekunden.

TimeInput

Zeiteingabewerte.

JSON-Darstellung
{
  "hours": integer,
  "minutes": integer
}
Felder
hours

integer

Die Stunde im 24-Stunden-Format.

minutes

integer

Die Anzahl der Minuten nach der vollen Stunde. Gültige Werte sind 0 bis 59.