Google Chat API の概要

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

認証

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

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

API リソースとメソッド

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

スペース

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

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

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

Members

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

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

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

  • スペースにユーザーまたはアプリを追加するには、メンバーシップを作成します。
  • メンバーシップの詳細を確認するには、メンバーシップを取得してください。
  • メンバーの一覧表示で、スペース内のメンバーシップのリスト(ページ分け、フィルタ可能)を確認できます。
  • メンバーシップを更新して、メンバーシップに関する属性を変更します。たとえば、スペースのメンバーからスペースの管理者への変更、スペースの管理者からスペースのメンバーへの変更などを行います。
  • スペースからユーザーまたはアプリを削除するには、メンバーシップを削除します。
メッセージ

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

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

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

リアクション

リアクションは、ユーザーがメッセージにリアクションするために使用する絵文字を表します(例: fitbit、🚲?、🔥?)。

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

リアクションでは、次のメソッドがサポートされています。

メディアと添付ファイル

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

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

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

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

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

スペース イベント

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

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

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

ユーザーの読み取り状態

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

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

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

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