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

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