Method: courses.list

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

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

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

طلب HTTP

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

يستخدم عنوان URL بنية gRPC Transcode.

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

المعلّمات
studentId

string

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

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

string

يحصر هذا الخيار الدورات التدريبية التي يتم إرجاعها للأشخاص الذين لديهم معلّم يحمل المعرّف المحدّد. يمكن أن يكون المعرِّف واحدًا مما يلي:

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

enum (CourseState)

الدورات التدريبية التي يتم عرضها في إحدى الولايات المحددة هي القيمة التلقائية "نشط" أو "مؤرشَفة" أو "مرفوضة".

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

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