Hast du 5 Minuten Zeit? Nehmen Sie an dieser kurzen Umfrage teil und helfen Sie uns, die Dokumentation für Google Chat-Entwickler zu verbessern.

Event

Ein Google Chat-Interaktionsereignis.

Weitere Informationen zu Interaktionsereignissen finden Sie unter Interaktionen mit der Google Chat App empfangen und darauf reagieren. Weitere Informationen zu Ereignistypen und zum Beispiel als Ereignisnutzlasten finden Sie unter Arten von 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 unter Arten von Interaktionsereignissen.
eventTime

string (Timestamp format)

Der Zeitstempel, der angibt, wann das Interaktionsereignis aufgetreten ist.
token

string

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

In modernen Chat-Apps wird dieses Feld nicht verwendet. Sie fehlt in API-Antworten und auf der Seite der Chat API-Konfiguration.
threadKey

string

Der Chat-App-definierte Schlüssel für den Thread, der sich auf das Interaktionsereignis bezieht. Weitere Informationen finden Sie unter spaces.messages.thread.threadKey.
message

object (Message)

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

object (User)

Der Nutzer, der das Interaktionsereignis ausgelöst hat.
space

object (Space)

Der Bereich, in dem das Interaktionsereignis aufgetreten ist.
action

object (FormAction)

Bei CARD_CLICKED-Interaktionsereignissen die Daten zu Formularaktionen, die zugeordnet werden, wenn ein Nutzer auf eine Karte oder ein Dialogfeld klickt. Weitere Informationen finden Sie unter Eingabe von Formulardaten durch Nutzer auf Karten lesen.
configCompleteRedirectUrl

string

Die URL, zu der die Google Chat App den Nutzer weiterleiten soll, nachdem er eine Autorisierung oder einen Konfigurationsvorgang außerhalb von Google Chat abgeschlossen hat. Weitere Informationen finden Sie unter Google Chat App mit anderen Diensten und Tools verbinden.
isDialogEvent

boolean

Gibt an, ob der Nutzer bei CARD_CLICKED-Interaktionsereignissen mit einem Dialogfeld interagiert hat.
dialogEventType

enum (DialogEventType)

Typ des empfangenen dialog-Interaktionsereignisses.
common

object (CommonEventObject)

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

CommonEventObject

Gibt Informationen zum Client des Nutzers ab, z. B. Sprache, Host-App und Plattform. Bei Chat-Apps umfasst die App „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. "en-US".
hostApp

enum (HostApp)

Der HostApp-Enum, der die App angibt, über die das Add-on aufgerufen wird. Immer CHAT für Chat-Apps.
platform

enum (Platform)

Die Plattform, die die Plattform angibt, von der das Ereignis stammt, also WEB, IOS oder ANDROID. Wird in 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 aktuellen Werten der Widgets in einer Karte Die Kartenschlüssel sind die String-IDs, die den einzelnen Widgets zugewiesen sind. Die Werte stehen für Eingaben im Widget. Je nach Eingabedatentyp stellt jede Eingabe ein anderes Objekt dar: Bei Einzelwert-Widgets ist dies StringInput. Bei mehrwertigen Widgets ein Array von StringInput-Objekten. Für eine Datums-/Uhrzeitauswahl: DateTimeInput. Für eine Auswahl nur mit Datum DateInput. Für eine zeitbasierte Auswahl eine TimeInput. Entspricht den Daten, die ein Nutzer auf einer Karte in einem Dialogfeld eingibt.
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 Zeitzonencode der IANA TZ, z. B. „America/Toronto“.
offset

integer

Die Zeitzonenzeit des Nutzers in Millisekunden von der koordinierten Weltzeit (UTC).

Angaben

Datentypen, die Nutzer auf Karten oder Dialogfeldern eingeben können. Informationen dazu, wie Nutzerinformationen verarbeitet werden, finden Sie unter Eingabe von Formulardaten durch Nutzer auf Karten lesen.

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)

Eingabeparameter für reguläre Widgets. Bei Widgets mit einem Wert ist es eine Liste mit einem einzelnen Wert. Bei mehrwertigen Widgets wie Kästchen werden alle Werte angezeigt.
dateTimeInput

object (DateTimeInput)

Eingabewerte für Datum und Uhrzeit.
dateInput

object (DateInput)

Eingabedaten für Datum.
timeInput

object (TimeInput)

Werte für die Zeiteingabe.

Stringeingaben

Eingabeparameter für reguläre Widgets. Bei Widgets mit einem 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

Ein Array mit Strings, die der Nutzer eingegeben hat.

Datum/Uhrzeit-Eingabe

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.

Datumseingabe

Eingabedaten für Datum.

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

string (int64 format)

Zeit seit Epochenzeit in Millisekunden.

Zeiteingabe

Werte für die Zeiteingabe.

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

integer

Die Stunde im 24-Stunden-Format.
minutes

integer

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