Google Apps Script Chat 應用程式快速入門導覽課程

建立 Google Chat 應用程式,並透過回應訊息的方式直接傳送訊息。

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

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

在上圖中,使用者與 Apps Script Chat 應用程式互動時,看到的資訊如下:

  1. 使用者透過即時訊息或 Chat 聊天室,傳送訊息給 Chat 應用程式。
  2. 在 Apps Script 中實作的 Chat 應用程式邏輯會接收及處理訊息。
  3. 您也可以選擇將 Chat 擴充應用程式邏輯與 Google Workspace 服務 (例如日曆或試算表),或是 Google 地圖或 YouTube 等其他 Google 服務整合。
  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. 查看應用程式註冊摘要。如要修改資訊,請按一下「編輯」。如果應用程式註冊正確無誤,請按一下「Back to Dashboard」(返回資訊主頁)

設定指令碼

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

使用範本建立指令碼

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

複製 Cloud 專案編號

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

    前往「IAM & Admin Settings」(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 範本時,請確認您已登入正確的 Google 帳戶。目前帳戶有時可以在您不知情的情況下切換為預設帳戶。

建立測試部署作業

您需要這個 Apps Script 專案的部署 ID,以便在下一個步驟中使用。

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

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

發布 Chat 應用程式

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

  1. Google Cloud 控制台中搜尋 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. 在「功能」下方,選取「接收 1:1 訊息」和「加入聊天室和群組對話」
    5. 在「連線設定」下方,選取「Apps Script 專案」
    6. 在「Deployment ID」(部署作業 ID) 欄位中,貼上您之前複製的 Head 部署作業 ID。
    7. 在「Visibility」(顯示設定) 下方,選取「Specific people and groups in your domain」(在您的網域中的特定人員和群組),然後輸入您的電子郵件地址。
  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 控制台中,前往「管理資源」頁面。依序點選「Menu」圖示 >「IAM & Admin」(IAM 與管理) >「Manage Resources」(管理資源)

    前往 Resource Manager

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

後續步驟

  • 建立互動式資訊卡:資訊卡訊息支援已定義的版面配置、按鈕等互動式 UI 元素,以及圖片等互動式多媒體。利用資訊卡訊息呈現詳細資訊、收集使用者資訊,並引導使用者採取下一步。
  • 支援斜線指令:您可以透過斜線指令註冊及通告特定指令,使用者只要輸入開頭為正斜線 (/) 的指令 (例如 /help),即可提供給應用程式。
  • 啟動對話方塊:對話方塊有視窗式的卡片介面,可供應用程式開啟來與使用者互動。系統會依序處理多張卡片,協助使用者完成多步驟的程序,例如填寫表單資料。
  • 程式碼研究室:準備好建構更強大的 Chat 應用程式了嗎?請參閱程式碼研究室「使用 Gemini 建構適用於 Google Chat 的應用程式」中的意見回饋應用程式。