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

建立 Google Chat 應用程式,以便您直接傳送訊息,並透過回音回應來回應。

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

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

在上圖中,與 Apps Script Chat 應用程式互動的使用者俱有下列資訊流程:

  1. 使用者透過即時訊息或 Chat 聊天室傳送訊息給 Chat 應用程式。
  2. 在 Apps Script 中實作的 Chat 應用程式邏輯,位於 Google Cloud 中,會接收及處理訊息。
  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 控制台中,依序點選「選單」圖示 >「API 和服務」>「OAuth 同意畫面」

    前往 OAuth 同意畫面

  2. 選取應用程式的使用者類型,然後按一下「Create」
  3. 填寫應用程式註冊表單,然後按一下「儲存並繼續」
  4. 目前,您可以略過新增範圍,然後按一下「儲存並繼續」。日後建立適用於 Google Workspace 機構外部的應用程式時,您必須新增並驗證應用程式需要的授權範圍。

  5. 針對使用者類型選取「外部」,請新增測試使用者:
    1. 在「測試使用者」下方,點選「新增使用者」
    2. 輸入您的電子郵件地址和任何其他授權測試使用者,然後按一下「儲存並繼續」
  6. 查看您的應用程式註冊摘要。如要變更,請按一下「編輯」。如果應用程式註冊正確無誤,請按一下「Back to Dashboard」(返回資訊主頁)

設定指令碼

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

使用範本建立指令碼

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

複製 Cloud 專案編號

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

    前往「IAM 與管理員設定」

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

設定 Apps Script 專案的 Cloud 專案

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

您現在已設定好可正常運作的應用程式程式碼 (如下列步驟所述),然後根據需求進行自訂。

開啟 Apps Script 範本時,請確認您登入的 Google 帳戶正確無誤。目前帳戶有時可以在未經您提示的情況下 切換為您的預設帳戶。

建立測試部署作業

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

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

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

發布 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. 在「Connection settings」(連線設定) 下方,選取「Apps Script project」(Apps Script 專案),然後將 Deployment ID 貼到欄位中。
    6. 在「Visibility」(顯示設定) 下方,選取「specific people and groups」,然後輸入電子郵件。
  4. 按一下「儲存」,然後重新整理頁面。

  5. 在設定頁面的「App status」下方,將狀態設為「Live - available by users」

  6. 點按「儲存」

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

測試 Chat 應用程式

  1. 開啟 Chat
  2. 依序點選「發起即時通訊」 >「尋找應用程式」,傳送新的即時訊息給應用程式。
  3. 在「尋找應用程式」頁面上,搜尋「Quickstart App」。
  4. 按一下「quickstart App」旁邊的「Chat」
  5. 在與應用程式互傳的即時訊息中,輸入 Hello,然後按下 enter 鍵。

Chat 應用程式感謝您新增它,並回應您的訊息。

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

後續步驟

  • 建立互動式資訊卡:資訊卡訊息支援定義的版面配置、互動式 UI 元素 (例如按鈕),以及圖片等互動式多媒體。利用資訊卡訊息來展示詳細資訊、收集使用者的資訊,並引導使用者採取下一步。
  • 支援斜線指令:斜線指令可讓您註冊及通告使用者可以透過輸入正斜線 (/) 開頭的指令,藉此提供應用程式的特定指令,例如 /help
  • 啟動對話方塊:對話方塊是視窗式的資訊卡式介面,可供應用程式開啟以與使用者互動。您可以依序整合多張資訊卡,協助使用者完成多步驟程序,例如填寫表單資料。