Method: courses.studentGroups.patch
Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Обновляет одно или несколько полей в группе студентов.
Этот метод возвращает следующие коды ошибок:
-
PERMISSION_DENIED если запрашивающему пользователю не разрешено изменять запрашиваемую группу студентов или из-за ошибок доступа . -
NOT_FOUND , если студенческая группа не существует или у пользователя нет доступа к студенческой группе. -
INVALID_ARGUMENT , если в маске обновления указаны недопустимые поля или если маска обновления не указана.
HTTP-запрос
PATCH https://classroom.googleapis.com/v1/courses/{courseId}/studentGroups/{id}
URL использует синтаксис перекодировки 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
Более подробную информацию смотрите в Руководстве по авторизации .
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2025-08-08 UTC.
[null,null,["Последнее обновление: 2025-08-08 UTC."],[],[],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)."]]
