Method: courses.list

تعرِض هذه السمة قائمة بالدورات التدريبية التي يُسمح للمستخدم الذي يقدّم الطلب بالاطّلاع عليها، مع الحصر في تلك التي تتطابق مع الطلب. يتم ترتيب الدورات التدريبية المعروضة حسب وقت إنشائها، مع عرض أحدث دورة تدريبية أولاً.

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

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

طلب HTTP

GET https://classroom.googleapis.com/v1/courses

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

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

المعلمات
studentId

string

حصر الدورات الدراسية المعروضة بالدورات التي تضم طالبًا يحمل المعرّف المحدّد يمكن أن يكون المعرّف واحدًا مما يلي:

  • المعرّف الرقمي للمستخدم
  • عنوان البريد الإلكتروني للمستخدم
  • السلسلة الحرفية "me" التي تشير إلى المستخدم الذي يقدّم الطلب
teacherId

string

حصر الدورات التدريبية المعروضة بتلك التي تضمّ معلّمًا يحمل المعرّف المحدّد يمكن أن يكون المعرّف واحدًا مما يلي:

  • المعرّف الرقمي للمستخدم
  • عنوان البريد الإلكتروني للمستخدم
  • السلسلة الحرفية "me" التي تشير إلى المستخدم الذي يقدّم الطلب
courseStates[]

enum (CourseState)

حصر الدورات التدريبية المعروضة في تلك التي تتضمّن إحدى الحالات المحدّدة. القيمة التلقائية هي ACTIVE أو ARCHIVED أو PROVISIONED أو DECLINED.
pageSize

integer

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

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

string

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

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

نص الطلب

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

نص الاستجابة

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

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

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

object (Course)

الدورات التدريبية التي تتطابق مع طلب القائمة
nextPageToken

string

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

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

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

  • https://www.googleapis.com/auth/classroom.courses
  • https://www.googleapis.com/auth/classroom.courses.readonly

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