このガイドでは、Google Chat API の Space リソースで
list()
メソッドを使用してスペースを一覧表示する方法について説明します。スペースを一覧表示すると、ページ分割されたフィルタ可能なスペースのリストが返されます。
リソース
は、ユーザーと Chat アプリがメッセージの送信、
ファイルの共有、共同作業を行える場所を表します。Spaceスペースにはいくつかの種類があります。
- ダイレクト メッセージ(DM)は、2 人のユーザー間またはユーザーと Chat アプリ間の会話です。
- グループ チャットは、3 人以上のユーザーと Chat アプリ間の会話です。
- 名前付きスペースは、ユーザーがメッセージの送信、ファイルの共有、共同作業を行う永続的な場所です。
アプリ認証でスペースを一覧表示すると、Chat アプリがアクセスできるスペースが一覧表示されます。ユーザー認証でスペースを一覧表示すると、認証済みユーザーがアクセスできるスペースが一覧表示されます。
前提条件
Node.js
- 環境を設定します。
- Google Cloud プロジェクトを作成します。
- OAuth 同意画面を構成します。
- Chat アプリの名前、 アイコン、説明を使用して Google Chat API を有効にして構成します。
- Node.js 用 Cloud クライアント ライブラリをインストールします。
- Google Chat API リクエストで認証を行う方法に基づいてアクセス認証情報を作成します。
リクエスト:
- Chat ユーザーとして認証するには、
OAuth クライアント ID
認証情報を作成し、認証情報を
credentials.jsonという名前の JSON ファイルとしてローカル ディレクトリに保存します。 - Chat アプリとして認証するには、
サービス アカウント
認証情報を作成し、認証情報を
credentials.jsonという名前の JSON ファイルとして保存します。
- Chat ユーザーとして認証するには、
OAuth クライアント ID
認証情報を作成し、認証情報を
- ユーザーとして認証するか、 Chat アプリ として認証するかに応じて、認可スコープを選択します。
Python
- 環境を設定します。
- Google Cloud プロジェクトを作成します。
- OAuth 同意画面を構成します。
- Chat アプリの名前、 アイコン、説明を使用して Google Chat API を有効にして構成します。
- Python 用 Cloud クライアント ライブラリをインストールします。
- Google Chat API リクエストで認証を行う方法に基づいてアクセス認証情報を作成します。
リクエスト:
- Chat ユーザーとして認証するには、
OAuth クライアント ID
認証情報を作成し、認証情報を
credentials.jsonという名前の JSON ファイルとしてローカル ディレクトリに保存します。 - Chat アプリとして認証するには、
サービス アカウント
認証情報を作成し、認証情報を
credentials.jsonという名前の JSON ファイルとして保存します。
- Chat ユーザーとして認証するには、
OAuth クライアント ID
認証情報を作成し、認証情報を
- ユーザーとして認証するか、 Chat アプリ として認証するかに応じて、認可スコープを選択します。
Java
- 環境を設定します。
- Google Cloud プロジェクトを作成します。
- OAuth 同意画面を構成します。
- Chat アプリの名前、 アイコン、説明を使用して Google Chat API を有効にして構成します。
- Java 用 Cloud クライアント ライブラリをインストールします。
- Google Chat API リクエストで認証を行う方法に基づいてアクセス認証情報を作成します。
リクエスト:
- Chat ユーザーとして認証するには、
OAuth クライアント ID
認証情報を作成し、認証情報を
credentials.jsonという名前の JSON ファイルとしてローカル ディレクトリに保存します。 - Chat アプリとして認証するには、
サービス アカウント
認証情報を作成し、認証情報を
credentials.jsonという名前の JSON ファイルとして保存します。
- Chat ユーザーとして認証するには、
OAuth クライアント ID
認証情報を作成し、認証情報を
- ユーザーとして認証するか、 Chat アプリ として認証するかに応じて、認可スコープを選択します。
Apps Script
- 環境を設定します。
- Google Cloud プロジェクトを作成します。
- OAuth 同意画面を構成します。
- Chat アプリの名前、 アイコン、説明を使用して Google Chat API を有効にして構成します。
- スタンドアロンの Apps Script プロジェクトを作成し、 高度な Chat サービスを有効にします。
- このガイドでは、ユーザー またはアプリ認証を使用する必要があります。Chat アプリとして認証するには、 サービス アカウント認証情報を作成します。手順については、 Google Chat アプリとして認証して承認するをご覧ください。
- ユーザーとして認証するか、 Chat アプリ として認証するかに応じて、認可スコープを選択します。
ユーザー認証でスペースを一覧表示する
Google Chat でスペースを一覧表示するには、リクエストで次の情報を渡します。
- ユーザー認証の場合は、
chat.spaces.readonlyまたはchat.spaces認可スコープを指定します。 -
ListSpaces()メソッドを呼び出します。
次の例では、認証済みユーザーに表示される名前付きスペース(グループ チャットとダイレクト メッセージは除外)を一覧表示します。
Node.js
Python
Java
Apps Script
Chat API は、 ページ分割されたスペースのリストを返します。
アプリ認証でスペースを一覧表示する
Google Chat でスペースを一覧表示するには、リクエストで次の情報を渡します。
- アプリ認証の場合は、
アプリ認証、
chat.bot認可スコープを指定します。 -
ListSpaces()メソッドを呼び出します。
次の例では、Chat アプリに表示される名前付きスペース(グループ チャットとダイレクト メッセージは除外)を一覧表示します。
Node.js
Python
Java
Apps Script
Chat API は、 ページ分割されたスペースのリストを返します。
ページ分割をカスタマイズする、またはリストをフィルタする
Google Chat でスペースを一覧表示するには、次の省略可能なクエリ パラメータを渡して、ページ分割をカスタマイズするか、一覧表示されたスペースをフィルタします。
pageSize: 返されるスペースの最大数。サービスが返す値はこれよりも少ないことがあります。指定されていない場合、最大で 100 個のスペースが返されます。最大値は 1,000 です。1,000 を超える値は自動的に 1,000 に変更されます。pageToken: 前回のスペース一覧表示呼び出しから受け取ったページトークン。 後続のページを取得するにはこれを指定します。ページ分割を行う場合、フィルタ値はページトークンを提供した呼び出しと一致する必要があります。別の値を渡すと、予期しない結果が生じる可能性があります。filter: クエリフィルタ。サポートされているクエリの詳細については、ListSpacesRequestリファレンスをご覧ください。