Method: courses.courseWorkMaterials.list

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

תלמידי הקורס יכולים לראות רק חומר לימוד אחד (PUBLISHED) בקורס. מורים בקורס ומנהלי דומיינים יכולים לראות את כל חומרי העבודה בקורס.

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

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

בקשת HTTP

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

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

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

פרמטרים
courseId

string

מזהה הקורס. המזהה הזה יכול להיות המזהה שהוקצה על ידי Classroom או alias.

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

פרמטרים
courseWorkMaterialStates[]

enum (CourseWorkMaterialState)

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

string

סדר מיון אופציונלי לתוצאות. רשימת שדות שמופרדים בפסיקים עם מילת מפתח אופציונלית לכיוון מיון. השדה הנתמך הוא updateTime. מילות המפתח הנתמכות לקבלת מסלול הן asc ו-desc. אם לא מגדירים ערך, updateTime desc הוא התנהגות ברירת המחדל. דוגמאות: updateTime asc, updateTime
pageSize

integer

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

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

string

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

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

string

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

גוף הבקשה

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

גוף התשובה

תשובה בזמן הצגת חומר העבודה בקורס.

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

ייצוג JSON 
{
  "courseWorkMaterial": [
    {
      object (CourseWorkMaterial)
    }
  ],
  "nextPageToken": string
}
שדות
courseWorkMaterial[]

object (CourseWorkMaterial)

פריטי חומרי לימוד שתואמים לבקשה.
nextPageToken

string

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

היקפי ההרשאות

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

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

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