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

عنوان البريد الإلكتروني أو رقم التعريف غير القابل للتغيير للمستخدم، إذا تم إدراج هذه المجموعات فقط، يكون المستخدم المعني عضوًا فيها. وإذا كان رقم تعريف، يجب أن يتطابق مع رقم تعريف كائن المستخدم.

نص الطلب

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

نص الاستجابة

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

تمثيل 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 ترتيب تنازلي.