افزونه های Google Classroom اکنون به طور کلی در دسترس توسعه دهندگان هستند! لطفاً برای اطلاعات بیشتر به
اسناد افزونه ها مراجعه کنید.
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 باید با درخواستی که منجر به این نشانه شده است، یکسان باشد. |
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 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی."],[],[],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)."]]
