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 مطابقًا للطلب الذي أدّى إلى إنشاء هذا الرمز المميّز.
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

لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.