Method: members.list

אחזור רשימה ממוספרת של כל החברים בקבוצה. בשיטה הזו הזמן הקצוב לתפוגה מסתיים אחרי 60 דקות. מידע נוסף זמין במאמר פתרון בעיות בקודי שגיאה.

בקשת HTTP

GET https://admin.googleapis.com/admin/directory/v1/groups/{groupKey}/members

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

פרמטרים של נתיב

פרמטרים
groupKey

string

מזהה את הקבוצה בבקשת ה-API. הערך יכול להיות כתובת האימייל של הקבוצה, כתובת האימייל החלופית של הקבוצה או המזהה הייחודי של הקבוצה.

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

פרמטרים
includeDerivedMembership

boolean

הגדרה של מינויים עקיפים. ברירת מחדל: false.
maxResults

integer

מספר התוצאות המקסימלי שיש להחזיר. הערך המקסימלי המותר הוא 200.
pageToken

string

אסימון לציון הדף הבא ברשימה.
roles

string

פרמטר השאילתה roles מאפשר לאחזר את חברי הקבוצה לפי תפקיד. הערכים המותרים הם OWNER, MANAGER ו-MEMBER.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "kind": string,
  "etag": string,
  "members": [
    {
      object (Member)
    }
  ],
  "nextPageToken": string
}
שדות
kind

string

זה סוג המשאב.
etag

string

ה-ETag של המשאב.
members[]

object (Member)

רשימה של אובייקטים חברים.
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.member
  • https://www.googleapis.com/auth/admin.directory.group.member.readonly
  • https://www.googleapis.com/auth/admin.directory.group.readonly

מידע נוסף זמין במדריך להרשאות.