本頁面說明如何使用 Google Cloud Functions 建立 Google Chat 應用程式並與其互動。
如要建構 Chat 應用程式,您可以編寫及部署 Cloud 函式,Chat 應用程式會使用這個函式來回應使用者的訊息。Chat 應用程式的回應包含資訊卡訊息,其中顯示傳送者的名稱和顯示圖片,如下圖所示:
目標
- 設定環境。
- 建立及部署 Cloud 函式。
- 將應用程式發布到 Google Chat。
- 測試應用程式。
必要條件
- Google Workspace 帳戶,在允許未經驗證的 Google Cloud 函式叫用的 Google Workspace 機構中存取 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。
建立及部署 Cloud 函式
建立及部署 Cloud 函式,以便產生含有傳送者顯示名稱和顯示圖片的 Chat 資訊卡。當 Chat 應用程式收到訊息時,就會執行函式並傳送資訊卡回應。
如要為 Chat 應用程式建立及部署函式,請完成下列步驟:
Node.js
前往 Google Cloud 控制台中的「Cloud Functions」頁面:
請確認已選取 Chat 應用程式的專案。
按一下
「Create Function」(建立函式)。在「Create function」(建立函式) 頁面中設定函式:
- 在「函式名稱」中輸入「QuickStartChatApp」。
- 在「Trigger type」(觸發條件類型) 中,選取「HTTP」。
選取「驗證」下方的「允許未經驗證的叫用」。
如要進一步瞭解 Google Workspace 中的驗證程序,請參閱「驗證及授權 Chat 專用應用程式和 API 要求」。
按一下「儲存」。
點選「下一步」。
在「執行階段」中,選取「Node.js 10」。
在「Source code」(原始碼) 中,選取「Inline Editor」(內嵌編輯器)。
在「進入點」中刪除預設文字並輸入
helloChat
。將
index.js
的內容替換為下列程式碼:按一下「部署」。
Python
前往 Google Cloud 控制台中的「Cloud Functions」頁面:
請確認已選取 Chat 應用程式的專案。
按一下
「Create Function」(建立函式)。在「Create function」(建立函式) 頁面中設定函式:
- 在「函式名稱」中輸入「QuickStartChatApp」。
- 在「Trigger type」(觸發條件類型) 中,選取「HTTP」。
選取「驗證」下方的「允許未經驗證的叫用」。
如要進一步瞭解 Google Workspace 中的驗證程序,請參閱「驗證及授權 Chat 專用應用程式和 API 要求」。
按一下「儲存」。
點選「下一步」。
在「Runtime」中,選取「Python 3.10」。
在「Source code」(原始碼) 中,選取「Inline Editor」(內嵌編輯器)。
在「進入點」中刪除預設文字並輸入
hello_chat
。將
main.py
的內容替換為下列程式碼:按一下「部署」。
Java
前往 Google Cloud 控制台中的「Cloud Functions」頁面:
請確認已選取 Chat 應用程式的專案。
按一下
「Create Function」(建立函式)。在「Create function」(建立函式) 頁面中設定函式:
- 在「函式名稱」中輸入「QuickStartChatApp」。
- 在「Trigger type」(觸發條件類型) 中,選取「HTTP」。
選取「驗證」下方的「允許未經驗證的叫用」。
如要進一步瞭解 Google Workspace 中的驗證程序,請參閱「驗證及授權 Chat 應用程式和 API 要求」。
按一下「儲存」。
點選「下一步」。
在「Runtime」中,選取「Java 11」。
在「Source code」(原始碼) 中,選取「Inline Editor」(內嵌編輯器)。
在「進入點」中刪除預設文字並輸入
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」。
在「函式詳細資料」頁面中,按一下「觸發條件」。
複製「觸發條件網址」底下的網址。
搜尋「Google Chat API」,然後依序按一下「Google Chat API」和「管理」。
按一下「設定」並設定 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 接收及回覆訊息。
測試 Chat 應用程式
如要測試 Chat 應用程式,請傳送即時訊息給應用程式:
- 開啟 Google Chat。
- 如要傳送即時訊息至應用程式,請按一下「發起即時通訊」圖示 ,然後在隨即顯示的視窗中按一下「尋找應用程式」。
- 在「Find apps」對話方塊中,搜尋「quickstart App」。
- 如要使用應用程式開啟即時訊息,請找到「quickstart App」,然後依序點選「Add」>「Chat」。
- 在即時訊息中輸入
Hello
,然後按下enter
鍵。
應用程式會傳回含有顯示名稱和顯示圖片的資訊卡。
排解錯誤
如要排解 Chat 專用應用程式的問題並進行偵錯,請參閱「疑難排解及修正 Google Chat 應用程式錯誤」。
相關主題
如要為 Chat 應用程式新增更多功能,請參閱下列指南:
- 建立互動式資訊卡訊息 — 資訊卡訊息支援經過定義的版面配置、互動式 UI 元素 (例如按鈕),以及圖片 (例如圖片)。利用資訊卡訊息顯示詳細資訊、收集使用者的資訊,並引導使用者採取下一步。
- 支援斜線指令:斜線指令可讓您註冊及通告特定指令,讓使用者透過輸入以正斜線 (
/
) 開頭的指令 (例如/help
)。 - 啟動對話方塊:對話方塊是視窗式的卡片介面,應用程式可開啟這些介面與使用者互動。多張資訊卡可以依序合併,有助於使用者完成多步驟的程序,例如填寫表單資料。
如要進一步瞭解 Google Chat API,請參閱參考說明文件。