回覆 Google Chat 應用程式指令

本頁說明如何設定及回應指令，以 Google Chat 應用程式的身分執行操作。

指令可協助使用者探索及使用 Chat 擴充應用程式的重要功能。只有 Chat 擴充應用程式可以查看指令內容。舉例來說，如果使用者傳送含有斜線指令的訊息，只有使用者和 Chat 應用程式會看到該訊息。

如要決定是否應建構指令，以及瞭解如何設計使用者互動，請參閱「定義所有使用者歷程」。

Chat 應用程式指令類型

您可以將 Chat 應用程式指令建構為斜線指令或快速指令。如要探索及使用各類指令，請按照下列步驟操作：
  1. 斜線指令：使用者輸入斜線 (/) 和預先定義的文字 (例如 /about)，即可傳送指令訊息。 Chat 應用程式也可以要求斜線指令的引數文字。舉例來說，斜線指令 /search 可能需要引數文字，用於搜尋查詢。
  2. 快速指令：使用者可以開啟 Chat 訊息回覆區的選單，然後使用指令。如要使用指令，請按一下「新增」 ，然後從選單中選取指令。
下列圖片顯示使用者如何探索斜線指令和快速指令選單：
  • 使用者發現斜線指令。
    圖 1. 使用者在回覆區域中輸入斜線 /，然後輸入指令名稱，即可探索及使用斜線指令。
  • 使用者從選單查看快速指令。
    圖 2. 使用者可以透過 Chat 訊息回覆區的選單，探索及使用快速指令。

必要條件

HTTP

可擴充 Google Chat 功能的 Google Workspace 外掛程式。如要建構一個，請完成 HTTP 快速入門導覽。

Apps Script

可擴充 Google Chat 功能的 Google Workspace 外掛程式。如要建構巨集，請完成 Apps Script 快速入門。

設定指令

本節說明如何完成下列步驟來設定指令：

  1. 建立指令名稱和說明。
  2. 在 Google Cloud 控制台中設定指令。

為指令命名並輸入說明

使用者輸入或選取指令名稱，即可叫用 Chat 應用程式。名稱下方也會顯示簡短說明，進一步提示使用者如何使用指令：

斜線指令名稱和說明
圖 3：斜線指令的名稱和說明。

為指令選擇名稱和說明時，請參考下列建議：

如何命名指令：

  • 使用簡短、描述性強且可執行的字詞或片語，讓使用者清楚瞭解指令。舉例來說，請使用 Remind me，而不是 Create a reminder。
  • 建議為指令使用專屬或通用名稱。如果指令說明的是一般互動或功能，可以使用使用者可辨識且預期的常見名稱，例如 Settings 或 Feedback。否則，請盡量使用不重複的指令名稱，因為如果其他 Chat 應用程式也使用相同指令名稱，使用者就必須篩選類似的指令，才能找到並使用您的指令。

如要描述指令，請按照下列步驟操作：

  • 請簡短清楚地說明指令用途，讓使用者瞭解使用指令後會發生什麼事。
  • 告知使用者指令的格式規定。舉例來說，如果您建立的斜線指令需要引數文字，請將說明設為 Remind me to do [something] at [time] 等內容。
  • 讓使用者知道 Chat 應用程式是回覆聊天室中的所有人，還是私下回覆給叫用指令的使用者。舉例來說，快速指令 About 可以描述為 Learn about this app (Only visible to you)。

在 Google Cloud 控制台中設定指令

如要建立斜線或快速指令，請在 Google Chat API 的 Chat 應用程式設定中指定指令相關資訊。

如要在 Google Chat API 中設定指令，請完成下列步驟： 如要在 Google Chat API 中設定斜線指令，請完成下列步驟：

  1. 在 Google Cloud 控制台中，依序點按「選單」圖示 >「API 和服務」 >「已啟用的 API 和服務」 >「Google Chat API」

    前往 Google Chat API 頁面

  2. 按一下「設定」。

  3. 在「連結設定」下方，前往「觸發條件」並指定端點詳細資料。您必須在下一節中使用這個觸發條件，才能回應指令。

    1. HTTP 端點網址：您可以在這裡指定一個通用的 HTTP 端點網址。 或者，如要為不同觸發條件使用不同的 HTTP 端點，請直接在「應用程式指令」欄位中指定端點。
    2. Apps Script：輸入 Apps Script 部署作業 ID。根據預設，系統會叫用 onAppCommand 函式。如要使用其他 Apps Script 函式，請在「應用程式指令」欄位中指定自訂函式名稱。

  4. 在「指令」下方，按一下「新增指令」。

  5. 輸入下列指令相關資訊：

    1. 指令 ID：介於 1 到 1000 之間的數字，Chat 應用程式會使用這個 ID 辨識指令並傳回回應。
    2. 說明：說明如何使用及格式化指令的文字。說明最多可輸入 50 個半形字元。
    3. 指令類型：選取「快速指令」或「斜線指令」。
    4. 指定快速指令或斜線指令的名稱：
      • 快速指令名稱：使用者從選單中選取並叫用指令時，顯示的名稱。最多可輸入 50 個半形字元，且可包含特殊字元。例如 Remind me。
      • 斜線指令名稱：使用者在訊息中輸入的文字，可叫用指令。開頭須為斜線，只能包含文字，且最多 50 個半形字元。例如 /remindMe。

  6. 選用：如要讓 Chat 應用程式透過對話方塊回覆指令，請選取「開啟對話方塊」核取方塊。

  7. 按一下 [儲存]。

現在已為 Chat 應用程式設定指令。

回應指令

使用者發出指令時，Chat 應用程式會收到事件物件。事件酬載包含 appCommandPayload 物件，其中含有所叫用指令的詳細資料 (包括指令 ID 和指令類型)，方便您傳回適當的回應。系統會將事件物件傳送至您設定 App 指令觸發條件時指定的 HTTP 端點或 Apps Script 函式。

Cymbal Labs Chat 應用程式的私人訊息。訊息內容為 Chat 應用程式是由 Cymbal Labs 所建立，並提供文件連結和支援團隊聯絡資訊。
Chat 應用程式會私下回覆斜線指令 /help，說明如何取得支援。

下列程式碼範例顯示 Chat 應用程式如何回覆斜線指令 /about，並傳送文字訊息。如要回應斜線指令，Chat 應用程式會處理 App command 觸發事件的事件物件。當事件物件的酬載包含斜線指令 ID 時，Chat 應用程式會傳回含有 createMessageAction 物件的動作 DataActions：

Node.js

// 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 ABOUT_COMMAND_ID = 0;

/**
 * Google Cloud Function that responds to events sent from a
 * Google Chat space.
 *
 * @param {Object} req Request sent from Google Chat space
 * @param {Object} res Response to send back
 */
exports.avatarApp = function avatarApp(req, res) {
    if (req.method === 'GET' || !req.body.chat) {
        return res.send('Hello! This function is meant to be used ' +
            'in a Google Chat Space.');
    }
    // Stores the Google Chat event as a variable.
    const chatEvent = req.body.chat;

    // Handles events that contain payloads about commands
    if (chatEvent.appCommandPayload) {

      // Stores the Google Chat app command metadata as a variable.
      const appCommandMetadata = chatEvent.appCommandPayload.appCommandMetadata;

      // Executes the slash command logic based on its ID.
      // Slash command IDs are set in the Google Chat API configuration.
      switch (appCommandMetadata.appCommandId) {
          case ABOUT_COMMAND_ID:
              return res.send({ hostAppDataAction: { chatDataAction: { createMessageAction: { message: {
                  text: 'The Avatar app replies to Google Chat messages.'
              }}}}});
      }
    // Handles MESSAGE events
    } else if (chatEvent.messagePayload) {

        // Stores the Google Chat event as a variable.
        const chatMessage = chatEvent.messagePayload.message;

        // Replies with the sender's avatar in a card otherwise.
        const displayName = chatMessage.sender.displayName;
        const avatarUrl = chatMessage.sender.avatarUrl;
        res.send({ hostAppDataAction: { chatDataAction: { createMessageAction: { message: {
            text: 'Here\'s your avatar',
            cardsV2: [{
                cardId: 'avatarCard',
                card: {
                    name: 'Avatar Card',
                    header: {
                        title: `Hello ${displayName}!`,
                    },
                    sections: [{
                        widgets: [{
                            textParagraph: { text: 'Your avatar picture: ' }
                        }, {
                            image: { imageUrl: avatarUrl }
                        }]
                    }]
                }
            }]
        }}}}});
    }
};

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 ABOUT_COMMAND_ID = 0;

/**
 * Responds to a MESSAGE event in Google Chat.
 *
 * @param {Object} event the event object from Google Chat
 */
function onMessage(event) {

    // Stores the Google Chat event as a variable.
    const chatMessage = event.chat.messagePayload.message;

    // Replies with the sender's avatar in a card otherwise.
    const displayName = chatMessage.sender.displayName;
    const avatarUrl = chatMessage.sender.avatarUrl;
    return { hostAppDataAction: { chatDataAction: { createMessageAction: { message: {
        text: 'Here\'s your avatar',
        cardsV2: [{
            cardId: 'avatarCard',
            card: {
                name: 'Avatar Card',
                header: {
                    title: `Hello ${displayName}!`,
                },
                sections: [{
                    widgets: [{
                        textParagraph: { text: 'Your avatar picture: ' }
                    }, {
                        image: { imageUrl: avatarUrl }
                    }]
                }]
            }
        }]
    }}}}};
}

/**
 * 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;

  // Executes the slash command logic based on its ID.
  // Slash command IDs are set in the Google Chat API configuration.
  switch (appCommandMetadata.appCommandId) {
      case ABOUT_COMMAND_ID:
          return { hostAppDataAction: { chatDataAction: { createMessageAction: { message: {
              text: 'The Avatar app replies to Google Chat messages.'
          }}}}};
  }
}

如要使用這個程式碼範例，請將 ABOUT_COMMAND_ID 替換為您在透過 Chat API 設定指令時指定的指令 ID。

測試指令

如要測試指令和程式碼，請參閱「測試 Google Chat 應用程式的互動式功能」。

如要瞭解如何在 Chat 使用者介面中測試及使用指令，請參閱 Google Chat 說明文件中的「在 Google Chat 中使用應用程式」。