Method: courses.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 curso.
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 curso solicitado ou por erros de acesso.NOT_FOUND se não houver um curso com o ID solicitado.INVALID_ARGUMENT se campos inválidos forem especificados na máscara de atualização ou se nenhuma máscara de atualização for fornecida.FAILED_PRECONDITION para os seguintes erros de solicitação:
- CourseNotModifiable
- InactiveCourseOwner
- IneligibleOwner
- CourseTitleCannotContainUrl
Solicitação HTTP
PATCH https://classroom.googleapis.com/v1/courses/{id}
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
| Parâmetros |
id |
string
Identificador do curso a ser atualizado. Esse identificador pode ser o atribuído pelo Google Sala de Aula ou um alias.
|
Parâmetros de consulta
| Parâmetros |
updateMask |
string (FieldMask format)
Máscara que identifica quais campos do curso serão atualizados. Este campo é obrigatório para fazer uma atualização. A atualização vai falhar se campos inválidos forem especificados. Os seguintes campos são válidos:
namesectiondescriptionHeadingdescriptionroomcourseStateownerId Observação: os patches para "ownerId" são tratados como efetivos imediatamente, mas, na prática, pode levar algum tempo para que a transferência de propriedade de todos os recursos afetados seja concluída. Quando definido em um parâmetro de consulta, esse campo precisa ser especificado como updateMask=<field1>,<field2>,...
É uma lista separada por vírgulas de nomes de campos totalmente qualificados. Exemplo: "user.displayName,photo".
|
Corpo da solicitação
O corpo da solicitação contém uma instância de Course.
Corpo da resposta
Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Course.
Escopos de autorização
Requer o seguinte escopo OAuth:
https://www.googleapis.com/auth/classroom.courses
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.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- [Try it!](#try-it)\n\nUpdates one or more fields in a course.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for [access errors](/workspace/classroom/reference/Access.Errors).\n- `NOT_FOUND` if no course exists with the requested ID.\n- `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied.\n- `FAILED_PRECONDITION` for the following [request errors](/workspace/classroom/reference/Request.Errors):\n - CourseNotModifiable\n - InactiveCourseOwner\n - IneligibleOwner\n - CourseTitleCannotContainUrl\n\n### HTTP request\n\n`PATCH https://classroom.googleapis.com/v1/courses/{id}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `id` | `string` Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an [alias](/workspace/classroom/reference/rest/v1/courses.aliases#CourseAlias). |\n\n### Query parameters\n\n| Parameters ||\n|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `updateMask` | `string (`[FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` format)` Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: - `name` - `section` - `descriptionHeading` - `description` - `room` - `courseState` - `ownerId` Note: patches to ownerId are treated as being effective immediately, but in practice it may take some time for the ownership transfer of all affected resources to complete. When set in a query parameter, this field should be specified as `updateMask=\u003cfield1\u003e,\u003cfield2\u003e,...` This is a comma-separated list of fully qualified names of fields. Example: `\"user.displayName,photo\"`. |\n\n### Request body\n\nThe request body contains an instance of [Course](/workspace/classroom/reference/rest/v1/courses#Course).\n\n### Response body\n\nIf successful, the response body contains an instance of [Course](/workspace/classroom/reference/rest/v1/courses#Course).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/classroom.courses`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
