Method: courses.students.list

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

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

בקשת HTTP

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

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

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