Google 课堂插件现已面向开发者正式推出!如需了解详情,请参阅
插件文档。
Method: courses.studentGroups.studentGroupMembers.list
使用集合让一切井井有条
根据您的偏好保存内容并对其进行分类。
返回群组中的学生列表。此方法会返回以下错误代码:
- 如果课程或学生群组不存在,则为
NOT_FOUND
。
HTTP 请求
GET https://classroom.googleapis.com/v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers
网址采用 gRPC 转码语法。
路径参数
参数 |
courseId |
string
必需。课程的标识符。
|
studentGroupId |
string
必需。学生群组的标识符。
|
查询参数
参数 |
pageSize |
integer
要返回的最大商品数量。如果值为 0 或未指定,则表示服务器可能会分配一个上限。 服务器返回的结果数可能少于指定的结果数。
|
pageToken |
string
之前 list 调用返回的 nextPageToken 值,表示应返回下一页结果。 list 请求必须与生成此令牌的请求完全相同。
|
previewVersion |
enum (PreviewVersion )
可选。API 的预览版。必须设置此标志,才能访问预览版计划中向开发者提供的新 API 功能。
|
响应正文
列出群组中的学生时的响应。
如果成功,响应正文将包含结构如下的数据:
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
如需了解详情,请参阅授权指南。
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2025-08-08。
[null,null,["最后更新时间 (UTC):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)."]]