Method: spaces.members.list

عضویت ها را در یک فضا فهرست می کند. برای مثال، فهرست کاربران و برنامه‌های چت Google را در یک فضا ببینید. فهرست کردن عضویت‌ها با احراز هویت برنامه ، عضویت‌ها را در فضاهایی فهرست می‌کند که برنامه Chat به آنها دسترسی دارد، اما عضویت‌های برنامه Chat، از جمله عضویت خود را استثنا نمی‌کند. فهرست کردن عضویت‌ها با احراز هویت کاربر ، عضویت‌ها را در فضاهایی فهرست می‌کند که کاربر احراز هویت شده به آنها دسترسی دارد.

نیاز به احراز هویت از احراز هویت برنامه و احراز هویت کاربر پشتیبانی می کند.

درخواست 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 استفاده کنید.

یا member.type = "HUMAN" یا member.type != "BOT" زمانی که useAdminAccess روی true تنظیم شده است، مورد نیاز است. سایر فیلترهای نوع عضو رد خواهند شد.

به عنوان مثال، پرس و جوهای زیر معتبر هستند:

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 کاربر اجرا می‌شود.

کاربر تماس گیرنده باید یک سرپرست 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

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.