本頁說明如何建立 HTTP Chat 應用程式。實作此架構的方法有幾種。您可以在 Google Cloud 中使用 Cloud Functions、Cloud Run 和 App Engine。在這個快速入門導覽課程中,您將編寫及部署 Chat 應用程式用來回應使用者訊息的 Cloud 函式。
在這個架構中,您可以將 Chat 設定為使用 HTTP 與 Google Cloud 或內部部署伺服器整合,如下圖所示:
在上圖中,與 HTTP Chat 應用程式互動的使用者俱備下列資訊流程:
- 使用者透過即時訊息或 Chat 聊天室,將 Chat 訊息傳送至 Chat 應用程式。
- 系統會將 HTTP 要求傳送至網路伺服器,而該伺服器即為包含 Chat 應用程式邏輯的雲端或內部部署系統。
- 您可以選擇將 Chat 應用程式邏輯與 Google Workspace 服務 (例如日曆和試算表)、其他 Google 服務 (如 Google 地圖、YouTube 和 Vertex AI) 或其他網路服務整合 (例如專案管理系統或票證工具)。
- 網路伺服器將 HTTP 回應傳回 Chat 中的 Chat 應用程式服務。
- 系統會將回應傳送給使用者。
- 或者,Chat 應用程式可以呼叫 Chat API,以非同步方式發布訊息或執行其他作業。
這個架構可讓您靈活使用系統中現有的程式庫和元件,因為這些 Chat 應用程式可使用不同的程式設計語言設計。
目標
- 設定環境。
- 建立及部署 Cloud 函式。
- 將應用程式發布到 Chat。
- 測試應用程式。
必要條件
- 擁有 Google Workspace 機構存取權的 Google Workspace 帳戶,且該機構允許在未經驗證的 Google Cloud 函式叫用中叫用 Google Chat。
- Google Cloud 專案。
- 確認您已開啟 Cloud 專案的計費功能。瞭解如何驗證專案的帳單狀態。
設定環境
使用 Google API 前,請先在 Google Cloud 專案中啟用這些 API。您可以在單一 Google Cloud 專案中啟用一或多個 API。在 Google Cloud 控制台中啟用 Google Chat API、Cloud Build API、Cloud Functions API、Cloud Pub/Sub API、Cloud Logging API、Artifact Registry API 和 Cloud Run API。
建立及部署 Cloud 函式
建立及部署 Cloud 函式,以產生含有傳送者顯示名稱和顯示圖片圖片的 Chat 資訊卡。Chat 應用程式收到訊息時,就會執行函式並回覆資訊卡。
如要為 Chat 應用程式建立及部署函式,請完成下列步驟:
Node.js
前往 Google Cloud 控制台中的「Cloud Functions」頁面:
請確認您已選取 Chat 應用程式的專案。
按一下
「建立函式」。在「建立函式」頁面中設定函式:
- 在「環境」中,選取「第 2 代」。
- 在「Function name」(函式名稱) 中輸入
QuickStartChatApp
。 - 在「區域」中選取地區。
- 選取「驗證」下方的「允許未經驗證的叫用」。
- 點選「下一步」。
在「執行階段」中,選取「Node.js 20」。
在「原始碼」中,選取「內嵌編輯器」。
在「進入點」中刪除預設文字,然後輸入
helloChat
。將
index.js
的內容替換為下列程式碼:按一下「部署」。
Python
前往 Google Cloud 控制台中的「Cloud Functions」頁面:
請確認您已選取 Chat 應用程式的專案。
按一下
「建立函式」。在「建立函式」頁面中設定函式:
- 在「Function name」(函式名稱) 中輸入
QuickStartChatApp
。 - 在「觸發條件類型」中,選取「HTTP」。
- 選取「驗證」下方的「允許未經驗證的叫用」。
- 點按「儲存」。
- 點選「下一步」。
- 在「Function name」(函式名稱) 中輸入
在「執行階段」中,選取「Python 3.10」。
在「原始碼」中,選取「內嵌編輯器」。
在「進入點」中刪除預設文字,然後輸入
hello_chat
。將
main.py
的內容替換為下列程式碼:按一下「部署」。
Java
前往 Google Cloud 控制台中的「Cloud Functions」頁面:
請確認您已選取 Chat 應用程式的專案。
按一下
「建立函式」。在「建立函式」頁面中設定函式:
- 在「Function name」(函式名稱) 中輸入
QuickStartChatApp
。 - 在「觸發條件類型」中,選取「HTTP」。
- 選取「驗證」下方的「允許未經驗證的叫用」。
- 點按「儲存」。
- 點選「下一步」。
- 在「Function name」(函式名稱) 中輸入
在「執行階段」中,選取「Java 11」。
在「原始碼」中,選取「內嵌編輯器」。
在「進入點」中刪除預設文字,然後輸入
HelloChat
。將
src/main/java/com/example/Example.java
重新命名為src/main/java/HelloChat.java
。使用下列程式碼取代
HelloChat.java
的內容:將
pom.xml
的內容替換為下列程式碼:按一下「部署」。
Cloud Functions 詳細資料頁面會開啟,並顯示兩個進度指標:一個用於建構,另一個用於服務。當兩個進度指標都消失且以勾號取代時,就表示您的函式已部署完成且準備就緒。
將應用程式發布到 Google Chat
部署 Cloud 函式後,請按照下列步驟將其轉換為 Google Chat 應用程式:
在 Google Cloud 控制台中,依序點選「選單」圖示 >「Cloud Functions」。
請確保選取的是已啟用 Cloud Functions 的專案。
在函式清單中,按一下「QuickStartChatApp」QuickStartChatApp。
按一下「觸發條件」分頁標籤。
在「HTTPS」下方複製網址。
搜尋「Google Chat API」,然後依序按一下「Google Chat API」和「管理」。
按一下「設定」並設定 Google Chat 應用程式:
- 在「應用程式名稱」中輸入
Quickstart App
。 - 在「Avatar URL」(顯示圖片網址) 中輸入
https://developers.google.com/chat/images/quickstart-app-avatar.png
。 - 在「說明」中輸入
Quickstart app
。 - 在「功能」下方,選取「接收 1:1 訊息」和「加入聊天室和群組對話」。
- 在「Connection settings」下方,選取「App URL」,並將 Cloud 函式觸發條件的網址貼到方塊中。
- 在「顯示設定」下方,選取「將這個 Google Chat 應用程式提供給網域中的特定使用者和群組」,然後輸入您的電子郵件地址。
- 在「記錄檔」下方,選取「將錯誤記錄到 Logging」。
- 在「應用程式名稱」中輸入
點按「儲存」。
Chat 應用程式已準備就緒,可以在 Chat 中接收及回覆訊息了。
測試 Chat 應用程式
如要測試 Chat 應用程式,請透過 Chat 應用程式開啟即時訊息聊天室並傳送訊息:
使用您新增為信任測試人員時提供的 Google Workspace 帳戶,開啟 Google Chat。
- 按一下「發起即時通訊」圖示 。
- 在「Add 1 or more people」欄位中,輸入 Chat 應用程式的名稱。
從搜尋結果中選取 Chat 應用程式。系統隨即會開啟即時訊息。
- 在與應用程式相關的新即時訊息中輸入
Hello
,然後按下enter
。
Chat 應用程式的回應包含資訊卡訊息,顯示傳送者的名稱和顯示圖片,如下圖所示:
如要新增信任的測試人員並進一步瞭解如何測試互動功能,請參閱「測試 Google Chat 應用程式的互動式功能」。
疑難排解
如果 Google Chat 應用程式或卡片傳回錯誤,Chat 介面會顯示「發生錯誤」或「無法處理您的要求」的訊息。有時 Chat UI 不會顯示任何錯誤訊息,但即時通訊應用程式或資訊卡產生非預期的結果,例如資訊卡訊息可能不會顯示。
雖然 Chat UI 可能不會顯示錯誤訊息,但我們提供描述性的錯誤訊息和記錄資料,協助您修正啟用 Chat 應用程式錯誤記錄功能時發生的錯誤。如要瞭解如何查看、偵錯及修正錯誤,請參閱「疑難排解及修正 Google Chat 錯誤」。
清除所用資源
如要避免系統向您的 Google Cloud 帳戶收取本教學課程中所用資源的費用,建議您刪除 Cloud 專案。
- 在 Google Cloud 控制台中,前往「Manage resources」(管理資源) 頁面。依序點選「Menu」圖示 >「IAM & Admin」>「管理資源」。
- 在專案清單中選取要刪除的專案,然後按一下「Delete」(刪除) 。
- 在對話方塊中輸入專案 ID,然後按一下「Shut down」(關閉) 來刪除專案。
相關主題
如要在 Chat 應用程式中加入更多功能,請參閱以下資源: