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

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