Google Classroom add-ons are now generally available to developers! Please see the
add-ons documentation for more information.
Method: courses.updateGradingPeriodSettings
Stay organized with collections
Save and categorize content based on your preferences.
Updates grading period settings of a course.
Individual grading periods can be added, removed, or modified using this method.
The requesting user and course owner must be eligible to modify Grading Periods. For details, see licensing requirements.
This method returns the following error codes:
PERMISSION_DENIED if the requesting user is not permitted to modify the grading period settings in a course or for access errors:
- UserIneligibleToUpdateGradingPeriodSettings
INVALID_ARGUMENT if the request is malformed.NOT_FOUND if the requested course does not exist.
HTTP request
PATCH https://classroom.googleapis.com/v1/courses/{courseId}/gradingPeriodSettings
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
courseId |
string
Required. The identifier of the course.
|
Query parameters
| Parameters |
updateMask |
string (FieldMask format)
Mask that identifies which fields in the GradingPeriodSettings to update. The GradingPeriodSettings gradingPeriods list will be fully replaced by the grading periods specified in the update request. For example:
- Grading periods included in the list without an ID are considered additions, and a new ID will be assigned when the request is made.
- Grading periods that currently exist, but are missing from the request will be considered deletions.
- Grading periods with an existing ID and modified data are considered edits. Unmodified data will be left as is.
- Grading periods included with an unknown ID will result in an error.
The following fields may be specified:
gradingPeriodsapplyToExistingCoursework This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".
|
previewVersion |
enum (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.
|
Request body
The request body contains an instance of GradingPeriodSettings.
Response body
If successful, the response body contains an instance of GradingPeriodSettings.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/classroom.courses
For more information, see the Authorization guide.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-04-17 UTC.
[null,null,["Last updated 2025-04-17 UTC."],[],[],null,["# Method: courses.updateGradingPeriodSettings\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 grading period settings of a course.\n\nIndividual grading periods can be added, removed, or modified using this method.\n\nThe requesting user and course owner must be eligible to modify Grading Periods. For details, see [licensing requirements](https://developers.google.com/workspace/classroom/grading-periods/manage-grading-periods#licensing_requirements).\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` if the requesting user is not permitted to modify the grading period settings in a course or for [access errors](/workspace/classroom/reference/Access.Errors):\n - UserIneligibleToUpdateGradingPeriodSettings\n- `INVALID_ARGUMENT` if the request is malformed.\n- `NOT_FOUND` if the requested course does not exist.\n\n### HTTP request\n\n`PATCH https://classroom.googleapis.com/v1/courses/{courseId}/gradingPeriodSettings`\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\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 in the GradingPeriodSettings to update. The GradingPeriodSettings `gradingPeriods` list will be fully replaced by the grading periods specified in the update request. For example: - Grading periods included in the list without an ID are considered additions, and a new ID will be assigned when the request is made. - Grading periods that currently exist, but are missing from the request will be considered deletions. - Grading periods with an existing ID and modified data are considered edits. Unmodified data will be left as is. - Grading periods included with an unknown ID will result in an error. The following fields may be specified: - `gradingPeriods` - `applyToExistingCoursework` 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 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 contains an instance of [GradingPeriodSettings](/workspace/classroom/reference/rest/v1/GradingPeriodSettings).\n\n### Response body\n\nIf successful, the response body contains an instance of [GradingPeriodSettings](/workspace/classroom/reference/rest/v1/GradingPeriodSettings).\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)."]]
