Google Chat 应用互动事件。
要了解互动事件,请参阅接收和响应与 Google Chat 应用的互动情况。如需了解事件类型以及事件载荷示例,请参阅 Google Chat 应用互动事件类型。
除了接收用户互动事件外,Chat 应用还可以接收与聊天室更改相关的事件,例如当有新成员添加到聊天室时。如要了解聊天室活动,请参阅处理 Google Chat 中的活动。
JSON 表示法 |
---|
{ "type": enum ( |
字段 | |
---|---|
type |
互动事件的类型。有关详情,请参阅 Google Chat 应用互动事件类型。 |
eventTime |
指明互动事件发生时间的时间戳。 |
token |
一个密钥值,旧版 Chat 应用可以用它来验证请求是否来自 Google。Google 会随机生成令牌,且其值保持静态。您可以在 Google Cloud 控制台的 Chat API 配置页面获取、撤消或重新生成令牌。 新型 Chat 应用不会使用此字段。该 ID 不会显示在 API 响应和 Chat API 配置页面中。 |
threadKey |
与互动事件相关的会话的 Chat 应用定义的键。如需了解详情,请参阅 |
message |
触发互动事件的消息(如果适用)。 |
user |
触发互动事件的用户。 |
space |
发生互动事件的空间。 |
action |
对于 |
configCompleteRedirectUrl |
用户在 Google Chat 外部完成授权或配置流程后,Chat 应用应将用户重定向到的网址。如需了解详情,请参阅将 Chat 应用与其他服务和工具相关联。 |
isDialogEvent |
|
dialogEventType |
收到的 dialog 互动事件的类型。 |
common |
表示有关用户客户端的信息,例如语言区域、托管应用和平台。对于 Chat 应用, |
CommonEventObject
表示有关用户客户端的信息,例如语言区域、托管应用和平台。对于 Chat 应用,CommonEventObject
包含与卡片互动的用户提交的数据,例如在对话框中输入的数据。
JSON 表示法 |
---|
{ "userLocale": string, "hostApp": enum ( |
字段 | |
---|---|
userLocale |
采用 [ISO 639 语言代码]-[ISO 3166 国家/地区代码] 格式的完整 |
hostApp |
hostApp 枚举,用于指明从哪个应用调用插件。对于 Chat 应用,始终为 |
platform |
平台枚举,用于指明事件源自哪个平台( |
timeZone |
时区 ID 以及相对于世界协调时间 (UTC) 的偏移量。仅适用于 |
formInputs |
包含用户在卡片或对话框的 widget 中输入的值的映射。映射键是分配给每个 widget 的字符串 ID,其值表示该 widget 的输入。 有关详情,请参阅处理用户输入的信息。 |
parameters |
传递给调用的函数的自定义参数。键和值都必须是字符串。 |
invokedFunction |
与微件关联的所调用函数的名称。仅针对 Chat 应用设置。 |
TimeZone
时区 ID 以及相对于世界协调时间 (UTC) 的偏移量。仅适用于 CARD_CLICKED
和 SUBMIT_DIALOG
事件类型。
JSON 表示法 |
---|
{ "id": string, "offset": integer } |
字段 | |
---|---|
id |
IANA TZ 时区数据库代码,例如“America/Toronto”。 |
offset |
相对于世界协调时间 (UTC) 的用户时区偏移量(以毫秒为单位)。 |
输入
用户可以在卡片或对话框中输入的数据类型。输入类型取决于 widget 接受的值的类型。
JSON 表示法 |
---|
{ // Union field |
字段 | |
---|---|
联合字段
|
|
stringInputs |
一个字符串列表,表示用户在 widget 中输入的值。 如果该 widget 仅接受一个值(例如 |
dateTimeInput |
来自接受日期和时间的 |
dateInput |
日期输入值来自只接受日期值的 |
timeInput |
时间输入值来自仅接受时间值的 |
StringInputs
常规 widget 的输入参数。对于单值微件,是一个单值列表。对于多值微件(例如复选框),呈现所有值。
JSON 表示法 |
---|
{ "value": [ string ] } |
字段 | |
---|---|
value[] |
用户输入的字符串的列表。 |
DateTimeInput
输入日期和时间值。
JSON 表示法 |
---|
{ "msSinceEpoch": string, "hasDate": boolean, "hasTime": boolean } |
字段 | |
---|---|
msSinceEpoch |
自纪元以来的时间(以毫秒为单位)。 |
hasDate |
|
hasTime |
|
DateInput
输入日期值。
JSON 表示法 |
---|
{ "msSinceEpoch": string } |
字段 | |
---|---|
msSinceEpoch |
自纪元以来的时间(以毫秒为单位)。 |
TimeInput
时间输入值。
JSON 表示法 |
---|
{ "hours": integer, "minutes": integer } |
字段 | |
---|---|
hours |
24 小时制的小时。 |
minutes |
整点过后的分钟数。有效值为 0 到 59。 |