設定 Google Chat 應用程式

本頁面說明如何將 Google Chat 應用程式設為 Google Workspace 外掛程式，並部署該應用程式。

如要部署及測試可擴充 Chat 的 Google Workspace 外掛程式，您必須使用 Google Chat API 啟用及設定 Chat 應用程式。您可以在 Chat API 設定中指定 Chat 應用程式的所有詳細資料，包括名稱、顯示圖片、部署方式，以及要使用的互動功能。

必要條件

HTTP

• 具備 Google Chat 存取權的 Google Workspace 企業或進階版帳戶。
• 建立 Google Cloud 專案。
• 設定 OAuth 同意畫面。
• 啟用下列 Google Workspace API：
  • Google Chat API
  • Google Workspace Add-ons API
    您無法使用 Google Workspace Add-ons API 建立及管理 Chat 應用程式的部署作業。詳情請參閱「限制和已知問題」。
• 可代管 Chat 應用程式服務架構的 HTTP 端點。

Apps Script

• 具備 Google Chat 存取權的 Google Workspace 企業或進階版帳戶。
• 建立 Google Cloud 專案。
• 設定 OAuth 同意畫面。
• 啟用 Google Chat API。
• 建立獨立的 Apps Script 專案，並啟用進階 Chat 服務。
• 在清單檔中設定 Chat，方法是新增 addons.chat 物件和任何必要的範圍 (oauthScopes) 或 HTTPS 網址前置字串 (urlFetchWhitelist)。

選擇 Chat 應用程式的顯示名稱、顯示圖片和說明

Chat 應用程式的名稱、顯示圖片和說明會在 Chat UI 中向使用者顯示。使用者可透過下列方式查看或使用這類資訊，以便與 Chat 應用程式互動：

• 使用 @ 提及 Chat 應用程式，將其加入聊天室或傳送訊息給它。
• 使用 Chat 應用程式尋找並開始即時訊息對話。在「應用程式」選單中，即時訊息會顯示 Chat 應用程式的名稱和顯示圖片。
• 使用者可透過撰寫列瀏覽 Chat 應用程式，並查看使用者名稱、顯示圖片和說明。

設定 Chat 應用程式前，請務必準備下列資訊：

欄位	說明	格式
應用程式名稱	Chat 應用程式的顯示名稱。	最多 25 個半形英數字元
顯示圖片網址	顯示為 Chat 應用程式顯示圖片。	指向正方形圖片 (PNG 或 JPEG) 的 HTTPS 網址。 建議大小為 256 x 256 像素以上。
說明	簡要說明 Chat 應用程式的用途。	最多 40 個半形英數字元

在下一個章節中，您將在 Chat API 的設定中指定這項資訊。

在 Google Cloud 控制台中設定 Chat 應用程式

取得 Chat 應用程式詳細資料後，請開啟 Cloud 專案並設定 Chat API：

1. 在 Google Cloud 控制台中，前往 Chat API 頁面，然後按一下「Configuration」頁面：

   前往 Chat API 設定頁面

2. 在「應用程式資訊」下方，填寫「應用程式名稱」、「顯示圖片網址」和「說明」欄位。

3. 在「互動功能」下方，將「啟用互動功能」切換至開啟位置，然後完成下列操作：

   1. 在「功能」下方，選取一或多個核取方塊，讓使用者能夠安裝及使用 Chat 應用程式：

      • 接收 1:1 訊息：使用者可以在使用者與 Chat 應用程式之間的專屬聊天室中，安裝 Chat 應用程式並傳送訊息。

      • 加入聊天室和群組對話：使用者可以在有多人參與的聊天室中加入 Chat 應用程式，並與該應用程式互動。

   2. 在「連線設定」下方，選取要用來接收即時通訊事件物件的架構：

      • 如要使用 HTTP 服務，請選取「HTTP 端點網址」並提供網址。
      • 如要使用 Google Apps Script 專案，請選取「Apps Script」，然後提供專案的部署作業 ID。
      警告： 如果已填入 Apps Script 部署作業 ID，Cloud 專案就會連結至現有的 Google Workspace 外掛程式。如果您在 Chat API 中更新部署 ID，附加元件的部署 ID 也會隨之更新，這可能會影響您在 Google Workspace Marketplace 中的產品資訊。如要查看外掛程式設定，請參閱 Google Workspace Marketplace 說明文件中的「在 Google Workspace Marketplace SDK 中設定應用程式」。

   3. 選用：如要接收多個端點或函式的事件物件，請依序前往「進階設定」>「觸發條件」，然後為下列聊天室觸發條件提供或更新回呼函式：

      注意： 如果是 Apps Script，如果您未更新觸發事件，就必須使用這個部分填入的對應回呼函式 (例如 onMessage、onAddedToSpace 和 onRemovedFromSpace)。
      • ADDED_TO_SPACE：使用者將 Chat 應用程式新增至群組對話或聊天室，或是安裝 Chat 應用程式以傳送 1:1 訊息。
      • MESSAGE：使用者傳送訊息給 Chat 應用程式。例如，傳送即時訊息給 Chat 應用程式，或是在有多人參與的聊天室中使用 @號提及 Chat 應用程式。
      • REMOVED_FROM_SPACE：使用者從聊天室中解除安裝或移除 Chat 應用程式。

   4. 選用：新增其他互動功能，例如斜線指令或連結預覽畫面。

   5. 在「瀏覽權限」下方指定您的電子郵件地址，這樣您就可以在發布至 Google Workspace Marketplace 前，安裝及測試 Chat 應用程式。您最多可以指定五位使用者，或一或多個 Google Workspace 機構中的 Google 群組。

4. 選用：在「Logs」下方，選取「Log errors to Logging」核取方塊，即可使用 Google Cloud Logging。詳情請參閱 Chat API 說明文件中的「查詢 Chat 應用程式的錯誤記錄」。

5. 按一下 [儲存]。

儲存設定後，您在 Chat API 的「瀏覽權限」設定中指定的任何使用者，都可以安裝、測試或使用 Chat 應用程式。如要開始測試及偵錯 Chat 應用程式，請參閱 Chat API 說明文件中的「測試 Google Chat 應用程式的互動功能」。

現有 Google Workspace 外掛程式的注意事項

Chat 應用程式需要的設定與可擴充其他 Google Workspace 應用程式的 Google Workspace 外掛程式不同。如果您的外掛程式擴充其他 Google Workspace 應用程式，請考量下列 Chat 應用程式設定需求：

• 個人和 Google Workspace 管理員都必須能夠從 Marketplace 安裝您的外掛程式。您可以在 Google Workspace Marketplace SDK 中設定這些安裝設定。
• 即時通訊應用程式不會使用您在manifest的 addons.common 物件中，為其他 Google Workspace 應用程式設定的名稱和標誌。
• 如果是發布至 Google Workspace Marketplace 的外掛程式，您無法儲存 Google Chat API 設定的任何變更草稿。更新並儲存 Chat API 設定後，所有現有使用者都能使用更新後的 Chat 應用程式。如要更新 Marketplace 產品資訊，您可以先建立草稿，再提交任何變更。

• 如果您使用 Apps Script 建構外掛程式，請按照下列步驟操作：

  • 您必須使用與其他外掛程式設定相同的 Apps Script 部署 ID。
  • 您無法使用 Apps Script 編輯器在 Chat 中安裝測試部署。而是必須直接從 Chat UI 安裝。

• 如果您使用 HTTP 服務建構外掛程式，請在使用 Google Workspace Add-ons API 建立的資訊清單和部署中省略任何 Chat 應用程式設定詳細資料。您在 Google Workspace Marketplace SDK 中指定的 HTTP 部署作業，僅供其他 Google Workspace 應用程式使用。

相關主題

• 如要管理 Chat API 存取權，請參閱 Google Chat API 說明文件中的「設定 Google Chat API」。
• 測試 Google Chat 應用程式的互動功能
• 發布 Google Chat 應用程式