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)

لحصر الدورات التدريبية التي تم إرجاعها على تلك التي تقع في إحدى الحالات المحددة. تكون القيمة التلقائية هي "نشطة"، و"مؤرشفة"، و"متوفّرة"، و"مرفوضة".

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

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