Method: courses.studentGroups.studentGroupMembers.list

מחזירה רשימה של תלמידים בקבוצה.

השיטה הזו מחזירה את קודי השגיאה הבאים:

  • ‫NOT_FOUND אם הקורס או קבוצת התלמידים לא קיימים.

בקשת HTTP

GET https://classroom.googleapis.com/v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

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

פרמטרים
courseId

string

חובה. המזהה של הקורס.
studentGroupId

string

חובה. המזהה של קבוצת התלמידים.

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

פרמטרים
pageSize

integer

מספר הפריטים המקסימלי שיוחזרו. אם הערך הוא אפס או לא צוין, השרת יכול להקצות ערך מקסימלי.

יכול להיות שהשרת יחזיר פחות מהמספר שצוין של תוצאות.
pageToken

string

הערך nextPageToken שמוחזר מקריאה קודמת של list, שמציין שצריך להחזיר את דף התוצאות הבא.

הבקשה list צריכה להיות זהה לבקשה שהובילה ליצירת הטוקן הזה.
previewVersion

enum (PreviewVersion)

אופציונלי. גרסת הטרום-השקה של ה-API. ההגדרה הזו נדרשת כדי לקבל גישה ליכולות חדשות של API שזמינות למפתחים בתוכנית ה-Preview.

גוף הבקשה

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

גוף התשובה

תשובה כשמבקשים רשימה של תלמידים בקבוצה.

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

ייצוג ב-JSON 
{
  "studentGroupMembers": [
    {
      object (StudentGroupMember)
    }
  ],
  "nextPageToken": string
}
שדות
studentGroupMembers[]

object (StudentGroupMember)

התלמידים שחברים בקבוצה.
nextPageToken

string

טוקן שמזהה את דף התוצאות הבא שיוחזר. אם השדה ריק, אין תוצאות נוספות.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/classroom.rosters
  • https://www.googleapis.com/auth/classroom.rosters.readonly

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