Google 课堂插件现已面向开发者正式推出!如需了解详情,请参阅
插件文档。
Method: courses.studentGroups.patch
使用集合让一切井井有条
根据您的偏好保存内容并对其进行分类。
更新学生群组中的一个或多个字段。此方法会返回以下错误代码:
- 如果请求用户无权修改所请求的学生群组,或者存在访问错误,则返回
PERMISSION_DENIED
。
NOT_FOUND
如果学生群组不存在或用户无权访问学生群组。
- 如果更新掩码中指定了无效字段,或者未提供更新掩码,则使用
INVALID_ARGUMENT
。
HTTP 请求
PATCH https://classroom.googleapis.com/v1/courses/{courseId}/studentGroups/{id}
网址采用 gRPC 转码语法。
路径参数
参数 |
courseId |
string
必需。课程的标识符。
|
id |
string
必需。学生群组的标识符。
|
查询参数
参数 |
updateMask |
string (FieldMask format)
必需。用于标识要更新的学生群组字段的掩码。此字段是执行更新所必需的。如果指定了无效字段,更新会失败。 教师可以指定以下字段:
这是完全限定字段名称的逗号分隔列表。示例:"user.displayName,photo" 。
|
previewVersion |
enum (PreviewVersion )
可选。端点预览版本。必须设置此标志,才能访问预览版计划中向开发者提供的新 API 功能。
|
请求正文
请求正文包含一个 StudentGroup
实例。
响应正文
如果成功,则响应正文包含一个 StudentGroup
实例。
授权范围
需要以下 OAuth 范围:
https://www.googleapis.com/auth/classroom.rosters
如需了解详情,请参阅授权指南。
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2025-08-08。
[null,null,["最后更新时间 (UTC):2025-08-08。"],[],[],null,["# Method: courses.studentGroups.patch\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- [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.\nUpdates one or more fields in a student group.\n\n\u003cbr /\u003e\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested student group or for [access errors](/workspace/classroom/reference/Access.Errors).\n- `NOT_FOUND` if the student group does not exist or the user does not have access to the student group.\n- `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied.\n\n### HTTP request\n\n`PATCH https://classroom.googleapis.com/v1/courses/{courseId}/studentGroups/{id}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|-----------------------------------------------------|\n| `courseId` | `string` Required. Identifier of the course. |\n| `id` | `string` Required. Identifier of the student group. |\n\n### Query parameters\n\n| Parameters ||\n|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `updateMask` | `string (`[FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` format)` Required. Mask that identifies which fields on the student group to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields can be specified by teachers: - `title` This is a comma-separated list of fully qualified names of fields. Example: `\"user.displayName,photo\"`. |\n| `previewVersion` | `enum (`[PreviewVersion](/workspace/classroom/reference/rest/v1/PreviewVersion)`)` Optional. The endpoint preview version. 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 contains an instance of [StudentGroup](/workspace/classroom/reference/rest/v1/courses.studentGroups#StudentGroup).\n\n### Response body\n\nIf successful, the response body contains an instance of [StudentGroup](/workspace/classroom/reference/rest/v1/courses.studentGroups#StudentGroup).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/classroom.rosters`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]