تتوفّر الآن إضافات 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.
مَعلمات المسار
المعلمات |
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 (حسب التوقيت العالمي المتفَّق عليه)
[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)."]]