Method: spaces.members.list

スペースのメンバーを一覧表示します。例については、スペース内のユーザーと Google Chat アプリを一覧表示するをご覧ください。アプリの認証を使用してメンバーを一覧表示する場合、Chat アプリがアクセスできるスペースのメンバーシップが一覧表示されますが、Chat アプリのメンバーシップは除きます。[ユーザー認証] を使用して、メンバーを一覧表示する場合、認証されたユーザーがアクセスできるスペースのメンバーシップを一覧表示します。

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
parent

string

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

形式: spaces/{space}

クエリ パラメータ

パラメータ
pageSize

integer

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

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

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

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

string

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

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

string

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

メンバーシップは、メンバーのロール（role）と種類（member.type）でフィルタできます。

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

タイプでフィルタするには、member.type を HUMAN または BOT に設定します。デベロッパー プレビュー: != 演算子を使用して member.type をフィルタすることもできます。

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

useAdminAccess が true に設定されている場合は、member.type = "HUMAN" または member.type != "BOT" のいずれかが必要です。他のメンバータイプのフィルタは拒否されます。

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

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

member.type != "BOT"

次のクエリは無効です。

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 のメンバーシップは返されません。

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

boolean

true の場合、メソッドはユーザーの Google Workspace 管理者権限を使用して実行されます。

発信ユーザーは、「Chat とスペースの会話の管理」権限を持つ Google Workspace 管理者である必要があります。

chat.admin.memberships.readonly または chat.admin.memberships の OAuth 2.0 スコープが必要です。

管理者権限を使用している場合、スペース内のアプリ メンバーシップを一覧表示することはできません。

リクエスト本文

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

レスポンスの本文

スペースのリスト メンバーシップに対するレスポンス。

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

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

object (Membership)

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

string

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

認可スコープ

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

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • 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

詳細については、承認ガイドをご覧ください。