Method: groups.list

يستردّ هذا الإجراء جميع مجموعات نطاق أو مستخدم معيّن باستخدام userKey (يتم تقسيم النتائج إلى صفحات).

طلب HTTP

GET https://admin.googleapis.com/admin/directory/v1/groups

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

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

المعلمات
customer

string

المعرّف الفريد لحساب العميل على Google Workspace في حال استخدام حساب بنطاقات متعددة، لاسترداد جميع المجموعات لأحد العملاء، استخدِم هذا الحقل بدلاً من domain. يمكنك أيضًا استخدام الاسم المستعار my_customer لتمثيل customerId حسابك. يتم أيضًا عرض customerId كجزء من مرجع المستخدمين. يجب تقديم المَعلمة customer أو المَعلمة domain.
domain

string

اسم النطاق استخدِم هذا الحقل للحصول على مجموعات من نطاق واحد فقط. لعرض جميع النطاقات الخاصة بحساب أحد العملاء، استخدِم مَعلمة طلب البحث customer بدلاً من ذلك.
maxResults

integer

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

enum (OrderBy)

العمود المطلوب استخدامه لترتيب النتائج
pageToken

string

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

string

البحث عن سلسلة طلب البحث يحتوي على عبارة بحث واحدة أو أكثر، كل منها يتضمّن حقلًا وعامل تشغيل وقيمة. للاطّلاع على المستندات الكاملة، انتقِل إلى البحث عن مجموعات.
sortOrder

enum (SortOrder)

لاختيار عرض النتائج إما بترتيب تصاعدي أو تنازلي. لا تكون مفيدة إلا عند استخدامها مع orderBy
userKey

string

البريد الإلكتروني أو رقم التعريف غير القابل للتغيير الخاص بالمستخدم إذا كان سيتم إدراج هذه المجموعات فقط، وكان المستخدم المحدّد عضوًا فيها إذا كان معرّفًا، يجب أن يتطابق مع معرّف عنصر المستخدم. لا يمكن استخدامها مع المَعلمة customer.

نص الطلب

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

نص الاستجابة

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

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

string

نوع المرجع.
etag

string

تمثّل هذه السمة علامة ETag الخاصة بالمرجع.
groups[]

object (Group)

قائمة بعناصر المجموعة
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.readonly

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

OrderBy

عمليات التعداد
EMAIL البريد الإلكتروني للمجموعة

SortOrder

عمليات التعداد
ASCENDING ترتيب تصاعدي
DESCENDING ترتيب تنازلي