/google-classroom-teaching | Type: Application | PCID required: Yes
Tools
google-classroom-teaching_create_announcement
Creates an announcement. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. |
alternateLink | string | No | — | Absolute link to this announcement in the Classroom web UI. This is only populated if state is PUBLISHED. Read-only. |
assigneeMode | string | No | — | Assignee mode of the announcement. If unspecified, the default value is ALL_STUDENTS. |
creationTime | string | No | — | Timestamp when this announcement was created. Read-only. |
creatorUserId | string | No | — | Identifier for the user that created the announcement. Read-only. |
id | string | No | — | Classroom-assigned identifier of this announcement, unique per course. Read-only. |
individualStudentsOptions | object | No | — | Assignee details about a coursework/announcement. This field is set if and only if assigneeMode is INDIVIDUAL_STUDENTS. |
materials | object[] | No | — | Additional materials. Announcements must have no more than 20 material items. |
scheduledTime | string | No | — | Optional timestamp when this announcement is scheduled to be published. |
state | string | No | — | Status of this announcement. If unspecified, the default state is DRAFT. |
text | string | No | — | Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters. |
updateTime | string | No | — | Timestamp of the most recent change to this announcement. Read-only. |
google-classroom-teaching_create_course
Creates a course. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
alternateLink | string | No | — | Absolute link to this course in the Classroom web UI. Read-only. |
calendarId | string | No | — | The Calendar ID for a calendar that all course members can see, to which Classroom adds events for course work and announcements in the course. The Calendar for a course is created asynchronously when the course is set to CourseState.ACTIVE for the first time (at creation time or when it is updated to ACTIVE through the UI or the API). The Calendar ID will not be populated until the creation process is completed. Read-only. |
courseGroupEmail | string | No | — | The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only. |
courseMaterialSets | object[] | No | — | Sets of materials that appear on the “about” page of this course. Read-only. |
courseState | string | No | — | State of the course. If unspecified, the default state is PROVISIONED. |
creationTime | string | No | — | Creation time of the course. Specifying this field in a course update mask results in an error. Read-only. |
description | string | No | — | Optional description. For example, “We’ll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!” If set, this field must be a valid UTF-8 string and no longer than 30,000 characters. |
descriptionHeading | string | No | — | Optional heading for the description. For example, “Welcome to 10th Grade Biology.” If set, this field must be a valid UTF-8 string and no longer than 3600 characters. |
enrollmentCode | string | No | — | Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only. |
gradebookSettings | object | No | — | The gradebook settings for a course. See the help center article for details. |
guardiansEnabled | boolean | No | — | Whether or not guardian notifications are enabled for this course. Read-only. |
id | string | No | — | Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The id is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error. |
levels | string | No | — | Optional. Levels for the course. Examples: “9th grade”, “Middle school”, “4th - 5th”, “K-2”, “3000”. If set, this field must be a valid UTF-8 string and fewer than 1000 characters. This field can only be cleared using the PatchCourse method. |
name | string | Yes | — | Name of the course. For example, “10th Grade Biology”. The name is required. It must be between 1 and 750 characters and a valid UTF-8 string. |
ownerId | string | Yes | — | The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user This must be set in a create request. Admins can also specify this field in a patch course request to transfer ownership. In other contexts, it is read-only. |
room | string | No | — | Optional room location. For example, “301”. If set, this field must be a valid UTF-8 string and no longer than 650 characters. |
section | string | No | — | Section of the course. For example, “Period 2”. If set, this field must be a valid UTF-8 string and no longer than 2800 characters. |
subject | string | No | — | Optional. The subject of the course. |
teacherFolder | object | No | — | Representation of a Google Drive folder. |
teacherGroupEmail | string | No | — | The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only. |
updateTime | string | No | — | Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only. |
google-classroom-teaching_create_course_work
Creates course work. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. |
alternateLink | string | No | — | Absolute link to this course work in the Classroom web UI. This is only populated if state is PUBLISHED. Read-only. |
assigneeMode | string | No | — | Assignee mode of the coursework. If unspecified, the default value is ALL_STUDENTS. |
assignment | object | No | — | Additional details for assignments. |
associatedWithDeveloper | boolean | No | — | Whether this course work item is associated with the Developer Console project making the request. See CreateCourseWork for more details. Read-only. |
creationTime | string | No | — | Timestamp when this course work was created. Read-only. |
creatorUserId | string | No | — | Identifier for the user that created the coursework. Read-only. |
description | string | No | — | Optional description of this course work. If set, the description must be a valid UTF-8 string containing no more than 30,000 characters. |
dueDate | object | No | — | Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp |
dueTime | object | No | — | Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp. |
gradeCategory | object | No | — | Details for a grade category in a course. Coursework may have zero or one grade category, and the category may be used in computing the overall grade. See the help center article for details. |
gradingPeriodId | string | No | — | Identifier of the grading period associated with the coursework. * At creation, if unspecified, the grading period ID will be set based on the dueDate (or scheduledTime if no dueDate is set). * To indicate no association to any grading period, set this field to an empty string (""). * If specified, it must match an existing grading period ID in the course. |
id | string | No | — | Classroom-assigned identifier of this course work, unique per course. Read-only. |
individualStudentsOptions | object | No | — | Assignee details about a coursework/announcement. This field is set if and only if assigneeMode is INDIVIDUAL_STUDENTS. |
materials | object[] | No | — | Additional materials. CourseWork must have no more than 20 material items. |
maxPoints | number | No | — | Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value. |
multipleChoiceQuestion | object | No | — | Additional details for multiple-choice questions. |
scheduledTime | string | No | — | Optional timestamp when this course work is scheduled to be published. |
state | string | No | — | Status of this course work. If unspecified, the default state is DRAFT. |
submissionModificationMode | string | No | — | Setting to determine when students are allowed to modify submissions. If unspecified, the default value is MODIFIABLE_UNTIL_TURNED_IN. |
title | string | No | — | Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters. |
topicId | string | No | — | Identifier for the topic that this coursework is associated with. Must match an existing topic in the course. |
updateTime | string | No | — | Timestamp of the most recent change to this course work. Read-only. |
workType | string | No | — | Type of this course work. The type is set when the course work is created and cannot be changed. |
google-classroom-teaching_create_course_work_material
Creates a course work material. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. |
alternateLink | string | No | — | Absolute link to this course work material in the Classroom web UI. This is only populated if state is PUBLISHED. Read-only. |
assigneeMode | string | No | — | Assignee mode of the course work material. If unspecified, the default value is ALL_STUDENTS. |
creationTime | string | No | — | Timestamp when this course work material was created. Read-only. |
creatorUserId | string | No | — | Identifier for the user that created the course work material. Read-only. |
description | string | No | — | Optional description of this course work material. The text must be a valid UTF-8 string containing no more than 30,000 characters. |
id | string | No | — | Classroom-assigned identifier of this course work material, unique per course. Read-only. |
individualStudentsOptions | object | No | — | Assignee details about a coursework/announcement. This field is set if and only if assigneeMode is INDIVIDUAL_STUDENTS. |
materials | object[] | No | — | Additional materials. A course work material must have no more than 20 material items. |
scheduledTime | string | No | — | Optional timestamp when this course work material is scheduled to be published. |
state | string | No | — | Status of this course work material. If unspecified, the default state is DRAFT. |
title | string | No | — | Title of this course work material. The title must be a valid UTF-8 string containing between 1 and 3000 characters. |
topicId | string | No | — | Identifier for the topic that this course work material is associated with. Must match an existing topic in the course. |
updateTime | string | No | — | Timestamp of the most recent change to this course work material. Read-only. |
google-classroom-teaching_create_rubric
Creates a rubric. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | Required. Identifier of the course. |
courseWorkId | string | Yes | — | Required. Identifier of the course work. |
creationTime | string | No | — | Output only. Timestamp when this rubric was created. Read-only. |
criteria | object[] | No | — | List of criteria. Each criterion is a dimension on which performance is rated. |
id | string | No | — | Classroom-assigned identifier for the rubric. This is unique among rubrics for the relevant course work. Read-only. |
sourceSpreadsheetId | string | No | — | Input only. Immutable. Google Sheets ID of the spreadsheet. This spreadsheet must contain formatted rubric settings. See Create or reuse a rubric for an assignment. Use of this field requires the https://www.googleapis.com/auth/spreadsheets.readonly or https://www.googleapis.com/auth/spreadsheets scope. |
updateTime | string | No | — | Output only. Timestamp of the most recent change to this rubric. Read-only. |
google-classroom-teaching_create_topic
Creates a topic. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. |
name | string | Yes | — | The name of the topic, generated by the user. Leading and trailing whitespaces, if any, are trimmed. Also, multiple consecutive whitespaces are collapsed into one inside the name. The result must be a non-empty string. Topic names are case sensitive, and must be no longer than 100 characters. |
topicId | string | No | — | Unique identifier for the topic. Read-only. |
updateTime | string | No | — | The time the topic was last updated by the system. Read-only. |
google-classroom-teaching_delete_announcement
Deletes an announcement. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. |
id | string | Yes | — | Identifier of the announcement to delete. This identifier is a Classroom-assigned identifier. |
google-classroom-teaching_delete_course
Deletes a course. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Identifier of the course to delete. This identifier can be either the Classroom-assigned identifier or an alias. |
google-classroom-teaching_delete_course_work
Deletes a course work. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. |
id | string | Yes | — | Identifier of the course work to delete. This identifier is a Classroom-assigned identifier. |
google-classroom-teaching_delete_course_work_material
Deletes a course work material. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. |
id | string | Yes | — | Identifier of the course work material to delete. This identifier is a Classroom-assigned identifier. |
google-classroom-teaching_delete_rubric
Deletes a rubric. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | Required. Identifier of the course. |
courseWorkId | string | Yes | — | Required. Identifier of the course work. |
id | string | Yes | — | Required. Identifier of the rubric. |
google-classroom-teaching_delete_topic
Deletes a topic. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. |
id | string | Yes | — | Identifier of the topic to delete. |
google-classroom-teaching_get_announcement
Returns an announcement. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. |
id | string | Yes | — | Identifier of the announcement. |
google-classroom-teaching_get_course
Returns a course. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Identifier of the course to return. This identifier can be either the Classroom-assigned identifier or an alias. |
google-classroom-teaching_get_course_work
Returns course work. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. |
id | string | Yes | — | Identifier of the course work. |
google-classroom-teaching_get_course_work_material
Returns a course work material. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. |
id | string | Yes | — | Identifier of the course work material. |
google-classroom-teaching_get_rubric
Returns a rubric. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | Required. Identifier of the course. |
courseWorkId | string | Yes | — | Required. Identifier of the course work. |
id | string | Yes | — | Required. Identifier of the rubric. |
google-classroom-teaching_get_student_submission
Returns a student submission. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. |
courseWorkId | string | Yes | — | Identifier of the course work. |
id | string | Yes | — | Identifier of the student submission. |
google-classroom-teaching_get_topic
Returns a topic. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | Identifier of the course. |
id | string | Yes | — | Identifier of the topic. |
google-classroom-teaching_list_announcements
Returns a list of announcements that the requester is permitted to view. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. |
announcementStates | string[] | No | — | Restriction on the state of announcements returned. If this argument is left unspecified, the default value is PUBLISHED. |
orderBy | string | No | — | Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported field is updateTime. Supported direction keywords are asc and desc. If not specified, updateTime desc is the default behavior. Examples: updateTime asc, updateTime |
pageSize | integer | No | — | Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. |
pageToken | string | No | — | nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. |
google-classroom-teaching_list_course_work
Returns a list of course work that the requester is permitted to view. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. |
courseWorkStates | string[] | No | — | Restriction on the work status to return. Only courseWork that matches is returned. If unspecified, items with a work status of PUBLISHED is returned. |
orderBy | string | No | — | Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported fields are updateTime and dueDate. Supported direction keywords are asc and desc. If not specified, updateTime desc is the default behavior. Examples: dueDate asc,updateTime desc, updateTime,dueDate desc |
pageSize | integer | No | — | Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. |
pageToken | string | No | — | nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. |
google-classroom-teaching_list_course_work_materials
Returns a list of course work material that the requester is permitted to view. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. |
courseWorkMaterialStates | string[] | No | — | Restriction on the work status to return. Only course work material that matches is returned. If unspecified, items with a work status of PUBLISHED is returned. |
orderBy | string | No | — | Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported field is updateTime. Supported direction keywords are asc and desc. If not specified, updateTime desc is the default behavior. Examples: updateTime asc, updateTime |
pageSize | integer | No | — | Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. |
pageToken | string | No | — | nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. |
materialLink | string | No | — | Optional filtering for course work material with at least one link material whose URL partially matches the provided string. |
materialDriveId | string | No | — | Optional filtering for course work material with at least one Drive material whose ID matches the provided string. If material_link is also specified, course work material must have materials matching both filters. |
google-classroom-teaching_list_courses
Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
studentId | string | No | — | Restricts returned courses to those having a student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user If specified, teacher_id must be empty. |
teacherId | string | No | — | Restricts returned courses to those having a teacher with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user If specified, student_id must be empty. |
courseStates | string[] | No | — | Restricts returned courses to those in one of the specified states. If unspecified, Courses in any state are returned. |
pageSize | integer | No | — | Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. |
pageToken | string | No | — | nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. |
google-classroom-teaching_list_rubrics
Returns a list of rubrics that the requester is permitted to view. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | Required. Identifier of the course. |
courseWorkId | string | Yes | — | Required. Identifier of the course work. |
pageSize | integer | No | — | The maximum number of rubrics to return. If unspecified, at most 1 rubric is returned. The maximum value is 1; values above 1 are coerced to 1. |
pageToken | string | No | — | nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. |
google-classroom-teaching_list_student_submissions
Returns a list of student submissions that the requester is permitted to view, factoring in the OAuth scopes of the request. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. |
courseWorkId | string | Yes | — | Identifier of the student work to request. This may be set to the string literal "-" to request student work for all course work in the specified course. |
userId | string | No | — | Optional argument to restrict returned student work to those owned by the student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user |
states | string[] | No | — | Requested submission states. If specified, returned student submissions match one of the specified submission states. |
late | string | No | — | Requested lateness value. If specified, returned student submissions are restricted by the requested value. If unspecified, submissions are returned regardless of late value. |
pageSize | integer | No | — | Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. |
pageToken | string | No | — | nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. |
google-classroom-teaching_list_topics
Returns the list of topics that the requester is permitted to view. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. |
pageSize | integer | No | — | Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. |
pageToken | string | No | — | nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. |
google-classroom-teaching_modify_attachments_student_submission
Modifies attachments of student submission. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. |
courseWorkId | string | Yes | — | Identifier of the course work. |
id | string | Yes | — | Identifier of the student submission. |
addAttachments | object[] | Yes | — | Attachments to add. A student submission may not have more than 20 attachments. Form attachments are not supported. |
google-classroom-teaching_patch_announcement
Updates one or more fields of an announcement. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. |
id | string | Yes | — | Identifier of the announcement. |
updateMask | string | Yes | — | Mask that identifies which fields on the announcement to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the Announcement object. If a field that does not support empty values is included in the update mask and not set in the Announcement object, an INVALID_ARGUMENT error is returned. The following fields may be specified by teachers: * text * state * scheduledTime |
alternateLink | string | No | — | Absolute link to this announcement in the Classroom web UI. This is only populated if state is PUBLISHED. Read-only. |
assigneeMode | string | No | — | Assignee mode of the announcement. If unspecified, the default value is ALL_STUDENTS. |
creationTime | string | No | — | Timestamp when this announcement was created. Read-only. |
creatorUserId | string | No | — | Identifier for the user that created the announcement. Read-only. |
individualStudentsOptions | object | No | — | Assignee details about a coursework/announcement. This field is set if and only if assigneeMode is INDIVIDUAL_STUDENTS. |
materials | object[] | No | — | Additional materials. Announcements must have no more than 20 material items. |
scheduledTime | string | No | — | Optional timestamp when this announcement is scheduled to be published. |
state | string | No | — | Status of this announcement. If unspecified, the default state is DRAFT. |
text | string | No | — | Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters. |
updateTime | string | No | — | Timestamp of the most recent change to this announcement. Read-only. |
google-classroom-teaching_patch_course
Updates one or more fields in a course. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias. |
updateMask | string | Yes | — | 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: * courseState * description * descriptionHeading * name * ownerId * room * section * subject * levels 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=,,... |
alternateLink | string | No | — | Absolute link to this course in the Classroom web UI. Read-only. |
calendarId | string | No | — | The Calendar ID for a calendar that all course members can see, to which Classroom adds events for course work and announcements in the course. The Calendar for a course is created asynchronously when the course is set to CourseState.ACTIVE for the first time (at creation time or when it is updated to ACTIVE through the UI or the API). The Calendar ID will not be populated until the creation process is completed. Read-only. |
courseGroupEmail | string | No | — | The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only. |
courseMaterialSets | object[] | No | — | Sets of materials that appear on the “about” page of this course. Read-only. |
courseState | string | No | — | State of the course. If unspecified, the default state is PROVISIONED. |
creationTime | string | No | — | Creation time of the course. Specifying this field in a course update mask results in an error. Read-only. |
description | string | No | — | Optional description. For example, “We’ll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!” If set, this field must be a valid UTF-8 string and no longer than 30,000 characters. |
descriptionHeading | string | No | — | Optional heading for the description. For example, “Welcome to 10th Grade Biology.” If set, this field must be a valid UTF-8 string and no longer than 3600 characters. |
enrollmentCode | string | No | — | Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only. |
gradebookSettings | object | No | — | The gradebook settings for a course. See the help center article for details. |
guardiansEnabled | boolean | No | — | Whether or not guardian notifications are enabled for this course. Read-only. |
levels | string | No | — | Optional. Levels for the course. Examples: “9th grade”, “Middle school”, “4th - 5th”, “K-2”, “3000”. If set, this field must be a valid UTF-8 string and fewer than 1000 characters. This field can only be cleared using the PatchCourse method. |
name | string | No | — | Name of the course. For example, “10th Grade Biology”. The name is required. It must be between 1 and 750 characters and a valid UTF-8 string. |
ownerId | string | No | — | The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user This must be set in a create request. Admins can also specify this field in a patch course request to transfer ownership. In other contexts, it is read-only. |
room | string | No | — | Optional room location. For example, “301”. If set, this field must be a valid UTF-8 string and no longer than 650 characters. |
section | string | No | — | Section of the course. For example, “Period 2”. If set, this field must be a valid UTF-8 string and no longer than 2800 characters. |
subject | string | No | — | Optional. The subject of the course. |
teacherFolder | object | No | — | Representation of a Google Drive folder. |
teacherGroupEmail | string | No | — | The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only. |
updateTime | string | No | — | Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only. |
google-classroom-teaching_patch_course_work
Updates one or more fields of a course work. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. |
id | string | Yes | — | Identifier of the course work. |
updateMask | string | Yes | — | Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the CourseWork object. If a field that does not support empty values is included in the update mask and not set in the CourseWork object, an INVALID_ARGUMENT error is returned. The following fields may be specified by teachers: * title * description * state * dueDate * dueTime * maxPoints * scheduledTime * submissionModificationMode * topicId * gradingPeriodId |
alternateLink | string | No | — | Absolute link to this course work in the Classroom web UI. This is only populated if state is PUBLISHED. Read-only. |
assigneeMode | string | No | — | Assignee mode of the coursework. If unspecified, the default value is ALL_STUDENTS. |
assignment | object | No | — | Additional details for assignments. |
associatedWithDeveloper | boolean | No | — | Whether this course work item is associated with the Developer Console project making the request. See CreateCourseWork for more details. Read-only. |
creationTime | string | No | — | Timestamp when this course work was created. Read-only. |
creatorUserId | string | No | — | Identifier for the user that created the coursework. Read-only. |
description | string | No | — | Optional description of this course work. If set, the description must be a valid UTF-8 string containing no more than 30,000 characters. |
dueDate | object | No | — | Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp |
dueTime | object | No | — | Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp. |
gradeCategory | object | No | — | Details for a grade category in a course. Coursework may have zero or one grade category, and the category may be used in computing the overall grade. See the help center article for details. |
gradingPeriodId | string | No | — | Identifier of the grading period associated with the coursework. * At creation, if unspecified, the grading period ID will be set based on the dueDate (or scheduledTime if no dueDate is set). * To indicate no association to any grading period, set this field to an empty string (""). * If specified, it must match an existing grading period ID in the course. |
individualStudentsOptions | object | No | — | Assignee details about a coursework/announcement. This field is set if and only if assigneeMode is INDIVIDUAL_STUDENTS. |
materials | object[] | No | — | Additional materials. CourseWork must have no more than 20 material items. |
maxPoints | number | No | — | Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value. |
multipleChoiceQuestion | object | No | — | Additional details for multiple-choice questions. |
scheduledTime | string | No | — | Optional timestamp when this course work is scheduled to be published. |
state | string | No | — | Status of this course work. If unspecified, the default state is DRAFT. |
submissionModificationMode | string | No | — | Setting to determine when students are allowed to modify submissions. If unspecified, the default value is MODIFIABLE_UNTIL_TURNED_IN. |
title | string | No | — | Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters. |
topicId | string | No | — | Identifier for the topic that this coursework is associated with. Must match an existing topic in the course. |
updateTime | string | No | — | Timestamp of the most recent change to this course work. Read-only. |
workType | string | No | — | Type of this course work. The type is set when the course work is created and cannot be changed. |
google-classroom-teaching_patch_course_work_material
Updates one or more fields of a course work material. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. |
id | string | Yes | — | Identifier of the course work material. |
updateMask | string | Yes | — | Mask that identifies which fields on the course work material to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the course work material object. If a field that does not support empty values is included in the update mask and not set in the course work material object, an INVALID_ARGUMENT error is returned. The following fields may be specified by teachers: * title * description * state * scheduledTime * topicId |
alternateLink | string | No | — | Absolute link to this course work material in the Classroom web UI. This is only populated if state is PUBLISHED. Read-only. |
assigneeMode | string | No | — | Assignee mode of the course work material. If unspecified, the default value is ALL_STUDENTS. |
creationTime | string | No | — | Timestamp when this course work material was created. Read-only. |
creatorUserId | string | No | — | Identifier for the user that created the course work material. Read-only. |
description | string | No | — | Optional description of this course work material. The text must be a valid UTF-8 string containing no more than 30,000 characters. |
individualStudentsOptions | object | No | — | Assignee details about a coursework/announcement. This field is set if and only if assigneeMode is INDIVIDUAL_STUDENTS. |
materials | object[] | No | — | Additional materials. A course work material must have no more than 20 material items. |
scheduledTime | string | No | — | Optional timestamp when this course work material is scheduled to be published. |
state | string | No | — | Status of this course work material. If unspecified, the default state is DRAFT. |
title | string | No | — | Title of this course work material. The title must be a valid UTF-8 string containing between 1 and 3000 characters. |
topicId | string | No | — | Identifier for the topic that this course work material is associated with. Must match an existing topic in the course. |
updateTime | string | No | — | Timestamp of the most recent change to this course work material. Read-only. |
google-classroom-teaching_patch_rubric
Updates a rubric. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | Required. Identifier of the course. |
courseWorkId | string | Yes | — | Required. Identifier of the course work. |
id | string | Yes | — | Optional. Identifier of the rubric. |
updateMask | string | Yes | — | Optional. Mask that identifies which fields on the rubric to update. This field is required to do an update. The update fails if invalid fields are specified. There are multiple options to define the criteria of a rubric: the sourceSpreadsheetId and the criteria list. Only one of these can be used at a time to define a rubric. The rubric criteria list is fully replaced by the rubric criteria specified in the update request. For example, if a criterion or level is missing from the request, it is deleted. New criteria and levels are added and an ID is assigned. Existing criteria and levels retain the previously assigned ID if the ID is specified in the request. The following fields can be specified by teachers: * criteria * sourceSpreadsheetId |
creationTime | string | No | — | Output only. Timestamp when this rubric was created. Read-only. |
criteria | object[] | No | — | List of criteria. Each criterion is a dimension on which performance is rated. |
sourceSpreadsheetId | string | No | — | Input only. Immutable. Google Sheets ID of the spreadsheet. This spreadsheet must contain formatted rubric settings. See Create or reuse a rubric for an assignment. Use of this field requires the https://www.googleapis.com/auth/spreadsheets.readonly or https://www.googleapis.com/auth/spreadsheets scope. |
updateTime | string | No | — | Output only. Timestamp of the most recent change to this rubric. Read-only. |
google-classroom-teaching_patch_student_submission
Updates one or more fields of a student submission. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. |
courseWorkId | string | Yes | — | Identifier of the course work. |
id | string | Yes | — | Identifier of the student submission. |
updateMask | string | Yes | — | Mask that identifies which fields on the student submission to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields may be specified by teachers: * draftGrade * assignedGrade |
alternateLink | string | No | — | Absolute link to the submission in the Classroom web UI. Read-only. |
assignedGrade | number | No | — | Optional grade. If unset, no grade was set. This value must be non-negative. Decimal (that is, non-integer) values are allowed, but are rounded to two decimal places. This may be modified only by course teachers. |
assignedRubricGrades | object | No | — | Assigned rubric grades based on the rubric’s Criteria. This map is empty if there is no rubric attached to this course work or if a rubric is attached, but no grades have been set on any Criteria. Entries are only populated for grades that have been set. Key: The rubric’s criterion ID. Read-only. |
assignmentSubmission | object | No | — | Student work for an assignment. |
associatedWithDeveloper | boolean | No | — | Whether this student submission is associated with the Developer Console project making the request. See CreateCourseWork for more details. Read-only. |
courseWorkType | string | No | — | Type of course work this submission is for. Read-only. |
creationTime | string | No | — | Creation time of this submission. This may be unset if the student has not accessed this item. Read-only. |
draftGrade | number | No | — | Optional pending grade. If unset, no grade was set. This value must be non-negative. Decimal (that is, non-integer) values are allowed, but are rounded to two decimal places. This is only visible to and modifiable by course teachers. |
draftRubricGrades | object | No | — | Pending rubric grades based on the rubric’s criteria. This map is empty if there is no rubric attached to this course work or if a rubric is attached, but no grades have been set on any criteria. Entries are only populated for grades that have been set. Key: The rubric’s criterion ID. Read-only. |
late | boolean | No | — | Whether this submission is late. Read-only. |
multipleChoiceSubmission | object | No | — | Student work for a multiple-choice question. |
shortAnswerSubmission | object | No | — | Student work for a short answer question. |
state | string | No | — | State of this submission. Read-only. |
submissionHistory | object[] | No | — | The history of the submission (includes state and grade histories). Read-only. |
updateTime | string | No | — | Last update time of this submission. This may be unset if the student has not accessed this item. Read-only. |
userId | string | No | — | Identifier for the student that owns this submission. Read-only. |
google-classroom-teaching_patch_topic
Updates one or more fields of a topic. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. |
id | string | Yes | — | Identifier of the topic. |
updateMask | string | Yes | — | Mask that identifies which fields on the topic to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the Topic object. If a field that does not support empty values is included in the update mask and not set in the Topic object, an INVALID_ARGUMENT error is returned. The following fields may be specified: * name |
name | string | Yes | — | The name of the topic, generated by the user. Leading and trailing whitespaces, if any, are trimmed. Also, multiple consecutive whitespaces are collapsed into one inside the name. The result must be a non-empty string. Topic names are case sensitive, and must be no longer than 100 characters. |
topicId | string | No | — | Unique identifier for the topic. Read-only. |
updateTime | string | No | — | The time the topic was last updated by the system. Read-only. |
google-classroom-teaching_reclaim_student_submission
Reclaims a student submission on behalf of the student that owns it. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. |
courseWorkId | string | Yes | — | Identifier of the course work. |
id | string | Yes | — | Identifier of the student submission. |
google-classroom-teaching_return_student_submission
Returns a student submission. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. |
courseWorkId | string | Yes | — | Identifier of the course work. |
id | string | Yes | — | Identifier of the student submission. |
google-classroom-teaching_turn_in_student_submission
Turns in a student submission. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. |
courseWorkId | string | Yes | — | Identifier of the course work. |
id | string | Yes | — | Identifier of the student submission. |
google-classroom-teaching_update_course
Updates a course. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias. |
alternateLink | string | No | — | Absolute link to this course in the Classroom web UI. Read-only. |
calendarId | string | No | — | The Calendar ID for a calendar that all course members can see, to which Classroom adds events for course work and announcements in the course. The Calendar for a course is created asynchronously when the course is set to CourseState.ACTIVE for the first time (at creation time or when it is updated to ACTIVE through the UI or the API). The Calendar ID will not be populated until the creation process is completed. Read-only. |
courseGroupEmail | string | No | — | The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only. |
courseMaterialSets | object[] | No | — | Sets of materials that appear on the “about” page of this course. Read-only. |
courseState | string | No | — | State of the course. If unspecified, the default state is PROVISIONED. |
creationTime | string | No | — | Creation time of the course. Specifying this field in a course update mask results in an error. Read-only. |
description | string | No | — | Optional description. For example, “We’ll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!” If set, this field must be a valid UTF-8 string and no longer than 30,000 characters. |
descriptionHeading | string | No | — | Optional heading for the description. For example, “Welcome to 10th Grade Biology.” If set, this field must be a valid UTF-8 string and no longer than 3600 characters. |
enrollmentCode | string | No | — | Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only. |
gradebookSettings | object | No | — | The gradebook settings for a course. See the help center article for details. |
guardiansEnabled | boolean | No | — | Whether or not guardian notifications are enabled for this course. Read-only. |
levels | string | No | — | Optional. Levels for the course. Examples: “9th grade”, “Middle school”, “4th - 5th”, “K-2”, “3000”. If set, this field must be a valid UTF-8 string and fewer than 1000 characters. This field can only be cleared using the PatchCourse method. |
name | string | No | — | Name of the course. For example, “10th Grade Biology”. The name is required. It must be between 1 and 750 characters and a valid UTF-8 string. |
ownerId | string | No | — | The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user This must be set in a create request. Admins can also specify this field in a patch course request to transfer ownership. In other contexts, it is read-only. |
room | string | No | — | Optional room location. For example, “301”. If set, this field must be a valid UTF-8 string and no longer than 650 characters. |
section | string | No | — | Section of the course. For example, “Period 2”. If set, this field must be a valid UTF-8 string and no longer than 2800 characters. |
subject | string | No | — | Optional. The subject of the course. |
teacherFolder | object | No | — | Representation of a Google Drive folder. |
teacherGroupEmail | string | No | — | The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only. |
updateTime | string | No | — | Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only. |

