Method: courses.list

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

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

  • PERMISSION_DENIED למידע על שגיאות גישה.
  • ‫INVALID_ARGUMENT אם הארגומנט של השאילתה לא תקין.
  • NOT_FOUND אם משתמשים שצוינו בארגומנטים של השאילתה לא קיימים.

בקשת HTTP

GET https://classroom.googleapis.com/v1/courses

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

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

פרמטרים
studentId

string

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

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

אם מציינים את המאפיין teacherId, הוא חייב להיות ריק.
teacherId

string

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

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

אם מציינים את המאפיין studentId, הוא חייב להיות ריק.
courseStates[]

enum (CourseState)

מגבילה את הקורסים שמוחזרים לאלה שנמצאים באחד מהמצבים שצוינו. אם לא מציינים מצב, המערכת מחזירה קורסים בכל מצב.
pageSize

integer

מספר הפריטים המקסימלי שיוחזרו. אם הערך הוא אפס או לא צוין, השרת יכול להקצות ערך מקסימלי.

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

string

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

בקשת list צריכה להיות זהה לבקשה שהובילה ליצירת הטוקן הזה.
previewVersion

enum (PreviewVersion)

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

גוף הבקשה

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

גוף התשובה

תגובה כשמציגים רשימה של קורסים.

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

ייצוג ב-JSON 
{
  "courses": [
    {
      object (Course)
    }
  ],
  "nextPageToken": string
}
שדות
courses[]

object (Course)

קורסים שתואמים לבקשה לרשימה.
nextPageToken

string

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

היקפי הרשאות

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

  • https://www.googleapis.com/auth/classroom.courses
  • https://www.googleapis.com/auth/classroom.courses.readonly

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