Method: spaces.members.list

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

يتطلب المصادقة. يتوافق مع مصادقة التطبيقات ومصادقة المستخدم.

طلب HTTP

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

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

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

المَعلمات
parent

string

يجب ملء الحقل. اسم المورد للمساحة المطلوب جلب قائمة عضوية لها.

التنسيق: المسافات/{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.

لفلترة البيانات حسب الدور والنوع، استخدِم عامل التشغيل AND. لفلترة البيانات حسب الدور أو النوع، استخدِم عامل التشغيل OR.

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

role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
member.type = "HUMAN" AND role = "ROLE_MANAGER"

طلبات البحث التالية غير صالحة:

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 التي لا تتطابق مع معايير الفلتر.

يتطلب حاليًا مصادقة المستخدم.

نص الطلب

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

نص الاستجابة

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

تمثيل JSON
{
  "memberships": [
    {
      object (Membership)
    }
  ],
  "nextPageToken": string
}
الحقول
memberships[]

object (Membership)

قائمة بدون ترتيب. قائمة بالعضويات في الصفحة المطلوبة (أو الأولى)

nextPageToken

string

رمز مميز يمكنك إرساله باسم pageToken لاسترداد الصفحة التالية من النتائج. إذا كان هذا الحقل فارغًا، لن تظهر أي صفحات لاحقة.

نطاقات التفويض

يتطلب استخدام أحد نطاقات OAuth التالية:

  • 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

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