このセクションのガイドでは、Google Chat アプリが Chat API を呼び出す方法について説明します。これにより、Chat アプリは、Chat アプリのインタラクション イベントによってプロンプトが表示されることなく、スペースの作成、ユーザーの追加、メッセージの投稿などを行えるようになります。
認証
Chat API を非同期で呼び出すには、認証が必要です。各 Chat API メソッドには、ユーザー認証(ユーザーに代わってアクションを実行またはデータにアクセスする)またはアプリ認証(Chat アプリとしてアクションを実行またはデータにアクセスする)が必要です。一部の方法は、ユーザー認証とアプリ認証の両方をサポートしています。
Chat での認証の詳細については、認証の概要をご覧ください。
API リソースとメソッド
REST リソースとメソッドは、Chat スペース、スペースのメンバー、メッセージ、メッセージのリアクション、メッセージの添付ファイルへの非同期アクセス権を付与します。
- スペース
スペースとは、ユーザーとアプリが会話したり、ファイルを共有したりできる場所です。スペースにはいくつかの種類があります。ダイレクト メッセージ(DM)とは、2 人のユーザーとの 1 対 1 の会話、またはユーザーと Chat アプリの 1 対 1 の会話のことです。グループ チャットとは、3 人以上のユーザーとチャットアプリ間の会話です。名前付きスペースは、メッセージの送信、ファイルの共有、共同編集を行う場所です。
Space
リソースはスペースを表します。スペースでは、次の方法がサポートされています。
- スペースを作成します。スペースは、ユーザーとアプリが会話したり、ファイルを共有したりできます。
- スペースを設定してスペースを作成し、そのスペースにユーザーと Chat アプリを追加します。
- スペースの詳細を表示するには、スペースを取得します。
- スペースを一覧表示すると、ページ分けされ、フィルタ可能なスペースのリストが表示されます。
- スペースを更新して、スペースに関する属性(ユーザーに表示される表示名、説明、ガイドラインなど)を変更します。
- 不要になったスペースを削除する。
- ダイレクト メッセージ(DM)を検索して、2 つのユーザー間の DM、またはユーザーと呼び出し元の Chat アプリ間の DM を返します。
- メンバー
メンバーは、スペースに参加している、またはスペースに招待されたユーザーと Chat アプリです。
Member
リソースはメンバーを表します。メンバーは次の方法をサポートしています。
- ユーザーまたはアプリをスペースに追加するには、メンバーシップを作成します。
- メンバーシップの詳細を確認するには、メンバーシップを取得してください。
- メンバーシップのリスト。ページ分けされたフィルタ可能なスペース内のメンバーシップ リストを表示できます。
- メンバーシップを削除して、スペースからユーザーまたはアプリを削除します。
- メッセージ
メッセージには、スペースに投稿されるテキスト通信とカード通信が含まれます。メッセージにファイルを添付できます。 ユーザーはメッセージに絵文字を追加してリアクションできます。
Message
リソースはメッセージを表します。メッセージは、次の方法をサポートしています。
- テキストまたはカードのメッセージを投稿するメッセージを作成します。また、メッセージ スレッドを開始したり、メッセージに返信したりすることもできます。
- メッセージを取得して、メッセージに関する詳細情報(送信日時やメッセージの内容など)を取得します。
- メッセージをリスト表示すると、スペース内のメッセージのリストがページ分けされ、フィルタ可能です。
- メッセージ属性(内容など)を変更するには、メッセージを更新します。また、カード メッセージにテキストを追加したり、テキスト メッセージにカードを追加したりすることもできます。
- 不要になったメッセージを削除する。
- リアクション
リアクションは、メッセージにリアクションする際に使用する絵文字を表します(👍?、🚲?、背景など)。
Reaction
リソースはリアクションを表します。リアクションでは、次の方法がサポートされています。
- メッセージに絵文字を追加するには、リアクションを作成します。
- リアクションを一覧表示する。ページ分けされ、フィルタ可能なメッセージに対するリアクション リストが表示されます。
- メッセージから絵文字を削除するには、リアクションを削除します。
- メディアと添付ファイル
メディアは、画像、動画、ドキュメントなど、Google Chat にアップロードされたファイルを表します。
Media
リソースは、メッセージに添付されたメディアを表します。添付ファイルは、メッセージに添付されたメディア(ファイル)のインスタンスです。
Attachment
リソースはアタッチメントを表します。添付ファイルには、メッセージに添付されたメディアと関連するメタデータが含まれます。メディアと添付ファイルでは、次の方法がサポートされています。
- メディアを添付ファイルとしてアップロードし、Google Chat にメディアをアップロードしてメッセージに添付します。
- Google Chat からメディアをバイナリ ファイルとしてダウンロードするには、添付ファイルとしてメディアをダウンロードします。
- 添付ファイルを取得して、メッセージの添付ファイルに関するメタデータを取得する。
ディスカバリ ドキュメントを見つける
この API のディスカバリ ドキュメントは、次の URL にあります。