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