Method: courses.list

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

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

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

בקשת HTTP

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

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

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