Method: courses.students.get

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

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

  • PERMISSION_DENIED אם למשתמש המבקש אין הרשאה להציג את התלמידים בקורס הזה, או בגלל שגיאות גישה.
  • NOT_FOUND אם לאף תלמיד בקורס הזה אין את התעודה המזהה המבוקשת או אם הקורס לא קיים.

בקשת HTTP

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

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

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

פרמטרים
courseId

string

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

string

המזהה של התלמיד/ה שרוצים להחזיר. המזהה יכול להיות אחד מהערכים הבאים:

  • המזהה המספרי של המשתמש
  • כתובת האימייל של המשתמש
  • מחרוזת הליבה "me", שמציינת את המשתמש המבקש

גוף הבקשה

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

גוף התשובה

אם הפעולה מצליחה, גוף התגובה מכיל מופע של Student.

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של 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

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