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

建立 Google Chat 應用程式,以便直接傳送訊息 回應訊息。

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

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

在上圖中,使用者與 Apps Script 互動 Chat 應用程式提供以下資訊流:

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

目標

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

必要條件

設定環境

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

如果沒有開啟,請開啟您要使用的 Cloud 專案 定義:

  1. 在 Google Cloud 控制台中,前往「選取專案」頁面。

    選取 Cloud 專案

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

啟用 Chat API

您必須先在 Google Cloud 專案中啟用這些 Google API,才能使用這些 API。 您可以在單一 Google Cloud 專案中啟用一或多個 API。
  • 在 Google Cloud 控制台中,啟用 Google Chat API。

    啟用 API

所有使用 OAuth 2.0 的應用程式都需要同意畫面設定。設定中 應用程式的 OAuth 同意畫面,可定義使用者和應用程式看到的內容 並註冊您的應用程式,以便日後發布。

  1. 在 Google Cloud 控制台中,前往「選單」圖示 > API 與服務 >「OAuth 同意畫面」

    前往 OAuth 同意畫面

  2. 在「使用者類型」部分選取「內部」,然後按一下「建立」
  3. 填寫應用程式註冊表單,然後按一下「Save and Continue」
  4. 您現在可以略過新增範圍的步驟,然後按一下「儲存並繼續」。 日後您可以製作並使用應用程式 Google Workspace 機構,您必須將「使用者類型」變更為「外部」, 新增應用程式所需的授權範圍。

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

設定指令碼

如要設定指令碼,請使用範本,然後 管理 Cloud 專案

使用範本建立指令碼

  1. 前往 Apps Script「開始使用」頁面
  2. 按一下「Chat App」範本。您可能需要向下捲動 就能查看這個範本
  3. 按一下「Untitled project」,輸入 Quickstart app,然後 按一下「重新命名」

複製 Cloud 專案編號

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

    前往「IAM &」(身分與存取權管理) 頁面管理員設定

  2. 複製「Project number」欄位中的值。

設定 Apps Script 專案的 Cloud 專案

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

您現已擁有正常運作的應用程式程式碼,不妨試用 (方法如 ,然後配合需求進行自訂。

開啟 Apps Script 範本。目前的帳戶有時可以切換為 存取預設帳戶

建立測試部署作業

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

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

  1. 在 Chat 應用程式 Apps Script 專案中, 按一下「部署」 >「測試部署作業」
  2. 複製「標頭部署作業 ID」供後續步驟使用,然後按一下「完成」

發布 Chat 應用程式

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

  1. Google Cloud 控制台 搜尋 Google Chat API,然後按一下「Google Chat API」
  2. 按一下「管理」
  3. 按一下「設定」,然後設定 Chat 應用程式:

    1. 在「App name」(應用程式名稱) 欄位中輸入 Quickstart app
    2. 在「顯示圖片」欄位中輸入 https://developers.google.com/chat/images/quickstart-app-avatar.png
    3. 在「Description」(說明) 欄位中輸入 Quickstart app
    4. 在「功能」下方,選取「接收 1:1 訊息」加入聊天室和群組對話
    5. 在「連線設定」下方,選取「Apps Script 專案」
    6. 在「Deployment ID」欄位中,貼上您產生的 Head 部署作業 ID 先前複製的內容
    7. 在「瀏覽權限」下方,選取您 網域,然後輸入您的電子郵件地址。
  4. 按一下 [儲存]

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

測試 Chat 應用程式

如要測試 Chat 應用程式,請開啟含有下列對話的即時訊息聊天室: 傳送訊息:

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

    前往 Google Chat

  2. 按一下「新的即時通訊」圖示
  3. 在 [新增 1 或多位使用者] 欄位中,輸入你的使用者名稱 Chat 應用程式。
  4. 從搜尋結果中選取 Chat 應用程式。直接 訊息隨即開啟。

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

    感謝你新增及回音的 Chat 應用程式 訊息。

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

疑難排解

Google Chat 應用程式或 card 會傳回錯誤, 即時通訊介面顯示「發生錯誤」的訊息。 或「無法處理你的要求」。有時使用 Chat UI 不會顯示任何錯誤訊息,但 Chat 應用程式或 資訊卡產生非預期的結果例如資訊卡訊息 顯示。

雖然 Chat UI 中可能不會顯示錯誤訊息, 提供描述性錯誤訊息和記錄資料,協助您修正錯誤 。如需觀看說明, 偵錯及修正錯誤,請參閱 疑難排解並修正 Google Chat 錯誤

清除所用資源

如要避免系統向您的 Google Cloud 帳戶收取 但建議採用 Cloud 專案

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

    前往 Resource Manager

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

後續步驟

  • 建立互動式資訊卡:資訊卡 訊息支援已定義的版面配置、按鈕等互動式 UI 元素,以及 就像圖片這種互動式多媒體一樣利用資訊卡訊息提供詳細資訊 向使用者收集資訊,並引導他們採取下一步。
  • 支援斜線指令:斜線指令可讓 註冊並宣傳使用者可存取您應用程式的特定指令 輸入開頭為正斜線 (/) 的指令,例如 /help
  • 啟動對話方塊:設有視窗、卡片式對話方塊 讓應用程式與使用者互動而開啟的介面多張資訊卡 且可依序串連 例如填寫表單資料
  • 程式碼研究室:準備好打造更進階的 AI 應用體驗 要進行即時通訊嗎?查看意見回饋 本程式碼研究室的 Chat 擴充應用程式 運用 Gemini 打造支援 Google Chat 的應用程式