Method: courses.list

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

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

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

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

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

פרמטרים
studentId

string

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

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

string

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

  • המזהה המספרי של המשתמש
  • כתובת האימייל של המשתמש
  • ליטרל המחרוזת "me", שמציין את המשתמש ששלח את הבקשה
courseStates[]

enum (CourseState)

מגביל קורסים שהוחזרו לקורסים באחד מהמצבים שצוינו. ערך ברירת המחדל הוא ACTIVE, ARCHIVED, PROVISIONED, DECLINED.
pageSize

integer

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

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

string

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

הבקשה של list חייבת להיות זהה בכל מקרה אחר לבקשה שהובילה לאסימון הזה.

גוף הבקשה

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

גוף התשובה

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

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

ייצוג 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

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