Google Chat API 總覽

本節說明 Google Chat 應用程式如何呼叫 Chat API,讓 Chat 應用程式執行建立聊天室、新增成員和發布訊息等操作。

驗證

呼叫 Chat API 需要驗證。每個 Chat API 方法都需要使用者驗證 (代表使用者執行動作或存取資料) 或應用程式驗證 (以 Chat 應用程式身分執行動作或存取資料)。部分方法同時支援使用者驗證和應用程式驗證。

如要進一步瞭解 Chat 中的驗證機制,請參閱「驗證總覽」。

用戶端程式庫

對於大多數開發人員而言,建議您使用官方支援的 Cloud 用戶端程式庫,以您偏好的語言 (例如 Python、Java 或 Node.js) 呼叫 Google Chat API。

如果您使用 Google Apps Script 編寫程式碼,請使用進階 Chat 服務,而非安裝用戶端程式庫。

Google Chat API 概念

gRPC 服務或 REST 資源和方法可授予存取權,讓使用者存取 Chat 聊天室、聊天室成員、訊息、訊息回應、訊息附件、聊天室事件和使用者讀取狀態。

聊天室

聊天室是使用者和應用程式可進行對話及分享檔案的空間。聊天室分為好幾種類型。即時訊息 (DM) 是指兩位使用者或使用者與 Chat 應用程式之間的一對一對話。群組聊天是指三位以上使用者與 Chat 應用程式之間的對話。命名聊天室是持續存在的空間,可供使用者傳送訊息、分享檔案和協作。

資源參照:

如需使用範例,請參閱:

成員

成員是指已加入或受邀加入聊天室的使用者和 Chat 應用程式。

資源參照:

如需使用範例,請參閱:

訊息

訊息包括在聊天室中張貼的文字資訊卡。訊息可以附加檔案。使用者可以透過在訊息中加上表情符號來回應訊息。

資源參照:

如需使用範例,請參閱:

反應

回應代表使用者用來回應訊息的表情符號,例如 👍?、🚲? 和 🌞?。

資源參照:

如需使用範例,請參閱:

自訂表情符號 (開發人員預覽版)

「自訂表情符號」代表在 Google Chat 中由機構建立及分享的自訂表情符號。你可以在訊息內容中加入自訂表情符號,也可以用於回應訊息。

資源參照:

媒體和附件

媒體代表上傳至 Google Chat 的檔案,例如圖片、影片和文件。

媒體資源參照 (在 RPC 中不可用):

附件是指附加至訊息的媒體 (檔案) 例項。

資源參照:

如需使用範例,請參閱:

空間事件

聊天室事件代表聊天室或其子資源的變更,包括成員、訊息和回應。

資源參照:

如需使用範例,請參閱:

使用者已讀狀態

使用者讀取狀態是單例資源,可代表指定使用者在 Google Chat 聊天室或訊息會話串中,上次讀取訊息的詳細資料。

空間讀取狀態資源參照:

執行緒讀取狀態資源參照:

如需使用範例,請參閱:

使用者空間通知設定 (開發人員預覽版)

使用者聊天室通知設定是單一資源,代表 Google Chat 聊天室中的特定使用者通知設定。

資源參照:

除了呼叫 Chat API 之外,Chat 應用程式還可以執行下列操作: