Method: members.list

لاسترداد قائمة مقسّمة على صفحات لجميع الأعضاء في مجموعة. تنتهي مهلة هذه الطريقة بعد 60 دقيقة. لمزيد من المعلومات، يُرجى الاطّلاع على مقالة تحديد مشاكل رموز الخطأ وحلّها.

طلب HTTP

GET https://admin.googleapis.com/admin/directory/v1/groups/{groupKey}/members

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

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

المَعلمات
groupKey

string

يحدد المجموعة في طلب البيانات من واجهة برمجة التطبيقات. يمكن أن تكون القيمة عنوان البريد الإلكتروني للمجموعة أو العنوان البديل للمجموعة أو رقم تعريف المجموعة الفريد.

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

المَعلمات
includeDerivedMembership

boolean

ما إذا كان سيتم إدراج العضويات غير المباشرة. الإعداد التلقائي: خطأ.
maxResults

integer

الحد الأقصى لعدد النتائج المطلوب عرضها. الحد الأقصى للقيمة المسموح به هو 200.
pageToken

string

رمز مميز لتحديد الصفحة التالية في القائمة
roles

string

تسمح لك معلمة طلب البحث roles باسترداد أعضاء المجموعة حسب الدور. القيم المسموح بها هي OWNER وMANAGER وMEMBER.

نص الطلب

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

نص الاستجابة

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

تمثيل JSON 
{
  "kind": string,
  "etag": string,
  "members": [
    {
      object (Member)
    }
  ],
  "nextPageToken": string
}
الحقول
kind

string

هذا هو مصدر هذا المرجع.
etag

string

علامة ETag للمورد.
members[]

object (Member)

قائمة بكائنات الأعضاء.
nextPageToken

string

الرمز المميّز المُستخدَم للوصول إلى الصفحة التالية من هذه النتيجة

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

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

  • https://apps-apis.google.com/a/feeds/groups/
  • https://www.googleapis.com/auth/admin.directory.group
  • https://www.googleapis.com/auth/admin.directory.group.member
  • https://www.googleapis.com/auth/admin.directory.group.member.readonly
  • https://www.googleapis.com/auth/admin.directory.group.readonly

لمزيد من المعلومات، راجِع دليل التفويض.