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)

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

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

SortOrder

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