Method: spaces.list

呼び出し元がメンバーになっているスペースを一覧表示します。グループ チャットと DM は、最初のメッセージが送信されるまで一覧に表示されません。例については、スペースを一覧表示するをご覧ください。

次のタイプの認証をサポートしています。

  • 認可スコープを使用したアプリ認証:

    • https://www.googleapis.com/auth/chat.bot

  • 次のいずれかの認可スコープを使用したユーザー認証:

    • https://www.googleapis.com/auth/chat.spaces.readonly
    • https://www.googleapis.com/auth/chat.spaces

Google Workspace 組織のすべての名前付きスペースを一覧表示するには、代わりに Workspace 管理者権限を使用して spaces.search() メソッドを使用します。

HTTP リクエスト

GET https://chat.googleapis.com/v1/spaces

この URL は gRPC Transcoding 構文を使用します。

クエリ パラメータ

パラメータ
pageSize

integer

省略可。返されるスペースの最大数。サービスが返す値はこれよりも少ないことがあります。

指定されていない場合は、最大で 100 個のスペースが返されます。

最大値は 1,000 です。1,000 を超える値を使用すると、自動的に 1,000 に変更されます。

負の値は INVALID_ARGUMENT エラーを返します。
pageToken

string

省略可。前回の list spaces 呼び出しから受け取ったページトークン。後続のページを取得するには、このパラメータを指定します。

ページネーションを行う場合、フィルタ値はページトークンを受け取った呼び出しと一致している必要があります。別の値を渡すと、予期しない結果になる可能性があります。
filter

string

省略可。クエリフィルタ。

スペースはスペースの種類（spaceType）でフィルタできます。

スペースタイプでフィルタするには、SPACE や GROUP_CHAT などの有効な列挙型の値を指定する必要があります（spaceType は SPACE_TYPE_UNSPECIFIED にすることはできません）。複数のスペースタイプをクエリするには、OR 演算子を使用します。

たとえば、次のクエリは有効です。

spaceType = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

無効なクエリは、INVALID_ARGUMENT エラーでサーバーが拒否します。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

リスト スペース リクエストのレスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "spaces": [
    {
      object (Space)
    }
  ],
  "nextPageToken": string
}
フィールド
spaces[]

object (Space)

リクエストされた（または最初の）ページのスペースのリスト。注: リスト リクエストの Space オブジェクトには permissionSettings フィールドが返されません。
nextPageToken

string

トークンを pageToken として送信して、結果の次のページを取得できます。空の場合、後続のページはありません。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

詳しくは、認可ガイドをご覧ください。