Method: courses.courseWork.list

تعرِض هذه السمة قائمة بالأعمال الدراسية التي يُسمح لمقدّم الطلب بعرضها.

يمكن لطلاب الدورة التدريبية الاطّلاع على PUBLISHED المهام الدراسية فقط. يمكن لمعلّمي الدورات التدريبية ومشرفي النطاقات الاطّلاع على جميع أعمال الدورة التدريبية.

تُرجع هذه الطريقة رموز الأخطاء التالية:

  • PERMISSION_DENIED إذا لم يكن مسموحًا للمستخدم الذي يطلب الوصول إلى الدورة التدريبية المطلوبة أو بسبب أخطاء في الوصول.
  • INVALID_ARGUMENT إذا كان الطلب غير صالح
  • NOT_FOUND إذا لم تكن الدورة التدريبية المطلوبة متوفّرة.

طلب HTTP

GET https://classroom.googleapis.com/v1/courses/{courseId}/courseWork

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

مَعلمات المسار

المعلمات
courseId

string

معرّف الدورة التدريبية. يمكن أن يكون هذا المعرّف هو المعرّف الذي تحدّده Classroom أو alias.

مَعلمات طلب البحث

المعلمات
courseWorkStates[]

enum (CourseWorkState)

قيود على حالة العمل للعودة ولا يتم عرض سوى بيانات courseWork التي تتطابق مع البيانات المطلوبة. إذا لم يتم تحديدها، يتم عرض العناصر التي تحمل حالة العمل PUBLISHED.

orderBy

string

ترتيب اختياري للنتائج قائمة مفصولة بفواصل بالحقول مع إدراج كلمة رئيسية اختيارية لاتجاه الترتيب الحقول المتوافقة هي updateTime وdueDate. الكلمات الرئيسية للاتجاهات المسموح بها هي asc وdesc. إذا لم يتم تحديد أي قيمة، يكون الإجراء التلقائي هو updateTime desc. أمثلة: dueDate asc,updateTime desc وupdateTime,dueDate desc

pageSize

integer

الحد الأقصى لعدد العناصر التي سيتم عرضها تشير القيمة صفر أو غير محدّد إلى أنّ الخادم قد يحدّد حدًا أقصى.

قد يعرض الخادم عددًا أقل من العدد المحدّد من النتائج.

pageToken

string

قيمة nextPageToken التي تم إرجاعها من طلب list سابق، ما يشير إلى أنّه يجب عرض الصفحة التالية من النتائج.

يجب أن يكون طلب list مطابقًا للطلب الذي أدّى إلى إنشاء هذا الرمز المميّز.

previewVersion

enum (PreviewVersion)

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

نص الطلب

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

نص الاستجابة

ردّ على إدراج عمل الدورة الدراسية

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

تمثيل JSON
{
  "courseWork": [
    {
      object (CourseWork)
    }
  ],
  "nextPageToken": string
}
الحقول
courseWork[]

object (CourseWork)

عناصر العمل الدراسي التي تتطابق مع الطلب

nextPageToken

string

رمز مميز يحدِّد الصفحة التالية من النتائج التي سيتم عرضها. إذا كان الحقل فارغًا، لن تتوفّر أي نتائج أخرى.

نطاقات التفويض

يتطلب أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/classroom.coursework.students.readonly
  • https://www.googleapis.com/auth/classroom.coursework.me.readonly
  • https://www.googleapis.com/auth/classroom.coursework.students
  • https://www.googleapis.com/auth/classroom.coursework.me

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