מחזירה רשימה של תלמידים בקורס הזה שהמגיש הבקשה רשאי להציג.
השיטה הזו מחזירה את קודי השגיאה הבאים:
NOT_FOUND
אם הקורס לא קיים.PERMISSION_DENIED
עבור שגיאות גישה.
בקשת HTTP
GET https://classroom.googleapis.com/v1/courses/{courseId}/students
בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
courseId |
מזהה הקורס. המזהה יכול להיות המזהה שהוקצה ל-Classroom או |
פרמטרים של שאילתה
פרמטרים | |
---|---|
pageSize |
מספר הפריטים המרבי להחזרה. אם לא צוין ערך, ברירת המחדל היא 30 או השרת עשוי להחזיר פחות ממספר התוצאות שצוין. |
pageToken |
הערך בכל מקרה אחר, הבקשה של |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התגובה
תגובה במהלך רישום התלמידים.
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:
ייצוג JSON |
---|
{
"students": [
{
object ( |
שדות | |
---|---|
students[] |
תלמידים שעונים על בקשת הרשימה. |
nextPageToken |
אסימון שמזהה את הדף הבא של התוצאות שיוחזרו. אם השדה ריק, אין תוצאות נוספות זמינות. |
היקפי הרשאות
כדי להשתמש בתכונה הזו יש צורך באחד מההיקפים הבאים של 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
למידע נוסף, ניתן לעיין במדריך ההרשאות.