Google Chat 應用程式互動事件,代表並包含使用者與 Chat 應用程式互動的資料。如要設定 Chat 應用程式來接收互動事件,請參閱「接收及回覆使用者互動」。
除了接收使用者互動的事件外,Chat 應用程式也可以收到有關聊天室異動的事件,例如新成員加入聊天室。如要進一步瞭解聊天室事件,請參閱「使用 Google Chat 中的活動」。
JSON 表示法 |
---|
{ "type": enum ( |
欄位 | |
---|---|
type |
使用者與 Chat 應用程式互動的類型,例如 |
eventTime |
指出互動事件發生時間的時間戳記。 |
token |
舊版 Chat 應用程式可用來驗證要求是否來自 Google 的密鑰值。而 Google 會隨機產生權杖,其值則保持不變。您可以在 Google Cloud 控制台的 Chat API 設定頁面中取得、撤銷或重新產生權杖。 新版 Chat 應用程式不會使用這個欄位。但不會顯示在 API 回應和 Chat API 設定頁面中。 |
threadKey |
為與互動事件相關的執行緒定義的 Chat 應用程式定義鍵。詳情請參閱 |
message |
針對 |
user |
與 Chat 應用程式互動的使用者。 |
space |
使用者與 Chat 應用程式互動的聊天室。 |
action |
針對 |
configCompleteRedirectUrl |
如果是 |
isDialogEvent |
針對 |
dialogEventType |
收到的對話方塊互動事件類型。 |
common |
代表使用者用戶端相關資訊,例如語言代碼、主機應用程式和平台。如果是即時通訊應用程式, |
CommonEventObject
代表使用者用戶端相關資訊,例如語言代碼、主機應用程式和平台。針對即時通訊應用程式,CommonEventObject
會包含使用者與資訊卡互動提交的資料,例如在對話方塊中輸入的資料。
JSON 表示法 |
---|
{ "userLocale": string, "hostApp": enum ( |
欄位 | |
---|---|
userLocale |
採用 [ISO 639 語言代碼]-[ISO 3166 國家/地區代碼] 格式的完整 |
hostApp |
hostApp 列舉,表示叫用外掛程式的應用程式。如果是 Chat 擴充應用程式,一律為 |
platform |
此平台列舉指出事件來源的平台 ( |
timeZone |
時區 ID 和與世界標準時間 (UTC) 的偏移值。僅支援 |
formInputs |
此地圖包含使用者從資訊卡或對話方塊在小工具中輸入的值。對應鍵是指派給每個小工具的字串 ID,值代表小工具的輸入內容。 詳情請參閱「處理使用者輸入的資訊」。 |
parameters |
傳送至叫用函式的自訂參數。索引鍵和值都必須為字串。 |
invokedFunction |
與小工具相關聯的叫用函式名稱。僅為 Chat 應用程式設定。 |
TimeZone
時區 ID 和與世界標準時間 (UTC) 的偏移值。僅支援 CARD_CLICKED
和 SUBMIT_DIALOG
事件類型。
JSON 表示法 |
---|
{ "id": string, "offset": integer } |
欄位 | |
---|---|
id |
IANA TZ 時區資料庫代碼,例如「America/Toronto」。 |
offset |
從世界標準時間 (UTC) 算起,使用者時區偏移 (以毫秒為單位)。 |
輸入
使用者可在資訊卡或對話方塊中輸入的資料類型。輸入類型取決於小工具接受的值類型。
JSON 表示法 |
---|
{ // Union field |
欄位 | |
---|---|
聯集欄位
|
|
stringInputs |
字串清單,代表使用者在小工具中輸入的值。 如果小工具只接受一個值 (例如 |
dateTimeInput |
|
dateInput |
|
timeInput |
|
StringInputs
一般小工具的輸入參數。如果是單值小工具,則為單一值清單。如果是多值小工具 (例如核取方塊),則顯示所有值。
JSON 表示法 |
---|
{ "value": [ string ] } |
欄位 | |
---|---|
value[] |
使用者輸入的字串清單。 |
DateTimeInput
日期和時間輸入值。
JSON 表示法 |
---|
{ "msSinceEpoch": string, "hasDate": boolean, "hasTime": boolean } |
欄位 | |
---|---|
msSinceEpoch |
自 Epoch 紀元時間起算的時間,以毫秒為單位。 |
hasDate |
|
hasTime |
|
DateInput
日期輸入值。
JSON 表示法 |
---|
{ "msSinceEpoch": string } |
欄位 | |
---|---|
msSinceEpoch |
自 Epoch 紀元時間起算的時間,以毫秒為單位。 |
TimeInput
時間輸入值。
JSON 表示法 |
---|
{ "hours": integer, "minutes": integer } |
欄位 | |
---|---|
hours |
24 小時制的小時。 |
minutes |
一小時內的分鐘數。有效值為 0 至 59。 |