Google Chat API の概要

このページでは、Google Chat API の使用方法とそのリファレンス ドキュメントの概要について説明します。

Google Chat API には、gRPC インターフェースと REST インターフェースの両方があり、両方をサポートするクライアント ライブラリがあります。提供されているクライアント ライブラリがニーズを満たさない場合は、gRPC または REST インターフェースを使用する独自のクライアント ライブラリを作成することもできます。

クライアント ライブラリ

ほとんどのデベロッパーが Google Chat API を呼び出すには、Python、Java、Node.js などの任意の言語で公式にサポートされている Cloud クライアント ライブラリを使用することをおすすめします。

Google Apps Script でコーディングする場合は、クライアント ライブラリをインストールする代わりに、Advanced Chat サービスを使用します。

型、メソッド、フィールド名

クライアント ライブラリ、gRPC、REST のいずれを使用するかによって、Google Chat API のタイプ、メソッド、フィールド名は多少異なります。

  • Cloud クライアント ライブラリは、gRPC サービスとそのメソッド別に配置されます。Google API クライアント ライブラリは、REST リソースに対応するオブジェクトまたはクラスを含むサービスとして編成されています。これらのクラスには、対応するメソッドも含まれています。
  • gRPC は、サービスとそのメソッド別に配置されます。
  • REST は、リソース階層とそのメソッド別に配置されます。
  • gRPC フィールド名はスネークケースを使用します。
  • REST フィールド名ではキャメルケースが使用されますが、API サービスではキャメルケースまたはスネークケースのいずれかが認められます。
  • クライアント ライブラリのフィールド名は、その言語でどの名前が慣用的であるかに応じて、タイトルケース、キャメルケース、スネークケースのいずれかを使用します。

プロトコル バッファ

クライアント ライブラリ、REST、gRPC のいずれを使用する場合でも、基盤となるサービスはプロトコル バッファを使用して定義されます。具体的には、このサービスは proto3 を使用します。

API を呼び出すときに、リクエストまたはレスポンスのフィールドによっては、プロトコル バッファの well-known 型の基本的な理解が必要になる場合があります。

また、REST API を呼び出すときに、プロトコル バッファのデフォルト値の動作により、JSON レスポンスにフィールドが欠落する可能性があります。これらのフィールドはデフォルト値に設定されているため、レスポンスには含まれません。

API バージョン

次の API バージョンを使用できます。

  • v1: 安定版。

デベロッパー プレビュー

ドキュメントには、デベロッパー プレビュー プログラムでのみ使用できる API メソッドやフィールドが記載されている場合があります。最新のプレビュー機能をテスト、プレビューしてフィードバックを提供するには、デベロッパー プレビュー プログラムに参加してください。