لاسترداد جميع مجموعات النطاق أو لمستخدم معين لـ userKey (مقسّم على صفحات).
طلب HTTP
GET https://admin.googleapis.com/admin/directory/v1/groups
يستخدِم عنوان URL بنية تحويل ترميز gRPC.
معامِلات طلب البحث
المعلمات | |
---|---|
customer |
المعرّف الفريد لحساب العميل على Google Workspace. في حال وجود حساب متعدد النطاقات، استخدِم هذا الحقل بدلاً من |
domain |
اسم النطاق. استخدِم هذا الحقل للحصول على مجموعات من نطاق واحد فقط. لعرض جميع النطاقات لحساب عميل، استخدِم مَعلمة طلب البحث |
maxResults |
الحد الأقصى لعدد النتائج المطلوب عرضها. الحدّ الأقصى المسموح به للقيمة هو 200. |
orderBy |
عمود لاستخدامه في ترتيب النتائج |
pageToken |
رمز مميّز لتحديد الصفحة التالية في القائمة |
query |
البحث في سلسلة طلب البحث. يجب أن يكون بالشكل " |
sortOrder |
ما إذا كان سيتم عرض النتائج بترتيب تصاعدي أم تنازلي. تُستخدم فقط عند استخدام orderBy أيضًا |
userKey |
عنوان البريد الإلكتروني أو معرّف غير قابل للتغيير للمستخدم في حال إدراج هذه المجموعات فقط، وكان المستخدم المحدّد عضوًا فيها. أمّا إذا كان معرّفًا، فيجب أن يتطابق مع رقم تعريف عنصر المستخدِم. |
نص الطلب
يجب أن يكون نص الطلب فارغًا.
نص الاستجابة
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
تمثيل JSON |
---|
{
"kind": string,
"etag": string,
"groups": [
{
object ( |
الحقول | |
---|---|
kind |
هذا نوع من الموارد. |
etag |
علامة ETag للمورد. |
groups[] |
قائمة بكائنات المجموعة. |
nextPageToken |
يتم استخدام الرمز المميّز للوصول إلى الصفحة التالية من هذه النتيجة. |
نطاقات الأذونات
يتطلب هذا الإعداد أحد نطاقات 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
لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.
ترتيب
عمليات التعداد | |
---|---|
EMAIL |
عنوان البريد الإلكتروني للمجموعة |
SortOrder
عمليات التعداد | |
---|---|
ASCENDING |
ترتيب تصاعدي |
DESCENDING |
ترتيب تنازلي. |