Method: spaces.members.list

يسرد العضوية في مساحة. على سبيل المثال، راجِع إنشاء قائمة بالمستخدمين وتطبيقات Google 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 وفي "المساحات".

يتطلب نطاق OAuth 2.0 chat.admin.memberships.readonly أو chat.admin.memberships.

لا يمكن إدراج عضويات التطبيقات في مساحة عند استخدام إذن وصول المشرف.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

الرد لإدراج أعضاء المساحة في المساحة

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل 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

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