Method: groups.list

מאחזר את כל הקבוצות בדומיין או של משתמש מסוים, בהינתן userKey (עם חלוקה לדפים).

בקשת HTTP

GET https://admin.googleapis.com/admin/directory/v1/groups

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

פרמטרים של שאילתה

פרמטרים
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

חיפוש מחרוזת שאילתה. מכיל סעיף חיפוש אחד או יותר, שלכל אחד מהם יש שדה, אופרטור וערך. לעיון במסמכי העזרה המלאים, אפשר לעבור אל חיפוש קבוצות.
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

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

SortOrder

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