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

本頁面說明如何使用 Google Apps Script 建構 Google Chat 應用程式。Chat 擴充應用程式可讓您直接傳送訊息，並根據您的訊息做出回應。

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

在上圖中，使用者與 Apps Script Chat 應用程式互動時，資訊流程如下：

1. 使用者透過即時訊息或在 Chat 聊天室中，傳送訊息給 Chat 擴充應用程式。
2. Chat 擴充應用程式邏輯是在 Google Cloud 的 Apps Script 中實作，可接收及處理訊息。
3. Chat 應用程式邏輯可視需要與 Google Workspace 服務 (例如日曆或試算表) 或其他 Google 服務 (例如 Google 地圖或 YouTube) 整合。
4. Chat 擴充應用程式邏輯會將回覆傳送回 Chat 中的 Chat 擴充應用程式服務。
5. 系統會將回應傳送給使用者。

目標

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

必要條件

• Business 或 Enterprise Google Workspace 帳戶，且可存取 Google Chat。
• Google Cloud 專案。如要建立專案，請參閱「建立 Google Cloud 專案」。

設定環境

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

如果尚未開啟，請開啟要用於這個範例的雲端專案：

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

   選取雲端專案

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

啟用 Chat API

您必須先在 Google Cloud 專案中啟用 Google API，才能使用。您可以在單一 Google Cloud 專案中啟用一或多個 API。

• 在 Google Cloud 控制台啟用 Google Chat API。

  啟用 API

設定 OAuth 同意畫面

所有使用 OAuth 2.0 的應用程式都必須設定同意畫面。設定應用程式的 OAuth 同意畫面，可定義向使用者和應用程式審查人員顯示的內容，並註冊應用程式，以便日後發布。

1. 在 Google API 控制台中，依序前往「Menu」(選單) >「Google Auth platform」>「Branding」(品牌)。

   前往「Branding」(品牌宣傳)

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

設定指令碼

如要設定指令碼，請使用 Apps Script 入門頁面的 Chat 擴充應用程式範本。

建立 Apps Script 專案

1. 在 Apps Script 的「入門」頁面，前往「Google Workspace 外掛程式入門範本」，然後點選「Chat 擴充應用程式」範本：

   開啟 Chat 擴充應用程式範本

2. 在開啟的新 Apps Script 專案中，為專案命名：

   1. 按一下「未命名專案」。

   2. 在「Project title」(專案名稱) 中輸入 Quickstart app。

   3. 按一下 [重新命名]。

日後如要使用特定 Google API 或發布應用程式，請務必將雲端專案與 Apps Script 專案建立關聯。本指南不需執行這項操作。詳情請參閱 Google Cloud 專案指南。

建立測試部署作業

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

如要取得 head 部署作業 ID，請按照下列步驟操作：

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

設定 Chat 應用程式

請按照下列步驟設定 Google Chat 應用程式：

1. 在 API 控制台中搜尋 Google Chat API，然後按一下「Google Chat API」。
2. 按一下「管理」。

3. 按一下「設定」，然後設定 Chat 應用程式：

   1. 在「App name」欄位中輸入 Quickstart app。
   2. 在「Avatar URL」(顯示圖片網址) 欄位中，輸入 https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png。
   3. 在「Description」(說明) 欄位輸入 Quickstart app。
   4. 在「功能」下方，選取「加入聊天室和群組對話」。
   5. 在「連線設定」下方，選取「Apps Script 專案」。
   6. 在「Deployment ID」欄位中，貼上先前複製的首要部署作業 ID。
   7. 在「瀏覽權限」下方，選取「僅限您網域中的特定使用者和群組」，然後輸入您的電子郵件地址。

4. 按一下 [儲存]。

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

測試 Chat 應用程式

如要測試 Chat 應用程式，請開啟與 Chat 應用程式的即時訊息聊天室，並傳送訊息：

1. 使用您在新增自己為早鳥測試者時提供的 Google Workspace 帳戶開啟 Google Chat。

   前往 Google Chat

2. 按一下 「New chat」(發起新即時通訊)。
3. 在「新增 1 位或多位使用者」欄位中，輸入 Chat 擴充應用程式的名稱。

4. 從結果中選取 Chat 應用程式。系統會開啟即時訊息。

   注意：如果結果清單中未顯示 Chat 擴充應用程式，請確認您已在 Google API 控制台的「Chat API Configuration」頁面中，將 Google Workspace 帳戶加入「Visibility」設定。

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

   Chat 應用程式會感謝您新增，並回覆您的訊息。

如要新增早鳥測試者，並進一步瞭解如何測試互動功能，請參閱「測試 Google Chat 應用程式的互動功能」。

疑難排解

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

雖然 Chat UI 可能不會顯示錯誤訊息，但只要開啟 Chat 擴充應用程式的錯誤記錄功能，就能查看描述性錯誤訊息和記錄資料，協助您修正錯誤。如需查看、偵錯及修正錯誤的相關協助，請參閱「排解及修正 Google Chat 錯誤」。

清除所用資源

為避免系統向您的 Google Cloud 帳戶收取本教學課程所用資源的費用，建議您刪除雲端專案。

注意：刪除專案會造成以下影響：

• 專案中的所有內容都會遭到刪除。如果您使用現有專案來進行本教學課程，刪除專案將一併刪除其中已完成的所有工作。
• 自訂專案 ID 會消失。您建立這個專案時，可能已建立日後使用的自訂專案 ID。如要保留使用該專案 ID 的網址 (例如 appspot.com 網址)，請從專案刪除選定的資源，不要刪除整個專案。

如果打算進行多個教學課程及快速入門導覽課程，重複使用專案有助於避免超出專案配額限制。

1. 在 Google API 控制台中，前往「管理資源」頁面。依序點選「選單」圖示 >「IAM 與管理」>「管理資源」。

   前往 Resource Manager

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

後續步驟

• 建立互動式資訊卡：資訊卡訊息支援定義的版面配置、按鈕等互動式 UI 元素，以及圖片等互動式多媒體。使用資訊卡訊息呈現詳細資訊、收集使用者資訊，以及引導使用者採取下一步。
• 回應指令：指令可協助使用者探索及使用 Chat 擴充應用程式的主要功能。
• 啟動對話方塊：對話方塊是視窗式、以資訊卡為基礎的介面，應用程式可以開啟對話方塊與使用者互動。多張資訊卡可以依序串連在一起，協助使用者完成多步驟程序，例如填寫表單資料。
• 程式碼實驗室：準備好建構更進階的 Chat 應用程式了嗎？請參閱程式碼實驗室「運用 Gemini 打造 Google Chat 擴充應用程式」中的意見回饋 Chat 擴充應用程式。

非外掛程式的 Chat 擴充應用程式：使用 Google Apps Script 建構 Google Chat 擴充應用程式

如要使用 Apps Script 建構非 Google Workspace 外掛程式的 Chat 擴充應用程式，請按照下列步驟從範本建立指令碼，並設定非外掛程式的 Chat 擴充應用程式。

使用範本建立指令碼

1. 開啟 Chat 擴充應用程式範本

2. 按一下「Untitled project」(未命名的專案)，輸入 Quickstart app，然後按一下「Rename」(重新命名)。

   日後如要使用特定 Google API 或發布應用程式，請務必將雲端專案與 Apps Script 專案建立關聯。不過，本指南不需要您這麼做。詳情請參閱 Google Cloud 專案指南。

3. 在 Chat 應用程式 Apps Script 專案中，依序點選「部署」>「測試部署作業」。

4. 複製首要部署作業 ID，以便在下一個步驟中使用，然後按一下「完成」。

設定非外掛程式的 Chat 擴充應用程式

在 API 控制台中設定非外掛程式的 Chat 擴充應用程式：

1. 在 API 控制台中搜尋 Google Chat API，然後按一下「Google Chat API」。
2. 按一下「管理」。

3. 按一下「Configuration」(設定)，然後設定非外掛程式的 Chat 應用程式：

   1. 取消勾選「將這個 Chat 擴充應用程式建構為 Google Workspace 外掛程式」。畫面上會顯示對話方塊，請您確認。在對話方塊中，按一下「停用」。
   2. 在「App name」欄位中輸入 Quickstart app。
   3. 在「Avatar URL」(顯示圖片網址) 欄位中，輸入 https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png。
   4. 在「Description」(說明) 欄位輸入 Quickstart app。
   5. 在「功能」下方，選取「加入聊天室和群組對話」。
   6. 在「連線設定」下方，選取「Apps Script」。
   7. 在「Deployment ID」欄位中，貼上先前複製的首要部署作業 ID。
   8. 在「瀏覽權限」下方，選取「僅限您網域中的特定使用者和群組」，然後輸入您的電子郵件地址。

4. 按一下 [儲存]。