استرداد جميع مجموعات نطاق أو لمستخدم بواسطة مفتاح 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
لمزيد من المعلومات، راجِع دليل التفويض.
OrderBy
عمليات التعداد | |
---|---|
EMAIL |
عنوان البريد الإلكتروني للمجموعة. |
SortOrder
عمليات التعداد | |
---|---|
ASCENDING |
ترتيب تصاعدي. |
DESCENDING |
ترتيب تنازلي. |