Method: groups.list

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

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של 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/workspace/admin/directory/v1/guides/search-groups
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 בסדר יורד.