تتوفّر الآن إضافات Google Classroom بشكل عام للمطوّرين. يُرجى الاطّلاع على
مستندات الإضافات للحصول على مزيد من المعلومات.
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
لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.
إنّ محتوى هذه الصفحة مرخّص بموجب ترخيص Creative Commons Attribution 4.0 ما لم يُنصّ على خلاف ذلك، ونماذج الرموز مرخّصة بموجب ترخيص Apache 2.0. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجَّلة لشركة Oracle و/أو شركائها التابعين.
تاريخ التعديل الأخير: 2025-08-08 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2025-08-08 (حسب التوقيت العالمي المتفَّق عليه)"],[],[],null,["# Method: courses.studentGroups.studentGroupMembers.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListStudentGroupMembersResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n\n\u003cbr /\u003e\n\n| **Developer Preview:** Available as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features. This feature is available in [V1_20250630_PREVIEW](https://developers.google.com/workspace/classroom/reference/rest/v1/PreviewVersion) and later. See [Access Preview APIs](https://developers.google.com/workspace/classroom/reference/preview) to learn more.\nReturns a list of students in a group.\n\n\u003cbr /\u003e\n\nThis method returns the following error codes:\n\n- `NOT_FOUND` if the course or student group does not exist.\n\n### HTTP request\n\n`GET https://classroom.googleapis.com/v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------------|---------------------------------------------------------|\n| `courseId` | `string` Required. The identifier of the course. |\n| `studentGroupId` | `string` Required. The identifier of the student group. |\n\n### Query parameters\n\n| Parameters ||\n|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. |\n| `pageToken` | `string` [nextPageToken](/workspace/classroom/reference/rest/v1/courses.studentGroups.studentGroupMembers/list#body.ListStudentGroupMembersResponse.FIELDS.next_page_token) value returned from a previous [list](/workspace/classroom/reference/rest/v1/courses.studentGroups.studentGroupMembers/list#google.classroom.v1.Courses.ListStudentGroupMembers) call, indicating that the subsequent page of results should be returned. The [list](/workspace/classroom/reference/rest/v1/courses.studentGroups.studentGroupMembers/list#google.classroom.v1.Courses.ListStudentGroupMembers) request must be otherwise identical to the one that resulted in this token. |\n| `previewVersion` | `enum (`[PreviewVersion](/workspace/classroom/reference/rest/v1/PreviewVersion)`)` Optional. The preview version of the API. This must be set in order to access new API capabilities made available to developers in the Preview Program. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse when listing students in a group.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"studentGroupMembers\": [ { object (/workspace/classroom/reference/rest/v1/courses.studentGroups.studentGroupMembers#StudentGroupMember) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `studentGroupMembers[]` | `object (`[StudentGroupMember](/workspace/classroom/reference/rest/v1/courses.studentGroups.studentGroupMembers#StudentGroupMember)`)` The student group members. |\n| `nextPageToken` | `string` Token identifying the next page of results to return. If empty, no further results are available. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/classroom.rosters`\n- `\n https://www.googleapis.com/auth/classroom.rosters.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]