Method: courses.courseWorkMaterials.list

מחזירה רשימה של חומרי לימוד שהשולח של הבקשה מורשה לצפות בהם.

התלמידים בקורס יכולים לראות רק את חומר הלימוד של PUBLISHED המטלות. מורים בקורס ואדמינים בדומיין יכולים לראות את כל חומרי העבודה בקורס.

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

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

בקשת HTTP

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

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

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

פרמטרים
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, חומרי העבודה של הקורס צריכים להתאים לשני המסננים.
previewVersion

enum (PreviewVersion)

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

גוף הבקשה

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

גוף התשובה

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

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

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

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