Skip to main content
Server path: /google-classroom-teaching | Type: Application | PCID required: Yes

Tools

ToolDescription
google-classroom-teaching_create_announcementCreates an announcement.
google-classroom-teaching_create_courseCreates a course.
google-classroom-teaching_create_course_workCreates course work.
google-classroom-teaching_create_course_work_materialCreates a course work material.
google-classroom-teaching_create_rubricCreates a rubric.
google-classroom-teaching_create_topicCreates a topic.
google-classroom-teaching_delete_announcementDeletes an announcement.
google-classroom-teaching_delete_courseDeletes a course.
google-classroom-teaching_delete_course_workDeletes a course work.
google-classroom-teaching_delete_course_work_materialDeletes a course work material.
google-classroom-teaching_delete_rubricDeletes a rubric.
google-classroom-teaching_delete_topicDeletes a topic.
google-classroom-teaching_get_announcementReturns an announcement.
google-classroom-teaching_get_courseReturns a course.
google-classroom-teaching_get_course_workReturns course work.
google-classroom-teaching_get_course_work_materialReturns a course work material.
google-classroom-teaching_get_rubricReturns a rubric.
google-classroom-teaching_get_student_submissionReturns a student submission.
google-classroom-teaching_get_topicReturns a topic.
google-classroom-teaching_list_announcementsReturns a list of announcements that the requester is permitted to view.
google-classroom-teaching_list_course_workReturns a list of course work that the requester is permitted to view.
google-classroom-teaching_list_course_work_materialsReturns a list of course work material that the requester is permitted to view.
google-classroom-teaching_list_coursesReturns a list of courses that the requesting user is permitted to view, restricted to those that match the request.
google-classroom-teaching_list_rubricsReturns a list of rubrics that the requester is permitted to view.
google-classroom-teaching_list_student_submissionsReturns a list of student submissions that the requester is permitted to view, factoring in the OAuth scopes of the request.
google-classroom-teaching_list_topicsReturns the list of topics that the requester is permitted to view.
google-classroom-teaching_modify_attachments_student_submissionModifies attachments of student submission.
google-classroom-teaching_patch_announcementUpdates one or more fields of an announcement.
google-classroom-teaching_patch_courseUpdates one or more fields in a course.
google-classroom-teaching_patch_course_workUpdates one or more fields of a course work.
google-classroom-teaching_patch_course_work_materialUpdates one or more fields of a course work material.
google-classroom-teaching_patch_rubricUpdates a rubric.
google-classroom-teaching_patch_student_submissionUpdates one or more fields of a student submission.
google-classroom-teaching_patch_topicUpdates one or more fields of a topic.
google-classroom-teaching_reclaim_student_submissionReclaims a student submission on behalf of the student that owns it.
google-classroom-teaching_return_student_submissionReturns a student submission.
google-classroom-teaching_turn_in_student_submissionTurns in a student submission.
google-classroom-teaching_update_courseUpdates a course.

google-classroom-teaching_create_announcement

Creates an announcement. Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesIdentifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
alternateLinkstringNoAbsolute link to this announcement in the Classroom web UI. This is only populated if state is PUBLISHED. Read-only.
assigneeModestringNoAssignee mode of the announcement. If unspecified, the default value is ALL_STUDENTS.
creationTimestringNoTimestamp when this announcement was created. Read-only.
creatorUserIdstringNoIdentifier for the user that created the announcement. Read-only.
idstringNoClassroom-assigned identifier of this announcement, unique per course. Read-only.
individualStudentsOptionsobjectNoAssignee details about a coursework/announcement. This field is set if and only if assigneeMode is INDIVIDUAL_STUDENTS.
materialsobject[]NoAdditional materials. Announcements must have no more than 20 material items.
scheduledTimestringNoOptional timestamp when this announcement is scheduled to be published.
statestringNoStatus of this announcement. If unspecified, the default state is DRAFT.
textstringNoDescription of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters.
updateTimestringNoTimestamp of the most recent change to this announcement. Read-only.

google-classroom-teaching_create_course

Creates a course. Parameters:
ParameterTypeRequiredDefaultDescription
alternateLinkstringNoAbsolute link to this course in the Classroom web UI. Read-only.
calendarIdstringNoThe 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.
courseGroupEmailstringNoThe 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.
courseMaterialSetsobject[]NoSets of materials that appear on the “about” page of this course. Read-only.
courseStatestringNoState of the course. If unspecified, the default state is PROVISIONED.
creationTimestringNoCreation time of the course. Specifying this field in a course update mask results in an error. Read-only.
descriptionstringNoOptional 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.
descriptionHeadingstringNoOptional 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.
enrollmentCodestringNoEnrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.
gradebookSettingsobjectNoThe gradebook settings for a course. See the help center article for details.
guardiansEnabledbooleanNoWhether or not guardian notifications are enabled for this course. Read-only.
idstringNoIdentifier 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.
levelsstringNoOptional. 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.
namestringYesName 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.
ownerIdstringYesThe 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.
roomstringNoOptional room location. For example, “301”. If set, this field must be a valid UTF-8 string and no longer than 650 characters.
sectionstringNoSection of the course. For example, “Period 2”. If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
subjectstringNoOptional. The subject of the course.
teacherFolderobjectNoRepresentation of a Google Drive folder.
teacherGroupEmailstringNoThe 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.
updateTimestringNoTime 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:
ParameterTypeRequiredDefaultDescription
courseIdstringYesIdentifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
alternateLinkstringNoAbsolute link to this course work in the Classroom web UI. This is only populated if state is PUBLISHED. Read-only.
assigneeModestringNoAssignee mode of the coursework. If unspecified, the default value is ALL_STUDENTS.
assignmentobjectNoAdditional details for assignments.
associatedWithDeveloperbooleanNoWhether this course work item is associated with the Developer Console project making the request. See CreateCourseWork for more details. Read-only.
creationTimestringNoTimestamp when this course work was created. Read-only.
creatorUserIdstringNoIdentifier for the user that created the coursework. Read-only.
descriptionstringNoOptional description of this course work. If set, the description must be a valid UTF-8 string containing no more than 30,000 characters.
dueDateobjectNoRepresents 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
dueTimeobjectNoRepresents 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.
gradeCategoryobjectNoDetails 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.
gradingPeriodIdstringNoIdentifier 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.
idstringNoClassroom-assigned identifier of this course work, unique per course. Read-only.
individualStudentsOptionsobjectNoAssignee details about a coursework/announcement. This field is set if and only if assigneeMode is INDIVIDUAL_STUDENTS.
materialsobject[]NoAdditional materials. CourseWork must have no more than 20 material items.
maxPointsnumberNoMaximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value.
multipleChoiceQuestionobjectNoAdditional details for multiple-choice questions.
scheduledTimestringNoOptional timestamp when this course work is scheduled to be published.
statestringNoStatus of this course work. If unspecified, the default state is DRAFT.
submissionModificationModestringNoSetting to determine when students are allowed to modify submissions. If unspecified, the default value is MODIFIABLE_UNTIL_TURNED_IN.
titlestringNoTitle of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters.
topicIdstringNoIdentifier for the topic that this coursework is associated with. Must match an existing topic in the course.
updateTimestringNoTimestamp of the most recent change to this course work. Read-only.
workTypestringNoType 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:
ParameterTypeRequiredDefaultDescription
courseIdstringYesIdentifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
alternateLinkstringNoAbsolute link to this course work material in the Classroom web UI. This is only populated if state is PUBLISHED. Read-only.
assigneeModestringNoAssignee mode of the course work material. If unspecified, the default value is ALL_STUDENTS.
creationTimestringNoTimestamp when this course work material was created. Read-only.
creatorUserIdstringNoIdentifier for the user that created the course work material. Read-only.
descriptionstringNoOptional description of this course work material. The text must be a valid UTF-8 string containing no more than 30,000 characters.
idstringNoClassroom-assigned identifier of this course work material, unique per course. Read-only.
individualStudentsOptionsobjectNoAssignee details about a coursework/announcement. This field is set if and only if assigneeMode is INDIVIDUAL_STUDENTS.
materialsobject[]NoAdditional materials. A course work material must have no more than 20 material items.
scheduledTimestringNoOptional timestamp when this course work material is scheduled to be published.
statestringNoStatus of this course work material. If unspecified, the default state is DRAFT.
titlestringNoTitle of this course work material. The title must be a valid UTF-8 string containing between 1 and 3000 characters.
topicIdstringNoIdentifier for the topic that this course work material is associated with. Must match an existing topic in the course.
updateTimestringNoTimestamp of the most recent change to this course work material. Read-only.

google-classroom-teaching_create_rubric

Creates a rubric. Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesRequired. Identifier of the course.
courseWorkIdstringYesRequired. Identifier of the course work.
creationTimestringNoOutput only. Timestamp when this rubric was created. Read-only.
criteriaobject[]NoList of criteria. Each criterion is a dimension on which performance is rated.
idstringNoClassroom-assigned identifier for the rubric. This is unique among rubrics for the relevant course work. Read-only.
sourceSpreadsheetIdstringNoInput 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.
updateTimestringNoOutput only. Timestamp of the most recent change to this rubric. Read-only.

google-classroom-teaching_create_topic

Creates a topic. Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesIdentifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
namestringYesThe 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.
topicIdstringNoUnique identifier for the topic. Read-only.
updateTimestringNoThe time the topic was last updated by the system. Read-only.

google-classroom-teaching_delete_announcement

Deletes an announcement. Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesIdentifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
idstringYesIdentifier of the announcement to delete. This identifier is a Classroom-assigned identifier.

google-classroom-teaching_delete_course

Deletes a course. Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesIdentifier 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:
ParameterTypeRequiredDefaultDescription
courseIdstringYesIdentifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
idstringYesIdentifier 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:
ParameterTypeRequiredDefaultDescription
courseIdstringYesIdentifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
idstringYesIdentifier of the course work material to delete. This identifier is a Classroom-assigned identifier.

google-classroom-teaching_delete_rubric

Deletes a rubric. Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesRequired. Identifier of the course.
courseWorkIdstringYesRequired. Identifier of the course work.
idstringYesRequired. Identifier of the rubric.

google-classroom-teaching_delete_topic

Deletes a topic. Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesIdentifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
idstringYesIdentifier of the topic to delete.

google-classroom-teaching_get_announcement

Returns an announcement. Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesIdentifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
idstringYesIdentifier of the announcement.

google-classroom-teaching_get_course

Returns a course. Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesIdentifier 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:
ParameterTypeRequiredDefaultDescription
courseIdstringYesIdentifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
idstringYesIdentifier of the course work.

google-classroom-teaching_get_course_work_material

Returns a course work material. Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesIdentifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
idstringYesIdentifier of the course work material.

google-classroom-teaching_get_rubric

Returns a rubric. Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesRequired. Identifier of the course.
courseWorkIdstringYesRequired. Identifier of the course work.
idstringYesRequired. Identifier of the rubric.

google-classroom-teaching_get_student_submission

Returns a student submission. Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesIdentifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
courseWorkIdstringYesIdentifier of the course work.
idstringYesIdentifier of the student submission.

google-classroom-teaching_get_topic

Returns a topic. Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesIdentifier of the course.
idstringYesIdentifier of the topic.

google-classroom-teaching_list_announcements

Returns a list of announcements that the requester is permitted to view. Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesIdentifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
announcementStatesstring[]NoRestriction on the state of announcements returned. If this argument is left unspecified, the default value is PUBLISHED.
orderBystringNoOptional 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
pageSizeintegerNoMaximum 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.
pageTokenstringNonextPageToken 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:
ParameterTypeRequiredDefaultDescription
courseIdstringYesIdentifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
courseWorkStatesstring[]NoRestriction on the work status to return. Only courseWork that matches is returned. If unspecified, items with a work status of PUBLISHED is returned.
orderBystringNoOptional 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
pageSizeintegerNoMaximum 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.
pageTokenstringNonextPageToken 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:
ParameterTypeRequiredDefaultDescription
courseIdstringYesIdentifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
courseWorkMaterialStatesstring[]NoRestriction 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.
orderBystringNoOptional 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
pageSizeintegerNoMaximum 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.
pageTokenstringNonextPageToken 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.
materialLinkstringNoOptional filtering for course work material with at least one link material whose URL partially matches the provided string.
materialDriveIdstringNoOptional 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:
ParameterTypeRequiredDefaultDescription
studentIdstringNoRestricts 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.
teacherIdstringNoRestricts 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.
courseStatesstring[]NoRestricts returned courses to those in one of the specified states. If unspecified, Courses in any state are returned.
pageSizeintegerNoMaximum 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.
pageTokenstringNonextPageToken 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:
ParameterTypeRequiredDefaultDescription
courseIdstringYesRequired. Identifier of the course.
courseWorkIdstringYesRequired. Identifier of the course work.
pageSizeintegerNoThe 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.
pageTokenstringNonextPageToken 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:
ParameterTypeRequiredDefaultDescription
courseIdstringYesIdentifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
courseWorkIdstringYesIdentifier 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.
userIdstringNoOptional 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
statesstring[]NoRequested submission states. If specified, returned student submissions match one of the specified submission states.
latestringNoRequested lateness value. If specified, returned student submissions are restricted by the requested value. If unspecified, submissions are returned regardless of late value.
pageSizeintegerNoMaximum 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.
pageTokenstringNonextPageToken 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:
ParameterTypeRequiredDefaultDescription
courseIdstringYesIdentifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
pageSizeintegerNoMaximum 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.
pageTokenstringNonextPageToken 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:
ParameterTypeRequiredDefaultDescription
courseIdstringYesIdentifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
courseWorkIdstringYesIdentifier of the course work.
idstringYesIdentifier of the student submission.
addAttachmentsobject[]YesAttachments 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:
ParameterTypeRequiredDefaultDescription
courseIdstringYesIdentifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
idstringYesIdentifier of the announcement.
updateMaskstringYesMask 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
alternateLinkstringNoAbsolute link to this announcement in the Classroom web UI. This is only populated if state is PUBLISHED. Read-only.
assigneeModestringNoAssignee mode of the announcement. If unspecified, the default value is ALL_STUDENTS.
creationTimestringNoTimestamp when this announcement was created. Read-only.
creatorUserIdstringNoIdentifier for the user that created the announcement. Read-only.
individualStudentsOptionsobjectNoAssignee details about a coursework/announcement. This field is set if and only if assigneeMode is INDIVIDUAL_STUDENTS.
materialsobject[]NoAdditional materials. Announcements must have no more than 20 material items.
scheduledTimestringNoOptional timestamp when this announcement is scheduled to be published.
statestringNoStatus of this announcement. If unspecified, the default state is DRAFT.
textstringNoDescription of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters.
updateTimestringNoTimestamp of the most recent change to this announcement. Read-only.

google-classroom-teaching_patch_course

Updates one or more fields in a course. Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesIdentifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias.
updateMaskstringYesMask 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=,,...
alternateLinkstringNoAbsolute link to this course in the Classroom web UI. Read-only.
calendarIdstringNoThe 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.
courseGroupEmailstringNoThe 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.
courseMaterialSetsobject[]NoSets of materials that appear on the “about” page of this course. Read-only.
courseStatestringNoState of the course. If unspecified, the default state is PROVISIONED.
creationTimestringNoCreation time of the course. Specifying this field in a course update mask results in an error. Read-only.
descriptionstringNoOptional 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.
descriptionHeadingstringNoOptional 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.
enrollmentCodestringNoEnrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.
gradebookSettingsobjectNoThe gradebook settings for a course. See the help center article for details.
guardiansEnabledbooleanNoWhether or not guardian notifications are enabled for this course. Read-only.
levelsstringNoOptional. 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.
namestringNoName 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.
ownerIdstringNoThe 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.
roomstringNoOptional room location. For example, “301”. If set, this field must be a valid UTF-8 string and no longer than 650 characters.
sectionstringNoSection of the course. For example, “Period 2”. If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
subjectstringNoOptional. The subject of the course.
teacherFolderobjectNoRepresentation of a Google Drive folder.
teacherGroupEmailstringNoThe 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.
updateTimestringNoTime 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:
ParameterTypeRequiredDefaultDescription
courseIdstringYesIdentifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
idstringYesIdentifier of the course work.
updateMaskstringYesMask 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
alternateLinkstringNoAbsolute link to this course work in the Classroom web UI. This is only populated if state is PUBLISHED. Read-only.
assigneeModestringNoAssignee mode of the coursework. If unspecified, the default value is ALL_STUDENTS.
assignmentobjectNoAdditional details for assignments.
associatedWithDeveloperbooleanNoWhether this course work item is associated with the Developer Console project making the request. See CreateCourseWork for more details. Read-only.
creationTimestringNoTimestamp when this course work was created. Read-only.
creatorUserIdstringNoIdentifier for the user that created the coursework. Read-only.
descriptionstringNoOptional description of this course work. If set, the description must be a valid UTF-8 string containing no more than 30,000 characters.
dueDateobjectNoRepresents 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
dueTimeobjectNoRepresents 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.
gradeCategoryobjectNoDetails 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.
gradingPeriodIdstringNoIdentifier 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.
individualStudentsOptionsobjectNoAssignee details about a coursework/announcement. This field is set if and only if assigneeMode is INDIVIDUAL_STUDENTS.
materialsobject[]NoAdditional materials. CourseWork must have no more than 20 material items.
maxPointsnumberNoMaximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value.
multipleChoiceQuestionobjectNoAdditional details for multiple-choice questions.
scheduledTimestringNoOptional timestamp when this course work is scheduled to be published.
statestringNoStatus of this course work. If unspecified, the default state is DRAFT.
submissionModificationModestringNoSetting to determine when students are allowed to modify submissions. If unspecified, the default value is MODIFIABLE_UNTIL_TURNED_IN.
titlestringNoTitle of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters.
topicIdstringNoIdentifier for the topic that this coursework is associated with. Must match an existing topic in the course.
updateTimestringNoTimestamp of the most recent change to this course work. Read-only.
workTypestringNoType 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:
ParameterTypeRequiredDefaultDescription
courseIdstringYesIdentifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
idstringYesIdentifier of the course work material.
updateMaskstringYesMask 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
alternateLinkstringNoAbsolute link to this course work material in the Classroom web UI. This is only populated if state is PUBLISHED. Read-only.
assigneeModestringNoAssignee mode of the course work material. If unspecified, the default value is ALL_STUDENTS.
creationTimestringNoTimestamp when this course work material was created. Read-only.
creatorUserIdstringNoIdentifier for the user that created the course work material. Read-only.
descriptionstringNoOptional description of this course work material. The text must be a valid UTF-8 string containing no more than 30,000 characters.
individualStudentsOptionsobjectNoAssignee details about a coursework/announcement. This field is set if and only if assigneeMode is INDIVIDUAL_STUDENTS.
materialsobject[]NoAdditional materials. A course work material must have no more than 20 material items.
scheduledTimestringNoOptional timestamp when this course work material is scheduled to be published.
statestringNoStatus of this course work material. If unspecified, the default state is DRAFT.
titlestringNoTitle of this course work material. The title must be a valid UTF-8 string containing between 1 and 3000 characters.
topicIdstringNoIdentifier for the topic that this course work material is associated with. Must match an existing topic in the course.
updateTimestringNoTimestamp of the most recent change to this course work material. Read-only.

google-classroom-teaching_patch_rubric

Updates a rubric. Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesRequired. Identifier of the course.
courseWorkIdstringYesRequired. Identifier of the course work.
idstringYesOptional. Identifier of the rubric.
updateMaskstringYesOptional. 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
creationTimestringNoOutput only. Timestamp when this rubric was created. Read-only.
criteriaobject[]NoList of criteria. Each criterion is a dimension on which performance is rated.
sourceSpreadsheetIdstringNoInput 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.
updateTimestringNoOutput 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:
ParameterTypeRequiredDefaultDescription
courseIdstringYesIdentifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
courseWorkIdstringYesIdentifier of the course work.
idstringYesIdentifier of the student submission.
updateMaskstringYesMask 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
alternateLinkstringNoAbsolute link to the submission in the Classroom web UI. Read-only.
assignedGradenumberNoOptional 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.
assignedRubricGradesobjectNoAssigned 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.
assignmentSubmissionobjectNoStudent work for an assignment.
associatedWithDeveloperbooleanNoWhether this student submission is associated with the Developer Console project making the request. See CreateCourseWork for more details. Read-only.
courseWorkTypestringNoType of course work this submission is for. Read-only.
creationTimestringNoCreation time of this submission. This may be unset if the student has not accessed this item. Read-only.
draftGradenumberNoOptional 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.
draftRubricGradesobjectNoPending 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.
latebooleanNoWhether this submission is late. Read-only.
multipleChoiceSubmissionobjectNoStudent work for a multiple-choice question.
shortAnswerSubmissionobjectNoStudent work for a short answer question.
statestringNoState of this submission. Read-only.
submissionHistoryobject[]NoThe history of the submission (includes state and grade histories). Read-only.
updateTimestringNoLast update time of this submission. This may be unset if the student has not accessed this item. Read-only.
userIdstringNoIdentifier for the student that owns this submission. Read-only.

google-classroom-teaching_patch_topic

Updates one or more fields of a topic. Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesIdentifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
idstringYesIdentifier of the topic.
updateMaskstringYesMask 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
namestringYesThe 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.
topicIdstringNoUnique identifier for the topic. Read-only.
updateTimestringNoThe 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:
ParameterTypeRequiredDefaultDescription
courseIdstringYesIdentifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
courseWorkIdstringYesIdentifier of the course work.
idstringYesIdentifier of the student submission.

google-classroom-teaching_return_student_submission

Returns a student submission. Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesIdentifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
courseWorkIdstringYesIdentifier of the course work.
idstringYesIdentifier of the student submission.

google-classroom-teaching_turn_in_student_submission

Turns in a student submission. Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesIdentifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
courseWorkIdstringYesIdentifier of the course work.
idstringYesIdentifier of the student submission.

google-classroom-teaching_update_course

Updates a course. Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesIdentifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias.
alternateLinkstringNoAbsolute link to this course in the Classroom web UI. Read-only.
calendarIdstringNoThe 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.
courseGroupEmailstringNoThe 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.
courseMaterialSetsobject[]NoSets of materials that appear on the “about” page of this course. Read-only.
courseStatestringNoState of the course. If unspecified, the default state is PROVISIONED.
creationTimestringNoCreation time of the course. Specifying this field in a course update mask results in an error. Read-only.
descriptionstringNoOptional 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.
descriptionHeadingstringNoOptional 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.
enrollmentCodestringNoEnrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.
gradebookSettingsobjectNoThe gradebook settings for a course. See the help center article for details.
guardiansEnabledbooleanNoWhether or not guardian notifications are enabled for this course. Read-only.
levelsstringNoOptional. 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.
namestringNoName 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.
ownerIdstringNoThe 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.
roomstringNoOptional room location. For example, “301”. If set, this field must be a valid UTF-8 string and no longer than 650 characters.
sectionstringNoSection of the course. For example, “Period 2”. If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
subjectstringNoOptional. The subject of the course.
teacherFolderobjectNoRepresentation of a Google Drive folder.
teacherGroupEmailstringNoThe 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.
updateTimestringNoTime of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.