Method: spaces.members.list

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

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

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

    • https://www.googleapis.com/auth/chat.bot
    • https://www.googleapis.com/auth/chat.app.memberships（管理者の承認が必要）

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

    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.import（インポート モードのスペースのみ）
    • ユーザー認証では、管理者アカウントが認証され、useAdminAccess が true で、次のいずれかの認可スコープが使用されている場合に、管理者権限が付与されます。
      • https://www.googleapis.com/auth/chat.admin.memberships.readonly
      • https://www.googleapis.com/auth/chat.admin.memberships

HTTP リクエスト

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

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

パスパラメータ

パラメータ
parent

string

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

形式: spaces/{space}

クエリ パラメータ

パラメータ
pageSize

integer

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

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

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

負の値は 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.app.memberships
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

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