本頁面說明如何使用 Google Cloud Functions 建立即時通訊應用程式並進行互動。
如要建構應用程式,請編寫及部署一個 Cloud 函式,讓應用程式用來處理 Google Chat 訊息事件的回應。回應是顯示寄件者名稱和顯示圖片的資訊卡,如下圖所示:
目標
- 設定環境。
- 建立及部署 Cloud 函式。
- 將應用程式發布到 Google Chat。
- 測試應用程式。
必要條件
- 可存取 Google Chat 的 Google Workspace 帳戶。
- Google Cloud 專案。
- 確認您已開啟 Cloud 專案的計費功能。瞭解如何驗證專案的帳單狀態。
設定環境
您必須先在 Google Cloud 專案中啟用 Google API,才能使用 Google API。您可以在單一 Google Cloud 專案中啟用一或多個 API。在 Google Cloud 控制台中,啟用 Google Chat API、Cloud Build API、Cloud Functions API 和 Cloud Pub/Sub API。
建立及部署 Cloud 函式
建立及部署 Cloud 函式,以便產生使用寄件者的顯示名稱和顯示圖片的 Chat 資訊卡。即時通訊應用程式收到訊息時,將執行函式並回應卡片。
如要為即時通訊應用程式建立及部署函式,請完成下列步驟:
Node.js
前往 Google Cloud 控制台中的「Cloud Functions」頁面:
確認已選取即時通訊應用程式的專案。
按一下
[建立函式]。在「建立函式」頁面中設定函式:
- 在「Function name」(函式名稱) 中輸入「QuickStartChatApp」。
- 在「Trigger type」(觸發條件類型) 中選取 [HTTP]。
在 [驗證] 下方,選取 [允許未經驗證的叫用]。
如要進一步瞭解 Google Workspace 驗證程序,請參閱驗證及授權即時通訊應用程式和 API 要求。
按一下「儲存」。
點選「下一步」。
在「Runtime」(執行階段) 中選取 Node.js 10。
在「原始碼」中,選取 [內嵌編輯器]。
在 [進入點] 中,刪除預設文字並輸入
helloChat
。將
index.js
內容替換為下列程式碼:按一下「部署」。
Python
前往 Google Cloud 控制台中的「Cloud Functions」頁面:
確認已選取即時通訊應用程式的專案。
按一下
[建立函式]。在「建立函式」頁面中設定函式:
- 在「Function name」(函式名稱) 中輸入「QuickStartChatApp」。
- 在「Trigger type」(觸發條件類型) 中選取 [HTTP]。
在 [驗證] 下方,選取 [允許未經驗證的叫用]。
如要進一步瞭解 Google Workspace 驗證程序,請參閱驗證及授權即時通訊應用程式和 API 要求。
按一下「儲存」。
點選「下一步」。
在「Runtime」(執行階段) 中選取 Python 3.10。
在「原始碼」中,選取 [內嵌編輯器]。
在 [進入點] 中,刪除預設文字並輸入
hello_chat
。將
main.py
內容替換為下列程式碼:按一下「部署」。
Java
前往 Google Cloud 控制台中的「Cloud Functions」頁面:
確認已選取即時通訊應用程式的專案。
按一下
[建立函式]。在「建立函式」頁面中設定函式:
- 在「Function name」(函式名稱) 中輸入「QuickStartChatApp」。
- 在「Trigger type」(觸發條件類型) 中選取 [HTTP]。
在 [驗證] 下方,選取 [允許未經驗證的叫用]。
如要進一步瞭解 Google Workspace 驗證程序,請參閱驗證及授權 Chat 應用程式和 API 要求。
按一下「儲存」。
點選「下一步」。
在「Runtime」(執行階段) 中選取「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]。
在「Function details」(函式詳細資料) 頁面中,按一下 [Trigger] (觸發條件)。
複製「觸發條件網址」下方的網址。
搜尋「Google Chat API」,然後按一下 [Google Chat API]。
按一下 [Manage] (管理)。
按一下 [Configuration] (設定),然後設定 Google Chat 應用程式:
- 在「App name」(應用程式名稱) 中輸入
Quickstart App
。 - 在「Avatar URL」中輸入
https://developers.google.com/chat/images/quickstart-app-avatar.png
。 - 在「Description」(說明) 中輸入
Quickstart app
。 - 在「功能」下方,選取 [接收 1:1 訊息]、[加入聊天室和群組對話] 和 [將錯誤記錄至 Cloud Logging]。
- 在「連線設定」之下,選取 [應用程式網址],然後將 Cloud 函式觸發條件的網址貼到方塊中。
- 在「權限」之下,選取 [您網域中的特定使用者和群組],然後輸入您的電子郵件地址。
- 在「App name」(應用程式名稱) 中輸入
按一下「儲存」。
你現在可以透過 Google Chat 接收及回覆訊息。
測試即時通訊應用程式
如要測試即時通訊應用程式,請將即時訊息傳送給應用程式:
- 開啟 Google Chat。
- 如要傳送即時訊息給應用程式,請按一下「發起即時通訊」圖示 ,然後在隨即顯示的視窗中按一下 [尋找應用程式]。
- 在「Find apps」對話方塊中搜尋「Quickstart App」。
- 若要開啟與應用程式互傳的即時訊息,請找到「快速入門」應用程式,然後依序按一下「Add」>「Chat」。
- 在即時訊息中輸入
Hello
,然後按下enter
。
應用程式會傳回一張內含顯示名稱和顯示圖片的資訊卡。
後續步驟
如要排解 Chat 應用程式的偵錯問題並進行偵錯,請參閱下列網頁:
- 建構 Chat 應用程式時,您可能需要讀取應用程式的錯誤記錄進行偵錯。如要讀取記錄,請前往 Google Cloud 控制台的「Logs Explorer」(記錄檔探索工具)。
- 疑難排解:
如要在 Chat 應用程式中加入更多功能,請參閱下列指南:
- 建立互動式資訊卡:資訊卡訊息支援已定義的版面配置、按鈕等互動式 UI 元素,以及圖片等互動式多媒體。使用資訊卡訊息來呈現詳細資訊、收集使用者資訊,並引導使用者採取後續行動。
- 支援斜線指令 - 斜線指令可讓您註冊及宣傳特定指令,讓使用者能夠輸入開頭為正斜線 (
/
) 的指令 (例如/help
)。 - 啟動對話方塊 — 對話方塊是指以視窗為基礎的介面,應用程式可開啟,與使用者互動。可以依序將多張卡片合併在一起,協助使用者完成多步驟程序,例如填寫表單資料。
如要進一步瞭解 Google Chat API,請參閱參考說明文件。