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

חיפוש מחרוזות שאילתה. הפורמט צריך להיות "". התיעוד המלא זמין בכתובת https: //developers.google.com/admin-sdk/directory/v1/guides/search-groups
sortOrder

enum (SortOrder)

האם להחזיר תוצאות בסדר עולה או יורד. לשימוש רק כשנעשה שימוש גם באפשרות 'סידור לפי'
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

טיפוסים בני מנייה (enum)
EMAIL כתובת האימייל של הקבוצה.

SortOrder

טיפוסים בני מנייה (enum)
ASCENDING סדר עולה.
DESCENDING סדר יורד.