Event

Ein Google Chat-App-Interaktionsereignis, das Daten zur Interaktion eines Nutzers mit einer Chat-App enthält. Weitere Informationen zum Konfigurieren Ihrer Chat-App für den Empfang von Interaktionsereignissen finden Sie unter Nutzerinteraktionen empfangen und darauf reagieren.

Chat-Apps können nicht nur Ereignisse von Nutzerinteraktionen erhalten, sondern auch Ereignisse zu Änderungen an Gruppenbereichen, z. B. wenn einem Gruppenbereich ein neues Mitglied hinzugefügt wird. Weitere Informationen zu Gruppenbereichsereignissen finden Sie unter Mit Ereignissen aus Google Chat arbeiten.

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)
  },
  "appCommandMetadata": {
    object (AppCommandMetadata)
  }
}
Felder
type

enum (EventType)

Der Typ der Nutzerinteraktion mit der Chat-App, z. B. MESSAGE oder ADDED_TO_SPACE.
eventTime

string (Timestamp format)

Der Zeitstempel, der angibt, wann das Interaktionsereignis stattgefunden hat.
token

string

Ein geheimer Wert, mit dem ältere Chat-Apps prüfen können, ob eine Anfrage von Google stammt. Google generiert das Token zufällig und sein Wert bleibt unverändert. Sie können das Token auf der Konfigurationsseite der Chat API in der Google Cloud Console abrufen, widerrufen oder neu generieren.

In modernen Chat-Apps wird dieses Feld nicht verwendet. Sie ist nicht in API-Antworten und auf der Konfigurationsseite der Chat API enthalten.
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)

Bei Interaktionsereignissen vom Typ ADDED_TO_SPACE, CARD_CLICKED und MESSAGE die Nachricht, die das Interaktionsereignis ausgelöst hat (falls zutreffend).
user

object (User)

Der Nutzer, der mit der Chat-App interagiert hat.
space

object (Space)

Der Bereich, in dem der Nutzer mit der Chat App interagiert hat.
action

object (FormAction)

Bei CARD_CLICKED-Interaktionsereignissen die Daten zur Formularaktion, die verknüpft werden, wenn ein Nutzer auf eine Karte oder ein Dialogfeld klickt. Weitere Informationen finden Sie unter Von Nutzern auf Karten eingegebene Formulardaten lesen.
configCompleteRedirectUrl

string

Für MESSAGE-Interaktionsereignisse: Die URL, zu der Nutzer weitergeleitet werden müssen, nachdem sie einen Autorisierungs- oder Konfigurationsvorgang außerhalb von Google Chat abgeschlossen haben. Weitere Informationen finden Sie unter Chat-App mit anderen Diensten und Tools verbinden.
isDialogEvent

boolean

Bei CARD_CLICKED- und MESSAGE-Interaktionsereignissen gibt an, ob der Nutzer mit einem Dialogfeld interagiert oder kurz davor steht.
dialogEventType

enum (DialogEventType)

Der Typ des empfangenen Dialog-Interaktionsereignisses.
common

object (CommonEventObject)

Stellt Informationen zum Client des Nutzers dar, z. B. die Sprache, die Host-App und die Plattform. Bei Chat-Apps umfasst CommonEventObject Informationen, die von Nutzern gesendet wurden, die mit Dialogfeldern interagiert haben, z. B. Daten, die auf einer Karte eingegeben wurden.
appCommandMetadata

object (AppCommandMetadata)

Wird für App-Befehle wie Slash-Befehle und Schnellbefehle verwendet.

CommonEventObject

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

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. „de-DE“.
hostApp

enum (HostApp)

Das Enum „hostApp“, das die App angibt, über die das Add-on aufgerufen wird. „Immer“ CHAT für Chat-Apps.
platform

enum (Platform)

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

object (TimeZone)

Die Zeitzonen-ID und der Zeitversatz gegenüber der koordinierten Weltzeit (UTC). Nur für die Ereignistypen CARD_CLICKED und SUBMIT_DIALOG unterstützt.
formInputs

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

Eine Zuordnung, die die Werte enthält, die ein Nutzer in ein Widget über eine Karte oder ein Dialogfeld eingibt. Die Zuordnungsschlüssel sind die String-IDs, die den einzelnen Widgets zugewiesen sind. Die Werte stellen Eingaben für das Widget dar.

Weitere Informationen finden Sie unter Von Nutzern eingegebene Informationen verarbeiten.
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 der Zeitversatz gegenüber der koordinierten Weltzeit (UTC). Nur für die Ereignistypen CARD_CLICKED und SUBMIT_DIALOG unterstützt.

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

string

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

integer

Der Zeitversatz der Nutzerzeitzone in Millisekunden gegenüber der koordinierten Weltzeit (UTC).

Eingaben

Datentypen, die Nutzer auf Karten oder in Dialogfeldern eingeben können. Der Eingabetyp hängt davon ab, welche Werte vom Widget akzeptiert werden.

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 das Widget nur einen Wert akzeptiert, z. B. ein TextInput-Widget, enthält die Liste ein Stringobjekt. Wenn für das Widget mehrere Werte zulässig sind, 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)

Datums- und Uhrzeiteingabewerte 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)

Zeitangaben aus einem DateTimePicker-Widget, das nur Zeitangaben akzeptiert

StringInputs

Eingabeparameter für normale Widgets. Bei Widgets mit einem einzelnen Wert ist es eine Liste mit einem einzelnen Wert. Bei mehrwertigen Widgets wie 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 der Epoche in Millisekunden.
hasDate

boolean

Gibt an, ob die Eingabe für datetime 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 der Epoche in Millisekunden.

TimeInput

Zeitangaben

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.

AppCommandMetadata

Mit App-Befehlen verknüpfte Metadaten. Mit App-Befehlen können Nutzer eine Chat-App aufrufen und mit ihr interagieren. Das können Slash-Befehle sein, die in das Eingabefeld eingegeben werden, oder Elemente, die direkt im Integrationsmenü ausgewählt werden.

JSON-Darstellung 
{
  "appCommandId": integer,
  "appCommandType": enum (AppCommandType)
}
Felder
appCommandId

integer

Die Befehls-ID für die jeweilige App-Interaktion.
appCommandType

enum (AppCommandType)

Der Typ des App-Befehls.