Method: members.list

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

طلب HTTP

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

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

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

المعلمات
groupKey

string

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

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

المعلمات
includeDerivedMembership

boolean

ما إذا كان سيتم إدراج العضويات غير المباشرة. الإعداد التلقائي: false.
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

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