Method: courses.students.list

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

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

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

طلب 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

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