Method: courses.list

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

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

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

طلب HTTP

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

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

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

المعلمات
studentId

string

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

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

في حال تحديدها، يجب أن تكون قيمة teacherId فارغة.
teacherId

string

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

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

في حال تحديدها، يجب أن تكون قيمة studentId فارغة.
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

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