تعرض قائمة بطلاب هذه الدورة التدريبية الذين يُسمح لمقدّم الطلب بالاطّلاع عليه.
تعرض هذه الطريقة رموز الخطأ التالية:
NOT_FOUND
إذا لم تكن الدورة الدراسية متوفّرة.PERMISSION_DENIED
بحثًا عن أخطاء الوصول.
طلب HTTP
GET https://classroom.googleapis.com/v1/courses/{courseId}/students
يستخدِم عنوان URL بنية تحويل ترميز gRPC.
مَعلمات المسار
المَعلمات | |
---|---|
courseId |
معرّف الدورة التدريبية. ويمكن أن يكون هذا المعرّف إمّا المعرّف الذي حدّده Classroom أو |
معلمات طلب البحث
المَعلمات | |
---|---|
pageSize |
الحدّ الأقصى لعدد السلع المطلوب إرجاعها وتكون القيمة التلقائية 30 في حال عدم تحديدها أو قد يعرض الخادم عددًا أقل من عدد النتائج المحدّد. |
pageToken |
تم عرض قيمة ويجب أن يكون طلب |
نص الطلب
يجب أن يكون نص الطلب فارغًا.
نص الاستجابة
الرد عند إدراج الطلاب.
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
تمثيل JSON |
---|
{
"students": [
{
object ( |
الحقول | |
---|---|
students[] |
الطلاب الذين يتطابقون مع طلب القائمة. |
nextPageToken |
رمز مميز يحدد الصفحة التالية من النتائج المطلوب عرضها إذا كان هذا الحقل فارغًا، لن يتم توفير أي نتائج أخرى. |
نطاقات التفويض
يتطلب استخدام أحد نطاقات 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
لمزيد من المعلومات، راجِع دليل التفويض.