使用 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 控制台的「選取專案」頁面。

    選取 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 控制台中,依序前往「選單」 > >「品牌」

    前往「品牌宣傳」

  2. 如果您已設定 ,可以在「品牌」、「目標對象」和「資料存取權」中設定下列 OAuth 同意畫面設定。如果看到「尚未設定」 訊息,請按一下「開始使用」
    1. 在「App Information」(應用程式資訊) 下方的「App name」(應用程式名稱) 欄位中,輸入應用程式名稱。
    2. 在「使用者支援電子郵件」中,選擇支援電子郵件地址,方便使用者在同意聲明方面有任何疑問時與您聯絡。
    3. 點選 [下一步]
    4. 在「觀眾」下方,選取「內部」
    5. 點選 [下一步]
    6. 在「聯絡資訊」下方,輸入可接收專案異動通知的電子郵件地址
    7. 點選 [下一步]
    8. 在「完成」下方,詳閱《Google API 服務:使用者資料政策》,然後選取「我同意《Google API 服務:使用者資料政策》」
    9. 按一下 [繼續]。
    10. 按一下「Create」(建立)。
  3. 目前可以略過新增範圍。 日後為 Google Workspace 機構以外的使用者建立應用程式時,請務必將「使用者類型」變更為「外部」。然後新增應用程式需要的授權範圍。詳情請參閱完整的「設定 OAuth 同意畫面」指南。

設定指令碼

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

使用範本建立指令碼

  1. 前往 Apps Script「開始使用」頁面
  2. 按一下頁面頂端的「Chat App」(即時通訊應用程式) 範本。
  3. 按一下「未命名的專案」,輸入 Quickstart app,然後按一下「重新命名」

複製 Cloud 專案編號

  1. 在 Google Cloud 控制台中,依序前往「選單」圖示 >「IAM 與管理」 >「設定」

    前往「IAM & Admin Settings」(IAM 與管理員設定)

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

設定 Apps Script 專案的 Cloud 專案

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

您現在已擁有可運作的應用程式程式碼,可以試用 (如下列步驟所述),然後自訂程式碼以符合需求。

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

建立測試部署作業

您需要這個 Apps Script 專案的部署作業 ID,才能在下一個步驟中使用。

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

  1. 在 Chat 應用程式的 Apps Script 專案中,依序點選「部署」>「測試部署作業」
  2. 複製「Head deployment ID」(主要部署作業 ID),供後續步驟使用,然後按一下「Done」(完成)

發布 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 使用者介面未顯示錯誤訊息,只要開啟 Chat 應用程式的錯誤記錄功能,系統就會提供說明性錯誤訊息和記錄資料,協助您修正錯誤。如需查看、偵錯及修正錯誤的相關協助,請參閱「排解及修正 Google Chat 錯誤」。

清除所用資源

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

  1. 在 Google Cloud 控制台中,前往「管理資源」頁面。依序點選「選單」「IAM 與管理」「管理資源」

    前往 Resource Manager

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

後續步驟

  • 建立互動式資訊卡:資訊卡訊息支援定義的版面配置、按鈕等互動式 UI 元素,以及圖片等豐富媒體。使用資訊卡訊息呈現詳細資訊、向使用者收集資訊,以及引導使用者採取下一步行動。
  • 回覆指令:指令可協助使用者探索及使用 Chat 應用程式的主要功能。
  • 啟動對話方塊:對話方塊是視窗式介面,以卡片為基礎,應用程式可開啟這類介面與使用者互動。多張資訊卡可以依序串連,協助使用者完成多步驟程序,例如填寫表單資料。
  • 程式碼研究室:準備好建構更進階的即時通訊應用程式了嗎?查看意見回饋 程式碼研究室的即時通訊應用程式 運用 Gemini 打造 Google Chat 擴充應用程式