Method: courses.studentGroups.patch
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Atualiza um ou mais campos em um grupo de estudantes.Esse método retorna os seguintes códigos de erro:
PERMISSION_DENIED se o usuário solicitante não tiver permissão para modificar o grupo de estudantes solicitado ou por erros de acesso.NOT_FOUND se o grupo de estudantes não existir ou se o usuário não tiver acesso a ele.INVALID_ARGUMENT se campos inválidos forem especificados na máscara de atualização ou se nenhuma máscara de atualização for fornecida.
Solicitação HTTP
PATCH https://classroom.googleapis.com/v1/courses/{courseId}/studentGroups/{id}
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
| Parâmetros |
courseId |
string
Obrigatório. Identificador do curso.
|
id |
string
Obrigatório. Identificador do grupo de estudantes.
|
Parâmetros de consulta
| Parâmetros |
updateMask |
string (FieldMask format)
Obrigatório. Máscara que identifica quais campos do grupo de estudantes serão atualizados. Este campo é obrigatório para fazer uma atualização. A atualização falha se campos inválidos forem especificados. Os professores podem especificar os seguintes campos:
É uma lista separada por vírgulas de nomes de campos totalmente qualificados. Exemplo: "user.displayName,photo".
|
previewVersion |
enum (PreviewVersion)
Opcional. A versão de prévia do endpoint. Isso precisa ser definido para acessar os novos recursos de API disponibilizados aos desenvolvedores no programa de prévia.
|
Corpo da solicitação
O corpo da solicitação contém uma instância de StudentGroup.
Corpo da resposta
Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de StudentGroup.
Escopos de autorização
Requer o seguinte escopo OAuth:
https://www.googleapis.com/auth/classroom.rosters
Para mais informações, consulte o guia de autorização.
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-08-08 UTC.
[null,null,["Última atualização 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)."]]
