Google Chat API 總覽

本頁面概略說明如何使用 Google Chat API 和參考文件。

Google Chat API 具有 gRPC 和 REST 介面，以及同時支援這兩種介面的用戶端程式庫。如果提供的用戶端程式庫無法滿足需求，您也可以自行編寫使用 gRPC 或 REST 介面的用戶端程式庫。

用戶端程式庫

對大多數開發人員而言，呼叫 Google Chat API 的建議方式是使用我們正式支援的Cloud 用戶端程式庫，並選擇您偏好的語言，例如 Python、Java 或 Node.js。

如果您使用 Google Apps Script 進行編碼，請改用進階 Chat 服務，不必安裝用戶端程式庫。

類型、方法和欄位名稱

視您使用用戶端程式庫、gRPC 或 REST 而定，Google Chat API 的型別、方法和欄位名稱會略有不同：

  • Cloud 用戶端程式庫是依據 gRPC 服務及其方法排列。Google API 用戶端程式庫會以服務的形式排列，其中包含與 REST 資源對應的物件或類別，以及對應的方法。
  • gRPC 是依服務及其方法排列。
  • REST API 會依資源階層及其方法排列。
  • gRPC 欄位名稱使用蛇形命名法。
  • REST 欄位名稱使用駝峰式大小寫，但 API 服務會接受駝峰式大小寫或蛇形命名法。
  • 視語言的慣例而定，用戶端程式庫欄位名稱會使用首字大寫、駝峰式大小寫或蛇形命名法。

通訊協定緩衝區

無論您使用用戶端程式庫、REST 或 gRPC，基礎服務都是使用通訊協定緩衝區定義。具體來說，這項服務使用 proto3。

呼叫 API 時，部分要求或回應欄位可能需要具備通訊協定緩衝區的知名型別基本知識。

此外，呼叫 REST API 時，通訊協定緩衝區的預設值行為可能會導致 JSON 回應缺少欄位。這些欄位已設為預設值，因此不會納入回應。

API 版本

可用的 API 版本如下：

  • v1：穩定版。

開發人員預覽版

在說明文件中，您可能會看到只能透過開發人員搶先體驗計畫使用的方法或欄位。如要測試及預先發布最新功能，並提供意見回饋，請加入開發人員預先發布計畫。