Method: courses.studentGroups.studentGroupMembers.list

تعرض هذه الطريقة قائمة بالطلاب في مجموعة.

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

  • ‫NOT_FOUND إذا لم تكن الدورة التدريبية أو مجموعة الطلاب متوفّرة

طلب HTTP

GET https://classroom.googleapis.com/v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers

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

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

المعلمات
courseId

string

مطلوب. تمثّل هذه السمة المعرّف الخاص بالدورة التدريبية.
studentGroupId

string

مطلوب. المعرّف الخاص بمجموعة الطلاب

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

المعلمات
pageSize

integer

الحد الأقصى لعدد العناصر المطلوب عرضها. يشير الرقم صفر أو القيمة غير المحدّدة إلى أنّ الخادم قد يحدّد حدًا أقصى.

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

string

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

يجب أن يكون طلب list مطابقًا للطلب الذي نتجت عنه الرمز المميّز.
previewVersion

enum (PreviewVersion)

اختياريّ. إصدار المعاينة من واجهة برمجة التطبيقات يجب ضبط هذا الإعداد للوصول إلى إمكانات واجهة برمجة التطبيقات الجديدة التي أتحناها للمطوّرين في "برنامج الإصدار التجريبي".

نص الطلب

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

نص الاستجابة

الردّ عند إدراج الطلاب في مجموعة

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

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

object (StudentGroupMember)

أعضاء مجموعة الطلاب
nextPageToken

string

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

نطاقات الأذونات

يجب توفير أحد نطاقات OAuth التالية:

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

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