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 أيضًا كجزء من مورد Users (المستخدمون). يجب تقديم المَعلمة customer أو domain.
domain

string

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

integer

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

enum (OrderBy)

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

string

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

string

البحث في سلسلة طلب البحث يجب أن يكون بالشكل "". يمكن الاطّلاع على المستندات الكاملة على الرابط https: //developers.google.com/admin-sdk/directory/v1/guides/search-groups.
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 ترتيب تنازلي