Method: courses.students.list

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

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

בקשת HTTP

GET https://classroom.googleapis.com/v1/courses/{courseId}/students

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

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

פרמטרים
courseId

string

מזהה הקורס. המזהה יכול להיות המזהה שהוקצה ל-Classroom או alias.

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

פרמטרים
pageSize

integer

מספר הפריטים המרבי להחזרה. אם לא צוין ערך, ברירת המחדל היא 30 או 0.

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

string

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

בכל מקרה אחר, הבקשה של list צריכה להיות זהה לבקשה שהובילה לאסימון הזה.

גוף הבקשה

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

גוף התגובה

תגובה במהלך רישום התלמידים.

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

ייצוג JSON 
{
  "students": [
    {
      object (Student)
    }
  ],
  "nextPageToken": string
}
שדות
students[]

object (Student)

תלמידים שעונים על בקשת הרשימה.
nextPageToken

string

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

היקפי הרשאות

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

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

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