Method: spaces.members.list

تعرض هذه السمة العضويات في مساحة. على سبيل المثال، اطّلِع على إدراج المستخدمين وتطبيقات Google Chat في مساحة. يؤدي إدراج الاشتراكات باستخدام مصادقة التطبيق إلى إدراج الاشتراكات في المساحات التي يمكن لتطبيق Chat الوصول إليها، ولكنّه يستثني الاشتراكات في تطبيق Chat، بما في ذلك اشتراكاته الخاصة. يؤدي إدراج العضويات باستخدام مصادقة المستخدم إلى إدراج العضويات في المساحات التي يمكن للمستخدم المُعتمَد الوصول إليها.

تتوافق مع أنواع المصادقة التالية:

طلب HTTP

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

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

مَعلمات المسار

المعلمات
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 على "صحيح". سيتم رفض فلاتر أنواع الأعضاء الأخرى.

على سبيل المثال، تكون طلبات البحث التالية صالحة:

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 وفي "المساحات".

تتطلّب إما 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

لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.