Method: spaces.list

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

認証が必要です。アプリの認証ユーザー認証をサポートします。

呼び出し元または認証されたユーザーに表示されるスペースを一覧表示します。グループ チャットや DM は、最初のメッセージが送信されるまで表示されません。

HTTP リクエスト

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

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

クエリ パラメータ

パラメータ
pageSize

integer

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

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

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

負の値を指定すると INVALID_ARGUMENT エラーが返されます。

pageToken

string

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

ページ分けを行うとき、フィルタ値はページトークンを提供した呼び出しと一致している必要があります。異なる値を渡すと、予期しない結果が生じる可能性があります。

filter

string

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

スペースの種類(spaceType)でスペースをフィルタできます。

スペースの種類でフィルタするには、SPACEGROUP_CHAT などの有効な列挙値を指定する必要があります(spaceTypeSPACE_TYPE_UNSPECIFIED にすることはできません)。複数のスペースタイプをクエリするには、OR 演算子を使用します。

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

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

無効なクエリは INVALID_ARGUMENT エラーでサーバーによって拒否されます。

リクエスト本文

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

レスポンスの本文

成功すると、レスポンスの本文に次の構造のデータが含まれます。

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

object (Space)

リクエストされた(または最初の)ページ内のスペースのリスト。

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

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