Event

Google Chat 应用互动事件。

要了解互动事件，请参阅接收和响应与 Google Chat 应用的互动。如需了解事件类型以及事件载荷示例，请参阅 Google Chat 应用互动事件的类型。

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)
  }
}
字段
type

enum (EventType)

互动事件的类型。有关详情，请参阅 Google Chat 应用互动事件类型。
eventTime

string (Timestamp format)

指示互动事件发生时间的时间戳。
token

string

旧版 Chat 应用可用于验证请求是否来自 Google 的 Secret 值。Google 随机生成令牌，其值将保持静态。您可以通过 Google Cloud Console 中的 Chat API 配置页面获取、撤消或重新生成令牌。

现代 Chat 应用不使用此字段。API 响应和 Chat API 配置页面中不提供此类信息。
threadKey

string

与互动事件相关的线程的 Chat 应用定义的键。如需了解详情，请参阅 spaces.messages.thread.threadKey。
message

object (Message)

触发互动事件的消息（如果适用）。
user

object (User)

触发互动事件的用户。
space

object (Space)

发生互动事件的聊天室。
action

object (FormAction)

对于 CARD_CLICKED 互动事件，在用户点击卡片或对话框时关联的表单操作数据。有关详情，请参阅读取用户在卡片上输入的表单数据。
configCompleteRedirectUrl

string

用户完成在 Google Chat 之外的授权或配置流程后，Chat 应用应重定向到的网址。有关详情，请参阅将 Chat 应用与其他服务和工具相关联。
isDialogEvent

boolean

对于 CARD_CLICKED 互动事件，用户是否与对话框进行了互动。
dialogEventType

enum (DialogEventType)

收到的对话框互动事件的类型。
common

object (CommonEventObject)

表示有关用户客户端的信息，例如语言区域、托管应用和平台。对于 Chat 应用，CommonEventObject 包括用户与对话框互动时提交的信息，例如在卡片上输入的数据。

CommonEventObject 字段

表示有关用户客户端的信息，例如语言区域、托管应用和平台。对于 Chat 应用，CommonEventObject 包括用户与卡片互动的数据，例如在对话框中输入的数据。

JSON 表示法 
{
  "userLocale": string,
  "hostApp": enum (HostApp),
  "platform": enum (Platform),
  "timeZone": {
    object (TimeZone)
  },
  "formInputs": {
    string: {
      object (Inputs)
    },
    ...
  },
  "parameters": {
    string: string,
    ...
  },
  "invokedFunction": string
}
字段
userLocale

string

完整的 locale.displayName，格式为 [ISO 639 语言代码]-[ISO 3166 国家/地区代码]，例如“en-US”。
hostApp

enum (HostApp)

hostApp 枚举，用于指示从中调用插件的应用。对于 Chat 应用，始终为 CHAT。
platform

enum (Platform)

指明事件源自的平台（WEB、IOS 或 ANDROID）的平台枚举。Chat 应用不支持此设置。
timeZone

object (TimeZone)

时区 ID 和相对于世界协调时间 (UTC) 的偏移量。仅适用于 CARD_CLICKED 和 SUBMIT_DIALOG 事件类型。
formInputs

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

一个卡片，其中包含卡片中微件的当前值。映射键是分配给每个 widget 的字符串 ID，值表示到该 widget 的输入。根据输入数据类型，每个输入代表不同的对象：对于单值 widget，StringInput。对于多值 widget，这是由 StringInput 对象组成的数组。对于日期时间选择器，请使用 DateTimeInput。对于仅限日期的选择器，请使用 DateInput。对于时间选择器，请使用 TimeInput。对应于用户在对话框中的卡片上输入的数据。
parameters

map (key: string, value: string)

传递给被调用的函数的自定义参数。键和值都必须是字符串。
invokedFunction

string

与微件关联的已调用函数的名称。仅针对 Chat 应用设置。

TimeZone

时区 ID 和相对于世界协调时间 (UTC) 的偏移量。仅适用于 CARD_CLICKED 和 SUBMIT_DIALOG 事件类型。

JSON 表示法 
{
  "id": string,
  "offset": integer
}
字段
id

string

IANA TZ 时区数据库代码，例如“美国/多伦多”。
offset

integer

以世界协调时间 (UTC) 为单位的用户时区偏移量（以毫秒为单位）。

输入内容

用户可以在卡片或对话框中输入的数据类型。如需了解如何处理用户提供的信息，请参阅读取卡片上的用户输入表单数据。

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.
}
字段

联合字段 inputs。

inputs 只能是下列其中一项：
stringInputs

object (StringInputs)

常规 widget 的输入参数。对于单值微件，它是单个值列表。对于多值微件（例如复选框），系统会显示所有值。
dateTimeInput

object (DateTimeInput)

日期和时间输入值。
dateInput

object (DateInput)

日期输入值。
timeInput

object (TimeInput)

时间输入值。

字符串输入

常规 widget 的输入参数。对于单值微件，它是单个值列表。对于多值微件（例如复选框），系统会显示所有值。

JSON 表示法 
{
  "value": [
    string
  ]
}
字段
value[]

string

用户输入的字符串数组。

日期输入

日期和时间输入值。

JSON 表示法 
{
  "msSinceEpoch": string,
  "hasDate": boolean,
  "hasTime": boolean
}
字段
msSinceEpoch

string (int64 format)

自 Epoch 时间算起，以毫秒为单位。
hasDate

boolean

datetime 输入是否包含日历日期。
hasTime

boolean

datetime 输入是否包含时间戳。

日期输入

日期输入值。

JSON 表示法 
{
  "msSinceEpoch": string
}
字段
msSinceEpoch

string (int64 format)

自 Epoch 时间算起，以毫秒为单位。

输入时间

时间输入值。

JSON 表示法 
{
  "hours": integer,
  "minutes": integer
}
字段
hours

integer

24 小时制的小时。
minutes

integer

一小时过后的分钟数。有效值为 0 至 59。