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