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.

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

المعلمات
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 لديه امتياز إدارة المحادثات ومحادثات المساحات.

يتطلّب ذلك نطاق 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.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

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