Method: members.list

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

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של 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

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