使用 Google Apps Script 建立 Google Chat 應用程式

建立 Google Chat 擴充應用程式來直接傳送訊息，並根據您的訊息做出回應。

下圖顯示架構和訊息模式：

使用 Apps Script 實作的 Chat 應用程式架構。

在上圖中，使用者與 Apps Script Chat 應用程式互動時，資訊會依照下列流程傳送：

  1. 使用者透過即時訊息或 Chat 聊天室，傳送訊息至 Chat 應用程式。
  2. 位於 Google Cloud 的 Chat 應用程式邏輯會接收並處理訊息，這些邏輯是透過 Apps Script 實作。
  3. 您可以選擇讓 Chat 應用程式邏輯整合 Google Workspace 服務，例如日曆或試算表，或是其他 Google 服務，例如 Google 地圖或 YouTube。
  4. Chat 應用程式邏輯會將回應傳回至 Chat 中的 Chat 應用程式服務。
  5. 系統會將回應傳送給使用者。

目標

  • 設定環境。
  • 設定指令碼。
  • 發布 Chat 應用程式。
  • 測試 Chat 應用程式。

必要條件

設定環境

在 Google Cloud 控制台中開啟 Cloud 專案

如果尚未開啟，請開啟要用於本範例的 Cloud 專案：

  1. 在 Google Cloud 控制台中，前往「Select a project」頁面。

    選取 Cloud 專案

  2. 選取要使用的 Google Cloud 專案。或者，您也可以按一下「建立專案」，然後按照畫面上的指示操作。如果您建立 Google Cloud 專案，可能需要為專案啟用計費功能。

開啟 Chat API

使用 Google API 前，您必須先在 Google Cloud 專案中啟用這些 API。您可以在單一 Google Cloud 專案中啟用一或多個 API。

  • 在 Google Cloud 控制台中啟用 Google Chat API。

    啟用 API

所有使用 OAuth 2.0 的應用程式都需要同意畫面設定。設定應用程式的 OAuth 同意畫面，即可定義向使用者和應用程式審查人員顯示的內容，並註冊應用程式，以便日後發布。

  1. 在 Google Cloud 控制台中，依序前往「選單」 >「API 和服務」 >「OAuth 同意畫面」。

    前往 OAuth 同意畫面

  2. 在「使用者類型」部分，選取「內部」，然後按一下「建立」。
  3. 填寫應用程式註冊表單，然後按一下「儲存並繼續」。

  4. 目前您可以略過新增範圍，直接按一下「儲存並繼續」。日後，如果您建立的應用程式是用於 Google Workspace 機構以外的環境，就必須將使用者類型變更為外部，然後新增應用程式所需的授權範圍。

  5. 查看應用程式註冊摘要。如要修改資訊，請按一下「編輯」。如果應用程式註冊看起來沒問題，請按一下「返回資訊主頁」。

設定指令碼

如要設定指令碼，請使用範本，然後在 Apps Script 中設定 Cloud 專案。

使用範本建立指令碼

  1. 前往 Apps Script 入門頁面。
  2. 按一下頁面底部的「Chat App」範本。
  3. 按一下「未命名專案」，輸入 Quickstart app，然後按一下「重新命名」。

複製 Cloud 專案編號

  1. 在 Google Cloud 控制台中，依序前往「Menu」(選單) >「IAM & Admin」(IAM 與管理)>「Settings」(設定)。

    前往「IAM 與管理員設定」

  2. 在「專案編號」欄位中複製值。

設定 Apps Script 專案的 Cloud 專案

  1. 在 Chat 應用程式 Apps Script 專案中，按一下「Project Settings」圖示 專案設定圖示。
  2. 在「Google Cloud Platform (GCP) 專案」下方，按一下「變更專案」。
  3. 在「GCP 專案編號」中貼上 Google Cloud 專案編號。
  4. 按一下「設定專案」。

您現在擁有可運作的應用程式程式碼，可以嘗試 (如以下步驟所述)，然後依需求進行自訂。

開啟 Apps Script 範本時，請確認您已登入正確的 Google 帳戶。目前帳戶有時會在你不知情的情況下切換為預設帳戶。

建立測試部署

您需要這個 Apps Script 專案的部署 ID，才能在後續步驟中使用。

如要取得主部署 ID，請按照下列步驟操作：

  1. 在 Chat 應用程式的 Apps Script 專案中，依序按一下「Deploy」「Test deployments」。
  2. 複製主部署 ID，以便在後續步驟中使用，然後按一下「完成」。

發布 Chat 應用程式

透過控制台發布 Chat 應用程式。

  1. 在控制台中搜尋 Google Chat API，然後按一下「Google Chat API」。
  2. 按一下「管理」。

  3. 按一下「設定」，然後設定 Chat 應用程式：

    1. 在「App name」(應用程式名稱) 欄位中輸入 Quickstart app。
    2. 在「Avatar URL」欄位中輸入 https://developers.google.com/chat/images/quickstart-app-avatar.png。
    3. 在「Description」欄位中輸入 Quickstart app。
    4. 在「功能」下方，選取「接收一對一訊息」和「加入聊天室和群組對話」。
    5. 在「連線設定」下方，選取「Apps Script」。
    6. 在「Deployment ID」欄位中，貼上您先前複製的 Head 部署 ID。
    7. 在「瀏覽權限」下方，選取「僅限您網域中的特定使用者和群組」，然後輸入您的電子郵件地址。

  4. 按一下 [儲存]。

Chat 應用程式已準備好回覆訊息。

測試 Chat 應用程式

如要測試 Chat 應用程式，請使用 Chat 應用程式開啟即時訊息聊天室並傳送訊息：

  1. 使用您新增自己為信任測試人員時提供的 Google Workspace 帳戶，開啟 Google Chat。

    前往 Google Chat

  2. 按一下 「發起即時通訊」。
  3. 在「新增 1 位或多位使用者」欄位中，輸入 Chat 應用程式的名稱。

  4. 從搜尋結果中選取 Chat 應用程式。即時訊息會隨即開啟。

  5. 在與應用程式互傳的新即時訊息中，輸入 Hello 並按下 enter。

    Chat 應用程式會感謝你新增該應用程式，並回應你的訊息。

如要新增信任的測試人員，並進一步瞭解如何測試互動功能，請參閱「測試 Google Chat 應用程式的互動功能」。

疑難排解

當 Google Chat 應用程式或資訊卡傳回錯誤時，Chat 介面會顯示「發生錯誤」的訊息。或「無法處理您的要求」。有時 Chat UI 不會顯示任何錯誤訊息，但 Chat 應用程式或資訊卡會產生意外結果，例如資訊卡訊息可能不會顯示。

雖然 Chat UI 可能不會顯示錯誤訊息，但當您開啟 Chat 應用程式的錯誤記錄功能時，系統會提供說明性錯誤訊息和記錄資料，協助您修正錯誤。如需查看、偵錯及修正錯誤的相關說明，請參閱「排解及修正 Google Chat 錯誤」一文。

清除所用資源

如要避免系統向您的 Google Cloud 帳戶收取本教學課程中所用資源的相關費用，建議您刪除 Cloud 專案。

  1. 在 Google Cloud 控制台中前往「管理資源」頁面。依序按一下「選單」圖示 >「IAM 與管理」 >「管理資源」。

    前往 Resource Manager

  2. 在專案清單中選取要刪除的專案，然後按一下「刪除」圖示 。
  3. 在對話方塊中輸入專案 ID，然後按一下「Shut down」(關閉) 即可刪除專案。

後續步驟

  • 建立互動式資訊卡：資訊卡訊息支援已定義的版面配置、互動式 UI 元素 (例如按鈕)，以及圖片等多媒體內容。使用資訊卡訊息呈現詳細資訊、收集使用者資訊，並引導使用者採取下一步行動。
  • 支援斜線指令：您可以使用斜線指令，註冊並宣傳特定指令，讓使用者輸入以斜線 (/) 開頭的指令 (例如 /help)，藉此向應用程式發出指令。
  • 啟動對話方塊：對話方塊是窗格式、以卡片為基礎的介面，可讓應用程式與使用者互動。您可以依序連結多個資訊卡，協助使用者完成多步驟程序，例如填寫表單資料。
  • 程式碼研究室：準備好建構更進階的即時通訊應用程式了嗎？請參閱「運用 Gemini 建構 Google Chat 擴充應用程式」程式碼研究室的 Chat 應用程式意見回饋。