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" و"مرفوضة".
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

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