このセクションでは、Google Chat アプリから Chat API を呼び出す方法について説明します。これにより、Chat アプリは、Chat アプリのインタラクション イベントでプロンプトが表示されることなく、スペースの作成、ユーザーの追加、メッセージの投稿などを行うことができます。
エネルギー効率比率(EER)
Chat API を非同期で呼び出すには、認証が必要です。各 Chat API メソッドには、ユーザー認証(ユーザーに代わってアクションを実行する、またはデータにアクセスする)またはアプリ認証(Chat アプリとしてアクションを実行する、またはデータにアクセスする)が必要です。一部の方法は、ユーザー認証とアプリ認証の両方をサポートしています。
Chat での認証の詳細については、認証の概要をご覧ください。
API リソースとメソッド
REST リソースとメソッドは、Chat スペース、スペースのメンバー、メッセージ、メッセージのリアクション、メッセージの添付ファイルへの非同期アクセス権を付与します。
- スペース
スペースは、ユーザーとアプリが会話したり、ファイルを共有したりする場所です。スペースにはいくつかの種類があります。ダイレクト メッセージ(DM)は、2 人のユーザー間の 1 対 1 の会話、またはユーザーと Chat アプリの 1 対 1 の会話です。グループ チャットとは、3 人以上のユーザーと Chat アプリの間の会話です。名前付きスペースは、メッセージの送信、ファイルの共有、共同編集を行う永続的な場所です。
spaces
リソースはスペースを表します。スペースでは次のメソッドがサポートされています。
- スペースを作成します。スペースは、ユーザーやアプリが会話したり、ファイルを共有したりできます。
- スペースを設定してスペースを作成し、そのスペースにユーザーと Chat アプリを追加します。
- スペースを取得して、スペースの詳細を確認します。
- スペースを一覧表示して、ページ分けされたフィルタ可能なスペースのリストを表示します。
- スペースを更新すると、スペースに関する属性(ユーザーに表示される表示名、説明、ガイドラインなど)を変更できます。
- 不要になったスペースを削除する。
- 2 人のユーザー間の DM、またはユーザーと呼び出し元の Chat アプリの間の DM を返すダイレクト メッセージ(DM)を検索します。
- Members
メンバーは、スペースに参加している、またはスペースに招待されているユーザーと Chat アプリです。
spaces.members
リソースはメンバーを表します。メンバーは次の方法をサポートしています。
- ユーザーまたはアプリをスペースに追加するには、メンバーシップを作成します。
- メンバーシップの詳細を確認するには、メンバーシップを取得してください。
- メンバーシップの一覧表示。ページ分けされたフィルタ可能なメンバーのリストを表示できます。
- スペースのメンバーをスペースの管理者に変更したり、スペースの管理者からスペースのメンバーに変更したりするなど、メンバーシップを更新してメンバーシップに関する属性を変更します。
- スペースからユーザーまたはアプリを削除するには、メンバーシップを削除します。
- メッセージ
メッセージには、スペースに投稿されたテキスト通信とカード通信が含まれます。メッセージにはファイルを添付できます。 他のユーザーは絵文字を追加してメッセージにリアクションできます。
spaces.messages
リソースはメッセージを表します。メッセージは次のメソッドをサポートしています。
- テキストまたはカード メッセージを投稿するためのメッセージを作成します。メッセージ スレッドを開始したり、メッセージ スレッドに返信したりすることもできます。
- メッセージを取得して、メッセージの送信日時やメッセージの詳細などを取得します。
- メッセージを一覧表示すると、ページ分けされたフィルタ可能なメッセージのリストがスペースに表示されます。
- メッセージを更新して、メッセージ属性(内容など)を変更します。カード メッセージにテキストを追加したり、テキスト メッセージにカードを追加したりすることもできます。
- 不要になったメッセージを削除する。
- リアクション
リアクションは、👍?、🚲?、feedback など、メッセージにリアクションする際に使用する絵文字を表します。
spaces.messages.reactions
リソースはリアクションを表します。リアクションは次のメソッドをサポートしています。
- 絵文字をメッセージに追加するリアクションを作成します。
- リアクションを一覧表示すると、ページ分けされたフィルタ可能なメッセージに対するリアクションの一覧が表示されます。
- メッセージから絵文字を削除するには、リアクションを削除します。
- メディアと添付ファイル
メディアは、画像、動画、ドキュメントなど、Google Chat にアップロードされたファイルを表します。
media
リソースは、メッセージに添付されたメディアを表します。添付ファイルは、メッセージに添付されたメディア(ファイル)のインスタンスです。
spaces.messages.attachments
リソースはアタッチメントを表します。添付ファイルには、メッセージに添付されたメディアと関連するメタデータが含まれます。メディアと添付ファイルでは、次の方法がサポートされています。
- メディアを添付ファイルとしてアップロードし、メディアを Google Chat にアップロードしてからメッセージに添付します。
- メディアを添付ファイルとしてダウンロードして、Google Chat からバイナリ ファイルとしてメディアをダウンロードします。
- 添付ファイルを取得して、メッセージの添付ファイルに関するメタデータを取得します。
- スペースのイベント
スペースイベントは、スペースやその子リソース(メンバー、メッセージ、リアクションなど)に対する変更を表します。
spaces.spaceEvent
リソースは、スペースのイベントを表します。スペース イベントは、次のメソッドをサポートしています。
- スペースのイベントを取得して、スペースで発生したイベントの詳細を返します。
- スペースのイベントの一覧表示では、スペースで発生したイベントのリストを取得できます。
- ユーザーの既読状態
ユーザーの読み取り状態は、指定したユーザーが最後に読んだ Google Chat スペースまたはメッセージ スレッドの詳細を表すシングルトン リソースです。
users.spaces
リソースは、スペースにおけるユーザーの読み取り状態を表します。users.spaces.threads
リソースは、メッセージ スレッド内のユーザーの既読状態を表します。ユーザーの読み取り状態では、次のメソッドがサポートされています。
- スペースの読み取り状態を取得して、スペース内のユーザーの読み取り状態に関する詳細を返します。
- スペースの読み取り状態を更新して、スペース内のユーザーの読み取り状態を更新します。
- スレッド読み取り状態を取得して、スレッド内のユーザーの読み取り状態の詳細を返します。