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

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