Method: courses.students.list

عرض قائمة بطلاب هذه الدورة التدريبية المسموح لمقدّم الطلب بعرضها

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

طلب HTTP

GET https://classroom.googleapis.com/v1/courses/{courseId}/students

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

مَعلمات المسار

المعلمات
courseId

string

معرّف الدورة التدريبية. يمكن أن يكون هذا المعرّف هو المعرّف الذي تحدّده Classroom أو alias.

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

المعلمات
pageSize

integer

الحد الأقصى لعدد العناصر التي سيتم عرضها القيمة التلقائية هي 30 إذا لم يتم تحديدها أو 0.

قد يعرض الخادم عددًا أقل من العدد المحدّد من النتائج.
pageToken

string

قيمة nextPageToken التي تم إرجاعها من طلب list سابق، ما يشير إلى أنّه يجب عرض الصفحة التالية من النتائج.

يجب أن يكون طلب list مطابقًا للطلب الذي أدّى إلى إنشاء هذا الرمز المميّز.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

الردّ عند إدراج الطلاب

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "students": [
    {
      object (Student)
    }
  ],
  "nextPageToken": string
}
الحقول
students[]

object (Student)

الطلاب الذين يتطابقون مع طلب القائمة
nextPageToken

string

رمز مميز يحدِّد الصفحة التالية من النتائج التي سيتم عرضها. إذا كان الحقل فارغًا، لن تتوفّر أي نتائج أخرى.

نطاقات التفويض

يتطلب أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/classroom.rosters
  • https://www.googleapis.com/auth/classroom.rosters.readonly
  • https://www.googleapis.com/auth/classroom.profile.emails
  • https://www.googleapis.com/auth/classroom.profile.photos

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