Method: spaces.members.list

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

تتطلب المصادقة. تتوافق بالكامل مع مصادقة حساب الخدمة ومصادقة المستخدم. تتطلب مصادقة المستخدم نطاق تفويض chat.memberships أو chat.memberships.readonly.

طلب HTTP

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

يستخدم عنوان URL بنية gRPC Transcode.

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

المعلّمات
parent

string

مطلوبة. اسم مورد المساحة التي تريد جلب قائمة الانتساب لها.

التنسيق: المساحات/{space}

معامِلات طلب البحث

المعلّمات
pageSize

integer

الحدّ الأقصى لعدد الانتسابات التي يمكن إرجاعها. قد تعرض الخدمة عددًا أقل من هذه القيمة.

وإذا لم يتم تحديد هذه القيمة، سيتم إرجاع 100 اشتراك كحد أقصى.

الحد الأقصى للقيمة هو 1,000. إذا كنت تستخدم قيمة تزيد عن 1,000، يتم تغييرها تلقائيًا إلى 1,000.

تعرض القيم السلبية خطأ 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.

showInvited

boolean

اختياريّ. عند تفعيل true، يتم أيضًا عرض الانتسابات المرتبطة بـ invited مشترك، بالإضافة إلى أنواع أخرى من الاشتراكات الداعمة. وفي حال ضبط فلتر، لن يتم عرض invited انتساب لا يتطابق مع معايير الفلتر.

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

نص الطلب

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

نص الاستجابة

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

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

object (Membership)

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

nextPageToken

string

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

نطاقات الأذونات

يتطلب ذلك أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

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