Method: courses.courseWorkMaterials.list

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

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

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

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

בקשת HTTP

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

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

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