Google Chat API の概要

このセクションでは、Google Chat アプリから Chat API を呼び出す方法について説明します。これにより、Chat アプリは、Chat アプリのインタラクション イベントでプロンプトが表示されることなく、スペースの作成、ユーザーの追加、メッセージの投稿などを行うことができます。

認証

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

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

API リソースとメソッド

REST リソースとメソッドは、Chat スペース、スペースのメンバー、メッセージ、メッセージのリアクション、メッセージの添付ファイルへの非同期アクセス権を付与します。

スペース

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

spaces リソースはスペースを表します。

スペースでは次のメソッドがサポートされています。

Members

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

spaces.members リソースはメンバーを表します。

メンバーは次の方法をサポートしています。

メッセージ

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

spaces.messages リソースはメッセージを表します。

メッセージは次のメソッドをサポートしています。

リアクション

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

spaces.messages.reactions リソースはリアクションを表します。

リアクションは次のメソッドをサポートしています。

メディアと添付ファイル

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

media リソースは、メッセージに添付されたメディアを表します。

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

spaces.messages.attachments リソースはアタッチメントを表します。添付ファイルには、メッセージに添付されたメディアと関連するメタデータが含まれます。

メディアと添付ファイルでは、次の方法がサポートされています。

スペースのイベント

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

spaces.spaceEvent リソースは、スペースのイベントを表します。

スペース イベントは、次のメソッドをサポートしています。

ユーザーの読み取り状態(デベロッパー プレビュー)

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

users.spaces リソースは、スペースにおけるユーザーの読み取り状態を表します。

users.spaces.threads リソースは、メッセージ スレッド内のユーザーの既読状態を表します。

ユーザーの読み取り状態では、次のメソッドがサポートされています。