本頁說明如何設定及部署 Google Chat 擴充應用程式,做為 Google Workspace 外掛程式。
如要部署及測試擴充 Chat 的 Google Workspace 外掛程式,您必須使用 Google Chat API 啟用及設定 Chat 應用程式。您可以在 Chat API 設定中指定 Chat 應用程式的所有詳細資料,包括名稱、虛擬人偶、部署作業,以及要使用的互動功能。
必要條件
- 具有 Google Chat 存取權的 Business 或 Enterprise 版 Google Workspace 帳戶。
- 建立 Google Cloud 專案。
- 設定 OAuth 同意畫面。
- 啟用 Google Chat API。
選擇 Chat 應用程式的顯示名稱、顯示圖片和說明
Chat 應用程式的名稱、顯示圖片和說明會顯示在 Chat 使用者介面中。使用者會透過下列方式查看或使用這項資訊,與 Chat 應用程式互動:
- @提及 Chat 應用程式,將其加入聊天室或傳送訊息給該應用程式。
- 找出並開始與 Chat 應用程式互傳即時訊息。 在「應用程式」選單中,即時訊息會顯示 Chat 應用程式的名稱和顯示圖片。
- 使用者可以在撰寫列中瀏覽 Chat 應用程式,並查看名稱、顯示圖片和說明。
設定 Chat 應用程式前,請先準備下列資訊:
欄位 | 說明 | 格式 |
---|---|---|
應用程式名稱 | Chat 應用程式的顯示名稱。 | 最多 25 個半形英數字元 |
顯示圖片網址 | 顯示為 Chat 應用程式顯示圖片的圖片。 | 指向正方形圖片 (PNG 或 JPEG) 的 HTTPS 網址。 建議大小為 256 x 256 像素以上。 |
說明 | 簡要說明 Chat 應用程式的用途。 | 最多 40 個半形英數字元 |
在下一節中,您會在 Chat API 的設定中指定這項資訊。
在 Google Cloud 控制台中設定 Chat 應用程式
在 Google Cloud 控制台中,您可以設定 Chat 應用程式的詳細資料,包括顯示名稱、虛擬人偶和說明,這些資訊會顯示在 Chat 中。這些詳細資料只會顯示在 Chat 中。如要將 Chat 擴充應用程式發布至 Marketplace,您也必須指定 Chat 擴充應用程式Marketplace 資訊中顯示的詳細資料。
取得 Chat 應用程式詳細資料後,開啟 Cloud 專案並設定 Chat API:
在 Google Cloud 控制台中,前往 Chat API 頁面,然後按一下「Configuration」(設定) 頁面:
在「應用程式資訊」下方,填寫「應用程式名稱」、「顯示圖片網址」和「說明」欄位。
在「互動功能」下方,按一下「啟用互動功能」,將其切換為開啟狀態,然後完成下列步驟:
在「功能」下方,選取「加入聊天室和群組對話」,讓使用者安裝及使用 Chat 應用程式。
根據預設,使用者可以在使用者和 Chat 應用程式之間的專屬聊天室中,安裝 Chat 應用程式並傳送訊息。使用者也可以在有多位成員的聊天室中新增 Chat 應用程式並與之互動。
在「連線設定」下方,選取要用來接收 Chat 事件物件的架構:
- 如要使用 HTTP 服務,請選取「HTTP 端點網址」並提供網址。
- 如要使用 Google Apps Script 專案,請選取「Apps Script」,並提供專案的部署作業 ID。
選用:如要將事件物件傳送至多個端點或函式,請依序前往「連線設定」>「觸發條件」,然後提供或更新下列即時通訊觸發條件的回呼函式:
- 加入聊天室:使用者將 Chat 應用程式加入群組對話或聊天室,或是為 1:1 訊息安裝 Chat 應用程式。
- 訊息:使用者傳送訊息給 Chat 應用程式。舉例來說,使用者傳送即時訊息給 Chat 應用程式,或在有多位使用者的聊天室中,使用 @符號提及 Chat 應用程式。
- 從聊天室中移除:使用者從聊天室中解除安裝或移除 Chat 應用程式。
- 應用程式指令:使用者透過 Chat 應用程式使用快速指令或斜線指令。
在「瀏覽權限」下方指定電子郵件地址,即可在發布至 Google Workspace Marketplace 前安裝及測試 Chat 應用程式。最多可指定五位使用者,或一或多個 Google Workspace 機構的 Google 群組。
選用:在「記錄」下方,選取「將錯誤記錄到 Cloud Logging」核取方塊,即可使用 Google Cloud Logging。詳情請參閱 Chat API 說明文件中的「查詢 Chat 應用程式的錯誤記錄」。
按一下 [儲存]。
儲存設定後,您在 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 中設定這些安裝設定。
- Chat 應用程式不會使用您在資訊清單的
addons.common
物件中,為其他 Google Workspace 應用程式設定的名稱和標誌。 - 如果外掛程式已發布至 Google Workspace Marketplace,您就無法儲存對 Google Chat API 設定所做的任何變更草稿。更新並儲存 Chat API 設定後,所有現有使用者都能使用更新後的 Chat 擴充應用程式。如要更新 Marketplace 產品資訊,可以先建立草稿,再提交變更。
如果您使用 Apps Script 建立外掛程式:
- 您必須使用與其餘外掛程式設定相同的 Apps Script 部署作業 ID。
- 您無法使用 Apps Script 編輯器在 Chat 中安裝測試部署。請改為直接從 Chat 使用者介面安裝。
如果您使用 HTTP 服務建構外掛程式,請在透過 Google Workspace 外掛程式 API 建立的資訊清單和部署作業中,省略任何 Chat 應用程式設定詳細資料。您在 Google Workspace Marketplace SDK 中指定的 HTTP 部署作業,只會用於其他 Google Workspace 應用程式。
相關主題
- 如要管理 Chat API 的存取權,請參閱 Google Chat API 說明文件中的「設定 Google Chat API」。
- 測試 Google Chat 應用程式的互動功能