このガイドでは、Google Chat API の Space
リソースの list()
メソッドを使用してスペースを一覧表示する方法について説明します。スペースを一覧表示すると、ページ分けされたフィルタ可能なスペースのリストが返されます。
Space
リソースは、ユーザーと Chat アプリがメッセージの送信、ファイルの共有、コラボレーションを行う場所を表します。スペースには次の 2 種類があります。
- ダイレクト メッセージ(DM)は、2 人のユーザー間、またはユーザーと Chat アプリ間の会話です。
- グループ チャットは、3 人以上のユーザーと Chat アプリとの間の会話です。
- 名前付きスペースは、ユーザーがメッセージの送信、ファイルの共有、コラボレーションを行うための永続的な場所です。
アプリの認証を使用してスペースを一覧表示すると、Chat アプリがアクセスできるスペースが一覧表示されます。ユーザー認証でスペースを一覧表示すると、認証されたユーザーがアクセスできるスペースが一覧表示されます。
前提条件
Node.js
- Google Chat へのアクセス権を持つビジネスまたはエンタープライズ Google Workspace アカウント。
- 環境を設定します。
- Google Cloud プロジェクトを作成します。
- OAuth 同意画面を構成する
- Chat アプリの名前、アイコン、説明を使用して、Google Chat API を有効にして構成します。
- Node.js の Cloud クライアント ライブラリをインストールします。
- Google Chat API リクエストで認証する方法に基づいて、アクセス認証情報を作成します。
- Chat ユーザーとして認証するには、OAuth クライアント ID 認証情報を作成し、認証情報を
client_secrets.json
という名前の JSON ファイルとしてローカル ディレクトリに保存します。 - Chat 用アプリとして認証するには、サービス アカウントの認証情報を作成し、その認証情報を
credentials.json
という名前の JSON ファイルとして保存します。
- Chat ユーザーとして認証するには、OAuth クライアント ID 認証情報を作成し、認証情報を
- ユーザーとして認証するか、Chat アプリとして認証するかに応じて、 認可スコープを選択します。
Python
- Google Chat へのアクセス権を持つビジネスまたはエンタープライズ Google Workspace アカウント。
- 環境を設定します。
- Google Cloud プロジェクトを作成します。
- OAuth 同意画面を構成する
- Google Chat API を有効にして構成し、Chat アプリの名前、アイコン、説明を指定します。
- Python Cloud クライアント ライブラリをインストールします。
- Google Chat API リクエストで認証する方法に基づいて、アクセス認証情報を作成します。
- Chat ユーザーとして認証するには、OAuth クライアント ID 認証情報を作成し、認証情報を
client_secrets.json
という名前の JSON ファイルとしてローカル ディレクトリに保存します。 - Chat 用アプリとして認証するには、サービス アカウントの認証情報を作成し、その認証情報を
credentials.json
という名前の JSON ファイルとして保存します。
- Chat ユーザーとして認証するには、OAuth クライアント ID 認証情報を作成し、認証情報を
- ユーザーとして認証するか、Chat アプリとして認証するかに応じて、 認可スコープを選択します。
Java
- Google Chat へのアクセス権を持つビジネスまたはエンタープライズ Google Workspace アカウント。
- 環境を設定します。
- Google Cloud プロジェクトを作成します。
- OAuth 同意画面を構成する
- Google Chat API を有効にして構成し、Chat アプリの名前、アイコン、説明を指定します。
- Java Cloud クライアント ライブラリをインストールします。
- Google Chat API リクエストで認証する方法に基づいて、アクセス認証情報を作成します。
- Chat ユーザーとして認証するには、OAuth クライアント ID 認証情報を作成し、認証情報を
client_secrets.json
という名前の JSON ファイルとしてローカル ディレクトリに保存します。 - Chat アプリとして認証するには、サービス アカウントの認証情報を作成し、認証情報を
credentials.json
という名前の JSON ファイルとして保存します。
- Chat ユーザーとして認証するには、OAuth クライアント ID 認証情報を作成し、認証情報を
- ユーザーとして認証するか、Chat アプリとして認証するかに応じて、 認可スコープを選択します。
Apps Script
- Google Chat へのアクセス権を持つビジネスまたはエンタープライズ Google Workspace アカウント。
- 環境を設定します。
- Google Cloud プロジェクトを作成します。
- OAuth 同意画面を構成する
- Google Chat API を有効にして構成し、Chat アプリの名前、アイコン、説明を指定します。
- スタンドアロンの Apps Script プロジェクトを作成し、Advanced Chat Service をオンにします。
- このガイドでは、ユーザー認証またはアプリ認証のいずれかを使用する必要があります。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
: 前回の list spaces 呼び出しから受け取ったページトークン。後続のページを取得するには、このトークンを指定します。ページネーションを行う場合、フィルタ値はページトークンを提供した呼び出しと一致している必要があります。別の値を渡すと、予期しない結果になる可能性があります。filter
: クエリフィルタ。サポートされているクエリの詳細については、ListSpacesRequest
リファレンスをご覧ください。