Method: spaces.members.list

スペースのメンバーを一覧表示します。例については、メンバーのリストをご覧ください。アプリ認証を使用したメンバーシップを一覧表示すると、Chat アプリがアクセスできるスペースのメンバーシップが一覧表示されますが、Chat アプリのメンバーシップ(独自のメンバーを含む)は含まれません。ユーザー認証を使用してメンバーシップを一覧表示すると、認証されたユーザーがアクセスできるスペースのメンバーが一覧表示されます。

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

HTTP リクエスト

GET https://chat.googleapis.com/v1/{parent=spaces/*}/members

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

パスパラメータ

パラメータ
parent

string

必須。メンバーシップ リストを取得するスペースのリソース名。

形式: space/{space}

クエリ パラメータ

パラメータ
pageSize

integer

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

指定しない場合、最大で 100 個のメンバーシップが返されます。

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

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

pageToken

string

省略可。メンバーシップを一覧表示する前回の呼び出しで受け取ったページトークン。このパラメータを指定して、後続のページを取得します。

ページ分割の際に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致している必要があります。他のパラメータに異なる値を渡すと、予期しない結果が生じる可能性があります。

filter

string

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

メンバーシップは、メンバーのロール(role)とタイプ(member.type)でフィルタできます。

ロールでフィルタするには、roleROLE_MEMBER または ROLE_MANAGER に設定します。

タイプでフィルタするには、member.typeHUMAN または BOT に設定します。

ロールとタイプの両方でフィルタするには、AND 演算子を使用します。ロールまたはタイプでフィルタするには、OR 演算子を使用します。

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

role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
member.type = "HUMAN" AND role = "ROLE_MANAGER"

次のクエリは無効です。

member.type = "HUMAN" AND member.type = "BOT"
role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"

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

showGroups

boolean

省略可。true の場合、他のタイプのメンバーシップに加えて、Google Group に関連付けられているメンバーシップも返します。filter が設定されている場合、フィルタ条件に一致しない Google Group メンバーシップは返されません。

showInvited

boolean

省略可。true の場合、他のタイプのメンバーシップに加えて、invited メンバーに関連付けられているメンバーシップも返されます。フィルタが設定されている場合、フィルタ条件に一致しない invited メンバーシップは返されません。

現在、ユーザー認証が必要です。

リクエスト本文

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

レスポンスの本文

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

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

object (Membership)

順序なしリスト。リクエストされた(または最初の)ページのメンバーシップのリスト。

nextPageToken

string

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

承認スコープ

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

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

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