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

建立 Google Chat 應用程式，以便您直接傳送訊息及回覆訊息。

下圖顯示架構與訊息傳遞模式：

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

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

  1. 使用者透過即時訊息或 Chat 聊天室中，傳送訊息給 Chat 應用程式。
  2. 在位於 Google Cloud 的 Apps Script 中實作的 Chat 應用程式邏輯會接收並處理訊息。
  3. 或者，Chat 應用程式邏輯可與 Google Workspace 服務整合，例如 Google 日曆、試算表，或是 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 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. 填寫應用程式註冊表單，然後按一下「儲存並繼續」。

  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 控制台中前往 Cloud 專案。
  2. 依序按一下「設定與公用程式」圖示 >「專案設定」。
  3. 複製專案編號。

設定 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 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. 選取「Connection settings」下方的「Apps Script project」，然後將部署作業 ID 貼到欄位中。
    6. 在「Visibility」(顯示設定) 下方，選取「specific people and groups in your domain」(網域中的特定人員和群組)，然後輸入電子郵件地址。

  4. 按一下「儲存」，然後重新整理頁面。

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

  6. 點按「儲存」。

Chat 應用程式已可回覆訊息。

測試 Chat 應用程式

  1. 開啟 Chat。
  2. 如要傳送新的即時訊息給應用程式，請依序按一下「發起即時通訊」圖示 >「尋找應用程式」。
  3. 在「尋找應用程式」頁面中，搜尋 Quickstart App。
  4. 按一下「快速入門導覽課程應用程式」旁邊的「即時通訊」。
  5. 開啟與應用程式互傳的新訊息，輸入 Hello，然後按下 enter。

應用程式感謝您的新增及回應訊息。

後續步驟

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