スペースのメンバーを一覧表示します。例については、スペース内のユーザーと Google Chat アプリを一覧表示するをご覧ください。アプリ認証を使用したメンバーシップを一覧表示すると、Chat アプリがアクセスできるスペースのメンバーシップが一覧表示されますが、Chat アプリのメンバーシップ(独自のメンバーを含む)は含まれません。ユーザー認証を使用してメンバーシップを一覧表示すると、認証されたユーザーがアクセスできるスペースのメンバーが一覧表示されます。
HTTP リクエスト
GET https://chat.googleapis.com/v1/{parent=spaces/*}/members
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
parent |
必須。メンバーシップ リストを取得するスペースのリソース名。 形式: space/{space} |
クエリ パラメータ
パラメータ | |
---|---|
pageSize |
省略可。返されるメンバーシップの最大数。サービスはこの値よりも少ない数を返す場合があります。 指定しない場合、最大で 100 個のメンバーシップが返されます。 最大値は 1,000 です。1,000 を超える値を使用すると、自動的に 1,000 に変更されます。 負の値を指定すると |
pageToken |
省略可。メンバーシップを一覧表示する前回の呼び出しで受け取ったページトークン。このパラメータを指定して、後続のページを取得します。 ページ分割の際に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致している必要があります。他のパラメータに異なる値を渡すと、予期しない結果が生じる可能性があります。 |
filter |
省略可。クエリフィルタ。 メンバーシップは、メンバーのロール( ロールでフィルタするには、 タイプでフィルタするには、 ロールとタイプの両方でフィルタするには、
たとえば、次のクエリは有効です。
次のクエリは無効です。
無効なクエリは |
showGroups |
省略可。 |
showInvited |
省略可。 現在、ユーザー認証が必要です。 |
useAdminAccess |
true の場合、このメソッドはユーザーの Google Workspace 管理者権限を使用して実行されます。通話ユーザーは、「Chat とスペースの会話の管理」権限を持つ Google Workspace 管理者である必要があります。
管理者権限を使用する場合、スペース内のアプリ メンバーシップを一覧表示することはできません。 |
リクエスト本文
リクエストの本文は空にする必要があります。
レスポンスの本文
スペースのメンバーを一覧表示するレスポンス。
成功した場合、レスポンスの本文には次の構造のデータが含まれます。
JSON 表現 |
---|
{
"memberships": [
{
object ( |
フィールド | |
---|---|
memberships[] |
順序なしリスト。リクエストされた(または最初の)ページのメンバーシップのリスト。 |
nextPageToken |
結果の次のページを取得するために |
認可スコープ
次の 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
詳しくは、承認ガイドをご覧ください。