Google Chat API の概要

このセクションでは、Google Chat アプリが Chat API を呼び出す方法について説明します。これにより、Chat アプリはスペースの作成、スペースへのユーザーの追加、メッセージの投稿などの操作を行うことができます。

認証

Chat API を呼び出すには認証が必要です。各 Chat API メソッドでは、ユーザー認証（ユーザーに代わってアクションを実行する、またはユーザーに代わってデータにアクセスする）またはアプリ認証（Chat アプリとしてアクションを実行する、または Chat アプリとしてデータにアクセスする）のいずれかが必要です。一部の方法は、ユーザー認証とアプリ認証の両方をサポートしています。

Chat での認証の詳細については、認証の概要をご覧ください。

クライアント ライブラリ

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

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

Google Chat API のコンセプト

gRPC サービスまたは REST リソースとメソッド: Chat スペース、スペースのメンバー、メッセージ、メッセージのリアクション、メッセージの添付ファイル、スペース イベント、ユーザーの閲覧ステータスへのアクセス権を付与します。

スペース

スペースは、ユーザーやアプリが会話したりファイルを共有したりできる場所です。スペースにはいくつかの種類があります。ダイレクト メッセージ（DM）は、2 人のユーザー間またはユーザーと Chat アプリ間の 1 対 1 の会話です。グループ チャットは、3 人以上のユーザーと Chat アプリ間の会話です。名前付きスペースは、ユーザーがメッセージの送信、ファイルの共有、コラボレーションを行うための永続的な場所です。

リソースのリファレンス:

使用例については、以下をご覧ください。

メンバー

メンバーは、スペースに参加しているユーザーと Chat アプリ、またはスペースに招待されているユーザーと Chat アプリです。

リソースのリファレンス:

使用例については、以下をご覧ください。

メッセージ

メッセージには、スペースに投稿されたテキストとカードのコミュニケーションが含まれます。メッセージにはファイルを添付できます。絵文字を追加してメッセージにリアクションできます。

リソースのリファレンス:

使用例については、以下をご覧ください。

リアクション

リアクションは、メッセージにリアクションするために使用する絵文字（👍?、🚲?、🌞? など）を表します。

リソースのリファレンス:

使用例については、以下をご覧ください。

カスタム絵文字（デベロッパー プレビュー）

カスタム絵文字は、Google Chat で組織内で作成して共有されたカスタム絵文字を表します。カスタム絵文字は、メッセージのコンテンツに含めたり、メッセージのリアクションに使用したりできます。

リソースのリファレンス:

メディアと添付ファイル

メディアは、Google Chat にアップロードされたファイル（画像、動画、ドキュメントなど）を表します。

メディア リソース リファレンス（RPC では使用不可）:

添付ファイルは、メッセージに添付されたメディア（ファイル）のインスタンスです。

リソースのリファレンス:

使用例については、以下をご覧ください。

宇宙イベント

スペース イベントは、スペースまたはその子リソース（メンバー、メッセージ、リアクションなど）に対する変更を表します。

リソースのリファレンス:

使用例については、以下をご覧ください。

ユーザーの読み取り状態

ユーザーの既読ステータスは、Google Chat スペースまたはメッセージ スレッドで指定したユーザーが最後に読んだメッセージの詳細を表すシングルトン リソースです。

スペースの読み取り状態のリソース リファレンス:

スレッドの読み取り状態リソースのリファレンス:

使用例については、以下をご覧ください。

ユーザー空間の通知設定（デベロッパー プレビュー）

ユーザー スペースの通知設定は、Google Chat スペースで指定されたユーザー通知設定を表すシングルトン リソースです。

リソースのリファレンス:

Chat アプリは、Chat API を呼び出すだけでなく、次のこともできます。