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 חייבת להיות זהה לזו שהובילה ליצירת האסימון הזה, בכל שאר הפרטים.
|
materialLink |
string
סינון אופציונלי של חומרי עבודה בקורס עם לפחות חומר קישור אחד שכתובת ה-URL שלו תואמת באופן חלקי למחרוזת שצוינה.
|
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
מידע נוסף זמין במדריך ההרשאות.
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-25 (שעון UTC).
[null,null,["עדכון אחרון: 2025-07-25 (שעון UTC)."],[],[],null,["# Method: courses.courseWorkMaterials.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListCourseWorkMaterialResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nReturns a list of course work material that the requester is permitted to view.\n\nCourse students may only view `PUBLISHED` course work material. Course teachers and domain administrators may view all course work material.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for [access errors](/workspace/classroom/reference/Access.Errors).\n- `INVALID_ARGUMENT` if the request is malformed.\n- `NOT_FOUND` if the requested course does not exist.\n\n### HTTP request\n\n`GET https://classroom.googleapis.com/v1/courses/{courseId}/courseWorkMaterials`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `courseId` | `string` Identifier of the course. This identifier can be either the Classroom-assigned identifier or an [alias](/workspace/classroom/reference/rest/v1/courses.aliases#CourseAlias). |\n\n### Query parameters\n\n| Parameters ||\n|------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `courseWorkMaterialStates[]` | `enum (`[CourseWorkMaterialState](/workspace/classroom/reference/rest/v1/courses.courseWorkMaterials#CourseWorkMaterialState)`)` Restriction on the work status to return. Only course work material that matches is returned. If unspecified, items with a work status of `PUBLISHED` is returned. |\n| `orderBy` | `string` Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported field is `updateTime`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `updateTime asc`, `updateTime` |\n| `pageSize` | `integer` Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. |\n| `pageToken` | `string` [nextPageToken](/workspace/classroom/reference/rest/v1/courses.courseWorkMaterials/list#body.ListCourseWorkMaterialResponse.FIELDS.next_page_token) value returned from a previous `list` call, indicating that the subsequent page of results should be returned. The `list` request must be otherwise identical to the one that resulted in this token. |\n| `materialLink` | `string` Optional filtering for course work material with at least one link material whose URL partially matches the provided string. |\n| `materialDriveId` | `string` Optional filtering for course work material with at least one Drive material whose ID matches the provided string. If `materialLink` is also specified, course work material must have materials matching both filters. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse when listing course work material.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"courseWorkMaterial\": [ { object (/workspace/classroom/reference/rest/v1/courses.courseWorkMaterials#CourseWorkMaterial) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `courseWorkMaterial[]` | `object (`[CourseWorkMaterial](/workspace/classroom/reference/rest/v1/courses.courseWorkMaterials#CourseWorkMaterial)`)` Course work material items that match the request. |\n| `nextPageToken` | `string` Token identifying the next page of results to return. If empty, no further results are available. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/classroom.courseworkmaterials`\n- `\n https://www.googleapis.com/auth/classroom.courseworkmaterials.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
