Google Classroom add-ons are now generally available to developers! Please see the
add-ons documentation for more information.
GradingPeriodSettings
Stay organized with collections
Save and categorize content based on your preferences.
Grading period settings that include all the individual grading periods in a course.
| JSON representation |
{
"gradingPeriods": [
{
object (GradingPeriod)
}
],
"applyToExistingCoursework": boolean,
"previewVersion": enum (PreviewVersion)
} |
| Fields |
gradingPeriods[] |
object (GradingPeriod)
The list of grading periods in a specific course. Grading periods must not have overlapping date ranges and must be listed in chronological order. Each grading period must have a unique title within a course.
|
applyToExistingCoursework |
boolean
Supports toggling the application of grading periods on existing stream items. Once set, this value is persisted meaning that it does not need to be set in every request to update GradingPeriodSettings. If not previously set, the default is False.
|
previewVersion |
enum (PreviewVersion)
Output only. The preview version of the API used to retrieve this resource.
|
GradingPeriod
An individual grading period.
Grading periods must not have overlapping date ranges and must be listed in chronological order. For example, if the endDate of a grading period is 2024-01-25, then the startDate of the next grading period must be 2024-01-26 or later. Each grading period must have a unique title within a course.
| JSON representation |
{
"id": string,
"title": string,
"startDate": {
object (Date)
},
"endDate": {
object (Date)
}
} |
| Fields |
id |
string
Output only. System generated grading period ID. Read-only.
|
title |
string
Required. Title of the grading period. For example, “Semester 1”.
|
startDate |
object (Date)
Required. Start date, in UTC, of the grading period. Inclusive.
|
endDate |
object (Date)
Required. End date, in UTC, of the grading period. Inclusive.
|
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,["# GradingPeriodSettings\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n- [GradingPeriod](#GradingPeriod)\n - [JSON representation](#GradingPeriod.SCHEMA_REPRESENTATION)\n\nGrading period settings that include all the individual grading periods in a course.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"gradingPeriods\": [ { object (/workspace/classroom/reference/rest/v1/GradingPeriodSettings#GradingPeriod) } ], \"applyToExistingCoursework\": boolean, \"previewVersion\": enum (/workspace/classroom/reference/rest/v1/PreviewVersion) } ``` |\n\n| Fields ||\n|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `gradingPeriods[]` | `object (`[GradingPeriod](/workspace/classroom/reference/rest/v1/GradingPeriodSettings#GradingPeriod)`)` The list of grading periods in a specific course. Grading periods must not have overlapping date ranges and must be listed in chronological order. Each grading period must have a unique title within a course. |\n| `applyToExistingCoursework` | `boolean` Supports toggling the application of grading periods on existing stream items. Once set, this value is persisted meaning that it does not need to be set in every request to update `GradingPeriodSettings`. If not previously set, the default is False. |\n| `previewVersion` | `enum (`[PreviewVersion](/workspace/classroom/reference/rest/v1/PreviewVersion)`)` Output only. The preview version of the API used to retrieve this resource. |\n\nGradingPeriod\n-------------\n\nAn individual grading period.\n\nGrading periods must not have overlapping date ranges and must be listed in chronological order. For example, if the endDate of a grading period is 2024-01-25, then the startDate of the next grading period must be 2024-01-26 or later. Each grading period must have a unique title within a course.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"id\": string, \"title\": string, \"startDate\": { object (/workspace/classroom/reference/rest/v1/Date) }, \"endDate\": { object (/workspace/classroom/reference/rest/v1/Date) } } ``` |\n\n| Fields ||\n|-------------|----------------------------------------------------------------------------------------------------------------------------------|\n| `id` | `string` Output only. System generated grading period ID. Read-only. |\n| `title` | `string` Required. Title of the grading period. For example, \"Semester 1\". |\n| `startDate` | `object (`[Date](/workspace/classroom/reference/rest/v1/Date)`)` Required. Start date, in UTC, of the grading period. Inclusive. |\n| `endDate` | `object (`[Date](/workspace/classroom/reference/rest/v1/Date)`)` Required. End date, in UTC, of the grading period. Inclusive. |"]]
