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

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