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 أيضًا، يجب أن تحتوي مواد العمل الدراسي على مواد تتطابق مع كلا الفلترَين.
previewVersion

enum (PreviewVersion)

اختياريّ الإصدار التجريبي من واجهة برمجة التطبيقات يجب ضبط هذه السمة للوصول إلى إمكانات واجهة برمجة التطبيقات الجديدة التي أصبحت متاحة للمطوّرين في "برنامج الاستخدام المبكر".

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

الاستجابة عند إدراج مواد العمل الدراسي

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل 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

لمزيد من المعلومات، راجِع دليل التفويض.