本頁說明如何設定 Google Chat 應用程式的快速指令,以及如何回應這些指令。
快速指令是使用者喚出 Chat 應用程式並與其互動的方式。如要使用快速指令,請按一下 Chat 空間或對話中的 Google Workspace 工具 /
) 的應用程式指令。選取快速指令後,系統會直接喚出 Chat 應用程式,無須使用者進一步輸入內容,讓使用者能快速與應用程式互動。
使用者也可以透過斜線指令叫用 Chat 應用程式。與斜線指令相比,快速指令在 Chat UI 中採用更友善的名稱格式,會在選取後立即叫用,且使用者不必記住或輸入斜線指令的名稱。
在 Google Chat API 中設定快速指令
如要建立快速指令或將任何現有的斜線指令更新為快速指令,您必須在 Chat 應用程式的 Google Chat API 設定中指定指令相關資訊。
如要在 Google Chat API 中設定快速指令,請完成下列步驟:
在 Google Cloud 控制台中,依序點選「Menu」圖示 >「API 和服務」 >「已啟用的 API 和服務」 >「Google Chat API」
按一下「設定」。
在「進階設定」下方,前往「觸發條件」,確認「應用程式指令」欄位包含觸發條件,例如 HTTP 端點或 Apps Script 函式。您必須在下一個章節中使用這個觸發事件,才能回應快速指令。
在「指令」下方,按一下「新增指令」。
輸入指令的 ID、名稱、說明和指令類型:
- 指令 ID:Chat 應用程式用來辨識指令並傳回回應的 1 到 1000 之間的數字。
- 名稱:指令的顯示名稱。名稱的長度上限為 50 個字元,且可以包含特殊字元。
- 使用簡短、具描述性且可執行的字詞或詞組,讓使用者清楚瞭解指令。舉例來說,如果指令是用來修改聯絡人記錄,請使用「Update contact」。
- 說明:說明指令用途的文字。說明的長度上限為 50 個半形字元,且可包含特殊字元。
- 請簡短明瞭地說明,讓使用者知道執行指令時會發生什麼事。
- 請告訴使用者,Chat 應用程式會回覆聊天室中的所有人,還是只回覆叫用指令的使用者。舉例來說,如果要使用「關於」快速指令,您可以將其描述為「瞭解這個應用程式 (只有您看得到)」。
- 指令類型:選取「快速指令」。
選用:如要讓 Chat 應用程式以對話方塊回應指令,請選取「Open a dialog」核取方塊。
按一下 [儲存]。
系統已為 Chat 應用程式設定快速指令。
回覆快速指令
使用者叫用快速指令時,Chat 應用程式會收到包含快速指令相關資訊的事件物件。事件物件包含 AppCommand
酬載,其中包含叫用指令的詳細資料 (包括指令 ID),方便您傳回適當的回應。
如要回應快速指令,您必須實作 應用程式指令 觸發事件,讓 Chat 應用程式能夠處理任何包含應用程式指令中繼資料的事件物件。
以下程式碼為回覆「Help」指令的 Chat 應用程式範例。為了回應快速指令,Chat 應用程式會處理來自 應用程式指令 觸發事件的物件。當事件物件的酬載包含快速指令 ID 時,Chat 應用程式會傳回使用 createMessageAction
物件的動作 DataActions
:
Apps Script
// The ID of the slash command "/about".
// It's not enabled by default, set to the actual ID to enable it. You must
// use the same ID as set in the Google Chat API configuration.
const HELP_COMMAND_ID = 0;
/**
* Responds to an APP_COMMAND event in Google Chat.
*
* @param {Object} event the event object from Google Chat
*/
function onAppCommand(event) {
// Stores the Google Chat app command metadata as a variable.
const appCommandMetadata = event.chat.appCommandPayload.appCommandMetadata;
if (appCommandMetadata.appCommandType == "QUICK_COMMAND") {
// Executes the quick command logic based on its ID.
// Quick command IDs are set in the Google Chat API configuration.
switch (appCommandMetadata.appCommandId) {
case HELP_COMMAND_ID:
return { hostAppDataAction: { chatDataAction: { createMessageAction: { message: {
text: 'The Avatar app replies to Google Chat messages.'
}}}}};
}
}
}
如要使用這個程式碼範例,請將 HELP_COMMAND_ID
替換為您在設定 Chat API 中的快速指令時指定的指令 ID。如要在 Chat 中測試快速指令,請按一下「Google Workspace 工具」 ,然後選取快速指令,開啟整合選單。