本頁面提供 Google Chat API 和 Google Chat 應用程式的總覽。
Google Chat API 總覽
Chat API 包含 gRPC 服務或 REST 資源和方法,可授予 Chat 存取權,包括聊天室、聊天室成員、訊息、訊息回應、訊息附件、聊天室事件和使用者讀取狀態。
概念
以下各節定義了 Chat API 的服務、資源和方法:
- Spaces
聊天室是使用者和應用程式可以對話及分享檔案的地方。聊天室分為幾種類型,即時訊息 (DM) 是指兩位使用者之間,或使用者與 Chat 應用程式之間的 1 對 1 對話。群組對話是指三位以上使用者與 Chat 應用程式之間的對話。具名聊天室是持續存在的空間,使用者可以在其中傳送訊息、共用檔案及協作。
資源參照:
如需使用範例,請參閱:
- 成員
成員是指已加入或受邀加入聊天室的使用者和 Chat 應用程式。
資源參照:
如需使用範例,請參閱:
- 訊息
資源參照:
如需使用範例,請參閱:
- 反應
回應是指使用者用來回應訊息的表情符號,例如 👍、🚲 和 🌞。
資源參照:
如需使用範例,請參閱:
- 自訂表情符號
自訂表情符號:在 Google Chat 中建立並與機構共用的自訂表情符號。自訂表情符號可加入訊息內容,或用來回應訊息。
資源參照:
- 媒體和附件
媒體是指上傳到 Google Chat 的檔案,例如圖片、影片和文件。
媒體資源參照 (不適用於 RPC):
附件是指附加至訊息的媒體 (檔案) 執行個體。
資源參照:
如需使用範例,請參閱:
- Space 活動
聊天室事件代表聊天室或其子項資源的變更,包括成員、訊息和回應。
資源參照:
如需使用範例,請參閱:
- 使用者讀取狀態
使用者讀取狀態是單例資源,代表 Google Chat 空間或訊息串中,特定使用者上次讀取訊息的詳細資料。
空間讀取狀態資源參照:
執行緒讀取狀態資源參考資料:
如需使用範例,請參閱:
- 使用者空間通知設定
使用者聊天室通知設定是單例資源,代表 Google Chat 聊天室中特定使用者的通知設定。
資源參照:
驗證
呼叫 Chat API 時需要驗證。每個 Chat API 方法都需要使用者驗證 (代表使用者執行動作或存取資料),或應用程式驗證 (以 Chat 應用程式身分執行動作或存取資料)。部分方法同時支援使用者驗證和應用程式驗證。
如要進一步瞭解 Chat 的驗證機制,請參閱驗證總覽。
用戶端程式庫
對大多數開發人員而言,呼叫 Google Chat API 的建議方式是使用我們正式支援的Cloud 用戶端程式庫,並選擇您偏好的語言,例如 Python、Java 或 Node.js。
如果您使用 Google Apps Script 進行編碼,請改用進階 Chat 服務,不必安裝用戶端程式庫。
建構 Chat 擴充應用程式
透過 Chat API,您可以建構 Google Chat 應用程式,將服務和資源直接帶進 Google Chat。您可以建構 Chat 應用程式來執行下列任一操作:
- 根據使用者輸入的結構化或任意文字查詢,擷取資訊。
- 使用使用者提供的資訊,產生事件報告或其他構件。
- 提升團隊協作效率,例如提供「團隊記憶」或安排資源。
您可以透過幾種不同的架構樣式設計 Chat 應用程式,包括:
- 互動式應用程式:回應使用者互動,例如 @提及或斜線指令,並透過資訊卡和對話方塊呈現資訊或引導使用者完成工作流程。
- 指令列應用程式或 Webhook:從其他系統將主動訊息 (例如鬧鐘或通知) 傳送至聊天室。使用者無法直接與這類應用程式互動。
- 事件驅動型應用程式:訂閱及回應 Chat 聊天室中的活動,例如有新成員加入。應用程式可以傳送訊息或執行其他動作,以回應事件。
如要進一步瞭解如何設計 Chat 應用程式,請參閱「選擇 Google Chat 應用程式架構」。
相關主題
想看看 Google Chat API 的實際運作方式嗎?
Google Workspace 開發人員頻道提供有關提示、秘訣和最新功能的影片。
|