> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # google-classroom-teaching > Google Classroom Teaching — courses, assignments, announcements, topics, and grades **Server path:** `/google-classroom-teaching` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | ------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | | [`google-classroom-teaching_create_announcement`](#google-classroom-teaching_create_announcement) | Creates an announcement. | | [`google-classroom-teaching_create_course`](#google-classroom-teaching_create_course) | Creates a course. | | [`google-classroom-teaching_create_course_work`](#google-classroom-teaching_create_course_work) | Creates course work. | | [`google-classroom-teaching_create_course_work_material`](#google-classroom-teaching_create_course_work_material) | Creates a course work material. | | [`google-classroom-teaching_create_rubric`](#google-classroom-teaching_create_rubric) | Creates a rubric. | | [`google-classroom-teaching_create_topic`](#google-classroom-teaching_create_topic) | Creates a topic. | | [`google-classroom-teaching_delete_announcement`](#google-classroom-teaching_delete_announcement) | Deletes an announcement. | | [`google-classroom-teaching_delete_course`](#google-classroom-teaching_delete_course) | Deletes a course. | | [`google-classroom-teaching_delete_course_work`](#google-classroom-teaching_delete_course_work) | Deletes a course work. | | [`google-classroom-teaching_delete_course_work_material`](#google-classroom-teaching_delete_course_work_material) | Deletes a course work material. | | [`google-classroom-teaching_delete_rubric`](#google-classroom-teaching_delete_rubric) | Deletes a rubric. | | [`google-classroom-teaching_delete_topic`](#google-classroom-teaching_delete_topic) | Deletes a topic. | | [`google-classroom-teaching_get_announcement`](#google-classroom-teaching_get_announcement) | Returns an announcement. | | [`google-classroom-teaching_get_course`](#google-classroom-teaching_get_course) | Returns a course. | | [`google-classroom-teaching_get_course_work`](#google-classroom-teaching_get_course_work) | Returns course work. | | [`google-classroom-teaching_get_course_work_material`](#google-classroom-teaching_get_course_work_material) | Returns a course work material. | | [`google-classroom-teaching_get_rubric`](#google-classroom-teaching_get_rubric) | Returns a rubric. | | [`google-classroom-teaching_get_student_submission`](#google-classroom-teaching_get_student_submission) | Returns a student submission. | | [`google-classroom-teaching_get_topic`](#google-classroom-teaching_get_topic) | Returns a topic. | | [`google-classroom-teaching_list_announcements`](#google-classroom-teaching_list_announcements) | Returns a list of announcements that the requester is permitted to view. | | [`google-classroom-teaching_list_course_work`](#google-classroom-teaching_list_course_work) | Returns a list of course work that the requester is permitted to view. | | [`google-classroom-teaching_list_course_work_materials`](#google-classroom-teaching_list_course_work_materials) | Returns a list of course work material that the requester is permitted to view. | | [`google-classroom-teaching_list_courses`](#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. | | [`google-classroom-teaching_list_rubrics`](#google-classroom-teaching_list_rubrics) | Returns a list of rubrics that the requester is permitted to view. | | [`google-classroom-teaching_list_student_submissions`](#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. | | [`google-classroom-teaching_list_topics`](#google-classroom-teaching_list_topics) | Returns the list of topics that the requester is permitted to view. | | [`google-classroom-teaching_modify_attachments_student_submission`](#google-classroom-teaching_modify_attachments_student_submission) | Modifies attachments of student submission. | | [`google-classroom-teaching_patch_announcement`](#google-classroom-teaching_patch_announcement) | Updates one or more fields of an announcement. | | [`google-classroom-teaching_patch_course`](#google-classroom-teaching_patch_course) | Updates one or more fields in a course. | | [`google-classroom-teaching_patch_course_work`](#google-classroom-teaching_patch_course_work) | Updates one or more fields of a course work. | | [`google-classroom-teaching_patch_course_work_material`](#google-classroom-teaching_patch_course_work_material) | Updates one or more fields of a course work material. | | [`google-classroom-teaching_patch_rubric`](#google-classroom-teaching_patch_rubric) | Updates a rubric. | | [`google-classroom-teaching_patch_student_submission`](#google-classroom-teaching_patch_student_submission) | Updates one or more fields of a student submission. | | [`google-classroom-teaching_patch_topic`](#google-classroom-teaching_patch_topic) | Updates one or more fields of a topic. | | [`google-classroom-teaching_reclaim_student_submission`](#google-classroom-teaching_reclaim_student_submission) | Reclaims a student submission on behalf of the student that owns it. | | [`google-classroom-teaching_return_student_submission`](#google-classroom-teaching_return_student_submission) | Returns a student submission. | | [`google-classroom-teaching_turn_in_student_submission`](#google-classroom-teaching_turn_in_student_submission) | Turns in a student submission. | | [`google-classroom-teaching_update_course`](#google-classroom-teaching_update_course) | Updates a course. | *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias." }, "alternateLink": { "type": "string", "description": "Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only." }, "assigneeMode": { "type": "string", "description": "Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.", "enum": [ "ASSIGNEE_MODE_UNSPECIFIED", "ALL_STUDENTS", "INDIVIDUAL_STUDENTS" ] }, "creationTime": { "type": "string", "description": "Timestamp when this announcement was created. Read-only." }, "creatorUserId": { "type": "string", "description": "Identifier for the user that created the announcement. Read-only." }, "id": { "type": "string", "description": "Classroom-assigned identifier of this announcement, unique per course. Read-only." }, "individualStudentsOptions": { "type": "object", "description": "Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.", "properties": { "studentIds": { "type": "array", "items": { "type": "string" }, "description": "Identifiers for the students that have access to the coursework/announcement." } } }, "materials": { "type": "array", "items": { "type": "object", "properties": { "driveFile": { "type": "object", "description": "Drive file that is used as material for course work." }, "youtubeVideo": { "type": "object", "description": "YouTube video item." }, "link": { "type": "object", "description": "URL item." }, "form": { "type": "object", "description": "Google Forms item." }, "gem": { "type": "object", "description": "Gemini Gem link." }, "notebook": { "type": "object", "description": "NotebookLM Notebook link." } } }, "description": "Additional materials. Announcements must have no more than 20 material items." }, "scheduledTime": { "type": "string", "description": "Optional timestamp when this announcement is scheduled to be published." }, "state": { "type": "string", "description": "Status of this announcement. If unspecified, the default state is `DRAFT`.", "enum": [ "ANNOUNCEMENT_STATE_UNSPECIFIED", "PUBLISHED", "DRAFT", "DELETED" ] }, "text": { "type": "string", "description": "Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters." }, "updateTime": { "type": "string", "description": "Timestamp of the most recent change to this announcement. Read-only." } }, "required": [ "PCID", "courseId" ] } ``` *** ## 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](https://support.google.com/edu/classroom/answer/9184995) 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "alternateLink": { "type": "string", "description": "Absolute link to this course in the Classroom web UI. Read-only." }, "calendarId": { "type": "string", "description": "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": { "type": "string", "description": "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": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string", "description": "Title for this set." }, "materials": { "type": "array", "items": { "type": "object", "properties": { "driveFile": { "type": "object", "description": "Representation of a Google Drive file." }, "link": { "type": "object", "description": "URL item." }, "form": { "type": "object", "description": "Google Forms item." }, "youtubeVideo": { "type": "object", "description": "YouTube video item." } } }, "description": "Materials attached to this set." } } }, "description": "Sets of materials that appear on the \"about\" page of this course. Read-only." }, "courseState": { "type": "string", "description": "State of the course. If unspecified, the default state is `PROVISIONED`.", "enum": [ "COURSE_STATE_UNSPECIFIED", "ACTIVE", "ARCHIVED", "PROVISIONED", "DECLINED", "SUSPENDED" ] }, "creationTime": { "type": "string", "description": "Creation time of the course. Specifying this field in a course update mask results in an error. Read-only." }, "description": { "type": "string", "description": "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": { "type": "string", "description": "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": { "type": "string", "description": "Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only." }, "gradebookSettings": { "type": "object", "description": "The gradebook settings for a course. See the [help center article](https://support.google.com/edu/classroom/answer/9184995) for details.", "properties": { "calculationType": { "type": "string", "description": "Indicates how the overall grade is calculated.", "enum": [ "CALCULATION_TYPE_UNSPECIFIED", "TOTAL_POINTS", "WEIGHTED_CATEGORIES" ] }, "displaySetting": { "type": "string", "description": "Indicates who can see the overall grade..", "enum": [ "DISPLAY_SETTING_UNSPECIFIED", "SHOW_OVERALL_GRADE", "HIDE_OVERALL_GRADE", "SHOW_TEACHERS_ONLY" ] }, "gradeCategories": { "type": "array", "items": { "type": "object" }, "description": "Grade categories that are available for coursework in the course." } } }, "guardiansEnabled": { "type": "boolean", "description": "Whether or not guardian notifications are enabled for this course. Read-only." }, "id": { "type": "string", "description": "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": { "type": "string", "description": "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": { "type": "string", "description": "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": { "type": "string", "description": "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": { "type": "string", "description": "Optional room location. For example, \"301\". If set, this field must be a valid UTF-8 string and no longer than 650 characters." }, "section": { "type": "string", "description": "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": { "type": "string", "description": "Optional. The subject of the course." }, "teacherFolder": { "type": "object", "description": "Representation of a Google Drive folder.", "properties": { "id": { "type": "string", "description": "Drive API resource ID." }, "title": { "type": "string", "description": "Title of the Drive folder. Read-only." }, "alternateLink": { "type": "string", "description": "URL that can be used to access the Drive folder. Read-only." } } }, "teacherGroupEmail": { "type": "string", "description": "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": { "type": "string", "description": "Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only." } }, "required": [ "PCID", "name", "ownerId" ] } ``` *** ## 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](https://support.google.com/edu/classroom/answer/9184995) 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias." }, "alternateLink": { "type": "string", "description": "Absolute link to this course work in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only." }, "assigneeMode": { "type": "string", "description": "Assignee mode of the coursework. If unspecified, the default value is `ALL_STUDENTS`.", "enum": [ "ASSIGNEE_MODE_UNSPECIFIED", "ALL_STUDENTS", "INDIVIDUAL_STUDENTS" ] }, "assignment": { "type": "object", "description": "Additional details for assignments.", "properties": { "studentWorkFolder": { "type": "object", "description": "Representation of a Google Drive folder." } } }, "associatedWithDeveloper": { "type": "boolean", "description": "Whether this course work item is associated with the Developer Console project making the request. See CreateCourseWork for more details. Read-only." }, "creationTime": { "type": "string", "description": "Timestamp when this course work was created. Read-only." }, "creatorUserId": { "type": "string", "description": "Identifier for the user that created the coursework. Read-only." }, "description": { "type": "string", "description": "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": { "type": "object", "description": "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", "properties": { "year": { "type": "integer", "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year." }, "month": { "type": "integer", "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day." }, "day": { "type": "integer", "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant." } } }, "dueTime": { "type": "object", "description": "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`.", "properties": { "hours": { "type": "integer", "description": "Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time." }, "minutes": { "type": "integer", "description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59." }, "seconds": { "type": "integer", "description": "Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds." }, "nanos": { "type": "integer", "description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999." } } }, "gradeCategory": { "type": "object", "description": "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](https://support.google.com/edu/classroom/answer/9184995) for details.", "properties": { "id": { "type": "string", "description": "ID of the grade category." }, "name": { "type": "string", "description": "Name of the grade category." }, "weight": { "type": "integer", "description": "The weight of the category average as part of overall average. A weight of 12.34% is represented as 123400 (100% is 1,000,000). The last two digits should always be zero since we use two decimal precision. Only applicable when grade calculation type is WEIGHTED_CATEGORIES." }, "defaultGradeDenominator": { "type": "integer", "description": "Default value of denominator. Only applicable when grade calculation type is TOTAL_POINTS." } } }, "gradingPeriodId": { "type": "string", "description": "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": { "type": "string", "description": "Classroom-assigned identifier of this course work, unique per course. Read-only." }, "individualStudentsOptions": { "type": "object", "description": "Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.", "properties": { "studentIds": { "type": "array", "items": { "type": "string" }, "description": "Identifiers for the students that have access to the coursework/announcement." } } }, "materials": { "type": "array", "items": { "type": "object", "properties": { "driveFile": { "type": "object", "description": "Drive file that is used as material for course work." }, "youtubeVideo": { "type": "object", "description": "YouTube video item." }, "link": { "type": "object", "description": "URL item." }, "form": { "type": "object", "description": "Google Forms item." }, "gem": { "type": "object", "description": "Gemini Gem link." }, "notebook": { "type": "object", "description": "NotebookLM Notebook link." } } }, "description": "Additional materials. CourseWork must have no more than 20 material items." }, "maxPoints": { "type": "number", "description": "Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value." }, "multipleChoiceQuestion": { "type": "object", "description": "Additional details for multiple-choice questions.", "properties": { "choices": { "type": "array", "items": { "type": "string" }, "description": "Possible choices." } } }, "scheduledTime": { "type": "string", "description": "Optional timestamp when this course work is scheduled to be published." }, "state": { "type": "string", "description": "Status of this course work. If unspecified, the default state is `DRAFT`.", "enum": [ "COURSE_WORK_STATE_UNSPECIFIED", "PUBLISHED", "DRAFT", "DELETED" ] }, "submissionModificationMode": { "type": "string", "description": "Setting to determine when students are allowed to modify submissions. If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.", "enum": [ "SUBMISSION_MODIFICATION_MODE_UNSPECIFIED", "MODIFIABLE_UNTIL_TURNED_IN", "MODIFIABLE" ] }, "title": { "type": "string", "description": "Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters." }, "topicId": { "type": "string", "description": "Identifier for the topic that this coursework is associated with. Must match an existing topic in the course." }, "updateTime": { "type": "string", "description": "Timestamp of the most recent change to this course work. Read-only." }, "workType": { "type": "string", "description": "Type of this course work. The type is set when the course work is created and cannot be changed.", "enum": [ "COURSE_WORK_TYPE_UNSPECIFIED", "ASSIGNMENT", "SHORT_ANSWER_QUESTION", "MULTIPLE_CHOICE_QUESTION" ] } }, "required": [ "PCID", "courseId" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias." }, "alternateLink": { "type": "string", "description": "Absolute link to this course work material in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only." }, "assigneeMode": { "type": "string", "description": "Assignee mode of the course work material. If unspecified, the default value is `ALL_STUDENTS`.", "enum": [ "ASSIGNEE_MODE_UNSPECIFIED", "ALL_STUDENTS", "INDIVIDUAL_STUDENTS" ] }, "creationTime": { "type": "string", "description": "Timestamp when this course work material was created. Read-only." }, "creatorUserId": { "type": "string", "description": "Identifier for the user that created the course work material. Read-only." }, "description": { "type": "string", "description": "Optional description of this course work material. The text must be a valid UTF-8 string containing no more than 30,000 characters." }, "id": { "type": "string", "description": "Classroom-assigned identifier of this course work material, unique per course. Read-only." }, "individualStudentsOptions": { "type": "object", "description": "Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.", "properties": { "studentIds": { "type": "array", "items": { "type": "string" }, "description": "Identifiers for the students that have access to the coursework/announcement." } } }, "materials": { "type": "array", "items": { "type": "object", "properties": { "driveFile": { "type": "object", "description": "Drive file that is used as material for course work." }, "youtubeVideo": { "type": "object", "description": "YouTube video item." }, "link": { "type": "object", "description": "URL item." }, "form": { "type": "object", "description": "Google Forms item." }, "gem": { "type": "object", "description": "Gemini Gem link." }, "notebook": { "type": "object", "description": "NotebookLM Notebook link." } } }, "description": "Additional materials. A course work material must have no more than 20 material items." }, "scheduledTime": { "type": "string", "description": "Optional timestamp when this course work material is scheduled to be published." }, "state": { "type": "string", "description": "Status of this course work material. If unspecified, the default state is `DRAFT`.", "enum": [ "COURSEWORK_MATERIAL_STATE_UNSPECIFIED", "PUBLISHED", "DRAFT", "DELETED" ] }, "title": { "type": "string", "description": "Title of this course work material. The title must be a valid UTF-8 string containing between 1 and 3000 characters." }, "topicId": { "type": "string", "description": "Identifier for the topic that this course work material is associated with. Must match an existing topic in the course." }, "updateTime": { "type": "string", "description": "Timestamp of the most recent change to this course work material. Read-only." } }, "required": [ "PCID", "courseId" ] } ``` *** ## 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](https://support.google.com/edu/classroom/answer/9335069). 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "Required. Identifier of the course." }, "courseWorkId": { "type": "string", "description": "Required. Identifier of the course work." }, "creationTime": { "type": "string", "description": "Output only. Timestamp when this rubric was created. Read-only." }, "criteria": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The criterion ID. On creation, an ID is assigned." }, "title": { "type": "string", "description": "The title of the criterion." }, "description": { "type": "string", "description": "The description of the criterion." }, "levels": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The level ID. On creation, an ID is assigned." }, "title": { "type": "string", "description": "The title of the level. If the level has no points set, title must be set." }, "description": { "type": "string", "description": "The description of the level." }, "points": { "type": "number", "description": "Optional points associated with this level. If set, all levels within the rubric must specify points and the value must be distinct across all levels within a single criterion. 0 is distinct from no points." } } }, "description": "The list of levels within this criterion." } } }, "description": "List of criteria. Each criterion is a dimension on which performance is rated." }, "id": { "type": "string", "description": "Classroom-assigned identifier for the rubric. This is unique among rubrics for the relevant course work. Read-only." }, "sourceSpreadsheetId": { "type": "string", "description": "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](https://support.google.com/edu/classroom/answer/9335069). Use of this field requires the `https://www.googleapis.com/auth/spreadsheets.readonly` or `https://www.googleapis.com/auth/spreadsheets` scope." }, "updateTime": { "type": "string", "description": "Output only. Timestamp of the most recent change to this rubric. Read-only." } }, "required": [ "PCID", "courseId", "courseWorkId" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias." }, "name": { "type": "string", "description": "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": { "type": "string", "description": "Unique identifier for the topic. Read-only." }, "updateTime": { "type": "string", "description": "The time the topic was last updated by the system. Read-only." } }, "required": [ "PCID", "courseId", "name" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias." }, "id": { "type": "string", "description": "Identifier of the announcement to delete. This identifier is a Classroom-assigned identifier." } }, "required": [ "PCID", "courseId", "id" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Identifier of the course to delete. This identifier can be either the Classroom-assigned identifier or an alias." } }, "required": [ "PCID", "id" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias." }, "id": { "type": "string", "description": "Identifier of the course work to delete. This identifier is a Classroom-assigned identifier." } }, "required": [ "PCID", "courseId", "id" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias." }, "id": { "type": "string", "description": "Identifier of the course work material to delete. This identifier is a Classroom-assigned identifier." } }, "required": [ "PCID", "courseId", "id" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "Required. Identifier of the course." }, "courseWorkId": { "type": "string", "description": "Required. Identifier of the course work." }, "id": { "type": "string", "description": "Required. Identifier of the rubric." } }, "required": [ "PCID", "courseId", "courseWorkId", "id" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias." }, "id": { "type": "string", "description": "Identifier of the topic to delete." } }, "required": [ "PCID", "courseId", "id" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias." }, "id": { "type": "string", "description": "Identifier of the announcement." } }, "required": [ "PCID", "courseId", "id" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Identifier of the course to return. This identifier can be either the Classroom-assigned identifier or an alias." } }, "required": [ "PCID", "id" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias." }, "id": { "type": "string", "description": "Identifier of the course work." } }, "required": [ "PCID", "courseId", "id" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias." }, "id": { "type": "string", "description": "Identifier of the course work material." } }, "required": [ "PCID", "courseId", "id" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "Required. Identifier of the course." }, "courseWorkId": { "type": "string", "description": "Required. Identifier of the course work." }, "id": { "type": "string", "description": "Required. Identifier of the rubric." } }, "required": [ "PCID", "courseId", "courseWorkId", "id" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias." }, "courseWorkId": { "type": "string", "description": "Identifier of the course work." }, "id": { "type": "string", "description": "Identifier of the student submission." } }, "required": [ "PCID", "courseId", "courseWorkId", "id" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "Identifier of the course." }, "id": { "type": "string", "description": "Identifier of the topic." } }, "required": [ "PCID", "courseId", "id" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias." }, "announcementStates": { "type": "array", "items": { "type": "string", "enum": [ "ANNOUNCEMENT_STATE_UNSPECIFIED", "PUBLISHED", "DRAFT", "DELETED" ] }, "description": "Restriction on the `state` of announcements returned. If this argument is left unspecified, the default value is `PUBLISHED`." }, "orderBy": { "type": "string", "description": "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": { "type": "integer", "description": "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": { "type": "string", "description": "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." } }, "required": [ "PCID", "courseId" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias." }, "courseWorkStates": { "type": "array", "items": { "type": "string", "enum": [ "COURSE_WORK_STATE_UNSPECIFIED", "PUBLISHED", "DRAFT", "DELETED" ] }, "description": "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": { "type": "string", "description": "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": { "type": "integer", "description": "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": { "type": "string", "description": "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." } }, "required": [ "PCID", "courseId" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias." }, "courseWorkMaterialStates": { "type": "array", "items": { "type": "string", "enum": [ "COURSEWORK_MATERIAL_STATE_UNSPECIFIED", "PUBLISHED", "DRAFT", "DELETED" ] }, "description": "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": { "type": "string", "description": "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": { "type": "integer", "description": "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": { "type": "string", "description": "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": { "type": "string", "description": "Optional filtering for course work material with at least one link material whose URL partially matches the provided string." }, "materialDriveId": { "type": "string", "description": "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." } }, "required": [ "PCID", "courseId" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "studentId": { "type": "string", "description": "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": { "type": "string", "description": "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": { "type": "array", "items": { "type": "string", "enum": [ "COURSE_STATE_UNSPECIFIED", "ACTIVE", "ARCHIVED", "PROVISIONED", "DECLINED", "SUSPENDED" ] }, "description": "Restricts returned courses to those in one of the specified states. If unspecified, Courses in any state are returned." }, "pageSize": { "type": "integer", "description": "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": { "type": "string", "description": "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." } }, "required": [ "PCID" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "Required. Identifier of the course." }, "courseWorkId": { "type": "string", "description": "Required. Identifier of the course work." }, "pageSize": { "type": "integer", "description": "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": { "type": "string", "description": "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." } }, "required": [ "PCID", "courseId", "courseWorkId" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias." }, "courseWorkId": { "type": "string", "description": "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": { "type": "string", "description": "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": { "type": "array", "items": { "type": "string", "enum": [ "SUBMISSION_STATE_UNSPECIFIED", "NEW", "CREATED", "TURNED_IN", "RETURNED", "RECLAIMED_BY_STUDENT" ] }, "description": "Requested submission states. If specified, returned student submissions match one of the specified submission states." }, "late": { "type": "string", "description": "Requested lateness value. If specified, returned student submissions are restricted by the requested value. If unspecified, submissions are returned regardless of `late` value.", "enum": [ "LATE_VALUES_UNSPECIFIED", "LATE_ONLY", "NOT_LATE_ONLY" ] }, "pageSize": { "type": "integer", "description": "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": { "type": "string", "description": "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." } }, "required": [ "PCID", "courseId", "courseWorkId" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias." }, "pageSize": { "type": "integer", "description": "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": { "type": "string", "description": "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." } }, "required": [ "PCID", "courseId" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias." }, "courseWorkId": { "type": "string", "description": "Identifier of the course work." }, "id": { "type": "string", "description": "Identifier of the student submission." }, "addAttachments": { "type": "array", "items": { "type": "object", "properties": { "driveFile": { "type": "object", "description": "Representation of a Google Drive file." }, "link": { "type": "object", "description": "URL item." }, "form": { "type": "object", "description": "Google Forms item." }, "youtubeVideo": { "type": "object", "description": "YouTube video item." } } }, "description": "Attachments to add. A student submission may not have more than 20 attachments. Form attachments are not supported." } }, "required": [ "PCID", "courseId", "courseWorkId", "id", "addAttachments" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias." }, "id": { "type": "string", "description": "Identifier of the announcement." }, "updateMask": { "type": "string", "description": "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": { "type": "string", "description": "Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only." }, "assigneeMode": { "type": "string", "description": "Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.", "enum": [ "ASSIGNEE_MODE_UNSPECIFIED", "ALL_STUDENTS", "INDIVIDUAL_STUDENTS" ] }, "creationTime": { "type": "string", "description": "Timestamp when this announcement was created. Read-only." }, "creatorUserId": { "type": "string", "description": "Identifier for the user that created the announcement. Read-only." }, "individualStudentsOptions": { "type": "object", "description": "Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.", "properties": { "studentIds": { "type": "array", "items": { "type": "string" }, "description": "Identifiers for the students that have access to the coursework/announcement." } } }, "materials": { "type": "array", "items": { "type": "object", "properties": { "driveFile": { "type": "object", "description": "Drive file that is used as material for course work." }, "youtubeVideo": { "type": "object", "description": "YouTube video item." }, "link": { "type": "object", "description": "URL item." }, "form": { "type": "object", "description": "Google Forms item." }, "gem": { "type": "object", "description": "Gemini Gem link." }, "notebook": { "type": "object", "description": "NotebookLM Notebook link." } } }, "description": "Additional materials. Announcements must have no more than 20 material items." }, "scheduledTime": { "type": "string", "description": "Optional timestamp when this announcement is scheduled to be published." }, "state": { "type": "string", "description": "Status of this announcement. If unspecified, the default state is `DRAFT`.", "enum": [ "ANNOUNCEMENT_STATE_UNSPECIFIED", "PUBLISHED", "DRAFT", "DELETED" ] }, "text": { "type": "string", "description": "Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters." }, "updateTime": { "type": "string", "description": "Timestamp of the most recent change to this announcement. Read-only." } }, "required": [ "PCID", "courseId", "id", "updateMask" ] } ``` *** ## 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](https://support.google.com/edu/classroom/answer/9184995) 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias." }, "updateMask": { "type": "string", "description": "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": { "type": "string", "description": "Absolute link to this course in the Classroom web UI. Read-only." }, "calendarId": { "type": "string", "description": "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": { "type": "string", "description": "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": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string", "description": "Title for this set." }, "materials": { "type": "array", "items": { "type": "object", "properties": { "driveFile": { "type": "object", "description": "Representation of a Google Drive file." }, "link": { "type": "object", "description": "URL item." }, "form": { "type": "object", "description": "Google Forms item." }, "youtubeVideo": { "type": "object", "description": "YouTube video item." } } }, "description": "Materials attached to this set." } } }, "description": "Sets of materials that appear on the \"about\" page of this course. Read-only." }, "courseState": { "type": "string", "description": "State of the course. If unspecified, the default state is `PROVISIONED`.", "enum": [ "COURSE_STATE_UNSPECIFIED", "ACTIVE", "ARCHIVED", "PROVISIONED", "DECLINED", "SUSPENDED" ] }, "creationTime": { "type": "string", "description": "Creation time of the course. Specifying this field in a course update mask results in an error. Read-only." }, "description": { "type": "string", "description": "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": { "type": "string", "description": "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": { "type": "string", "description": "Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only." }, "gradebookSettings": { "type": "object", "description": "The gradebook settings for a course. See the [help center article](https://support.google.com/edu/classroom/answer/9184995) for details.", "properties": { "calculationType": { "type": "string", "description": "Indicates how the overall grade is calculated.", "enum": [ "CALCULATION_TYPE_UNSPECIFIED", "TOTAL_POINTS", "WEIGHTED_CATEGORIES" ] }, "displaySetting": { "type": "string", "description": "Indicates who can see the overall grade..", "enum": [ "DISPLAY_SETTING_UNSPECIFIED", "SHOW_OVERALL_GRADE", "HIDE_OVERALL_GRADE", "SHOW_TEACHERS_ONLY" ] }, "gradeCategories": { "type": "array", "items": { "type": "object" }, "description": "Grade categories that are available for coursework in the course." } } }, "guardiansEnabled": { "type": "boolean", "description": "Whether or not guardian notifications are enabled for this course. Read-only." }, "levels": { "type": "string", "description": "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": { "type": "string", "description": "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": { "type": "string", "description": "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": { "type": "string", "description": "Optional room location. For example, \"301\". If set, this field must be a valid UTF-8 string and no longer than 650 characters." }, "section": { "type": "string", "description": "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": { "type": "string", "description": "Optional. The subject of the course." }, "teacherFolder": { "type": "object", "description": "Representation of a Google Drive folder.", "properties": { "id": { "type": "string", "description": "Drive API resource ID." }, "title": { "type": "string", "description": "Title of the Drive folder. Read-only." }, "alternateLink": { "type": "string", "description": "URL that can be used to access the Drive folder. Read-only." } } }, "teacherGroupEmail": { "type": "string", "description": "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": { "type": "string", "description": "Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only." } }, "required": [ "PCID", "id", "updateMask" ] } ``` *** ## 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](https://support.google.com/edu/classroom/answer/9184995) 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias." }, "id": { "type": "string", "description": "Identifier of the course work." }, "updateMask": { "type": "string", "description": "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": { "type": "string", "description": "Absolute link to this course work in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only." }, "assigneeMode": { "type": "string", "description": "Assignee mode of the coursework. If unspecified, the default value is `ALL_STUDENTS`.", "enum": [ "ASSIGNEE_MODE_UNSPECIFIED", "ALL_STUDENTS", "INDIVIDUAL_STUDENTS" ] }, "assignment": { "type": "object", "description": "Additional details for assignments.", "properties": { "studentWorkFolder": { "type": "object", "description": "Representation of a Google Drive folder." } } }, "associatedWithDeveloper": { "type": "boolean", "description": "Whether this course work item is associated with the Developer Console project making the request. See CreateCourseWork for more details. Read-only." }, "creationTime": { "type": "string", "description": "Timestamp when this course work was created. Read-only." }, "creatorUserId": { "type": "string", "description": "Identifier for the user that created the coursework. Read-only." }, "description": { "type": "string", "description": "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": { "type": "object", "description": "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", "properties": { "year": { "type": "integer", "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year." }, "month": { "type": "integer", "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day." }, "day": { "type": "integer", "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant." } } }, "dueTime": { "type": "object", "description": "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`.", "properties": { "hours": { "type": "integer", "description": "Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time." }, "minutes": { "type": "integer", "description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59." }, "seconds": { "type": "integer", "description": "Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds." }, "nanos": { "type": "integer", "description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999." } } }, "gradeCategory": { "type": "object", "description": "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](https://support.google.com/edu/classroom/answer/9184995) for details.", "properties": { "id": { "type": "string", "description": "ID of the grade category." }, "name": { "type": "string", "description": "Name of the grade category." }, "weight": { "type": "integer", "description": "The weight of the category average as part of overall average. A weight of 12.34% is represented as 123400 (100% is 1,000,000). The last two digits should always be zero since we use two decimal precision. Only applicable when grade calculation type is WEIGHTED_CATEGORIES." }, "defaultGradeDenominator": { "type": "integer", "description": "Default value of denominator. Only applicable when grade calculation type is TOTAL_POINTS." } } }, "gradingPeriodId": { "type": "string", "description": "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": { "type": "object", "description": "Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.", "properties": { "studentIds": { "type": "array", "items": { "type": "string" }, "description": "Identifiers for the students that have access to the coursework/announcement." } } }, "materials": { "type": "array", "items": { "type": "object", "properties": { "driveFile": { "type": "object", "description": "Drive file that is used as material for course work." }, "youtubeVideo": { "type": "object", "description": "YouTube video item." }, "link": { "type": "object", "description": "URL item." }, "form": { "type": "object", "description": "Google Forms item." }, "gem": { "type": "object", "description": "Gemini Gem link." }, "notebook": { "type": "object", "description": "NotebookLM Notebook link." } } }, "description": "Additional materials. CourseWork must have no more than 20 material items." }, "maxPoints": { "type": "number", "description": "Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value." }, "multipleChoiceQuestion": { "type": "object", "description": "Additional details for multiple-choice questions.", "properties": { "choices": { "type": "array", "items": { "type": "string" }, "description": "Possible choices." } } }, "scheduledTime": { "type": "string", "description": "Optional timestamp when this course work is scheduled to be published." }, "state": { "type": "string", "description": "Status of this course work. If unspecified, the default state is `DRAFT`.", "enum": [ "COURSE_WORK_STATE_UNSPECIFIED", "PUBLISHED", "DRAFT", "DELETED" ] }, "submissionModificationMode": { "type": "string", "description": "Setting to determine when students are allowed to modify submissions. If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.", "enum": [ "SUBMISSION_MODIFICATION_MODE_UNSPECIFIED", "MODIFIABLE_UNTIL_TURNED_IN", "MODIFIABLE" ] }, "title": { "type": "string", "description": "Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters." }, "topicId": { "type": "string", "description": "Identifier for the topic that this coursework is associated with. Must match an existing topic in the course." }, "updateTime": { "type": "string", "description": "Timestamp of the most recent change to this course work. Read-only." }, "workType": { "type": "string", "description": "Type of this course work. The type is set when the course work is created and cannot be changed.", "enum": [ "COURSE_WORK_TYPE_UNSPECIFIED", "ASSIGNMENT", "SHORT_ANSWER_QUESTION", "MULTIPLE_CHOICE_QUESTION" ] } }, "required": [ "PCID", "courseId", "id", "updateMask" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias." }, "id": { "type": "string", "description": "Identifier of the course work material." }, "updateMask": { "type": "string", "description": "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": { "type": "string", "description": "Absolute link to this course work material in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only." }, "assigneeMode": { "type": "string", "description": "Assignee mode of the course work material. If unspecified, the default value is `ALL_STUDENTS`.", "enum": [ "ASSIGNEE_MODE_UNSPECIFIED", "ALL_STUDENTS", "INDIVIDUAL_STUDENTS" ] }, "creationTime": { "type": "string", "description": "Timestamp when this course work material was created. Read-only." }, "creatorUserId": { "type": "string", "description": "Identifier for the user that created the course work material. Read-only." }, "description": { "type": "string", "description": "Optional description of this course work material. The text must be a valid UTF-8 string containing no more than 30,000 characters." }, "individualStudentsOptions": { "type": "object", "description": "Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.", "properties": { "studentIds": { "type": "array", "items": { "type": "string" }, "description": "Identifiers for the students that have access to the coursework/announcement." } } }, "materials": { "type": "array", "items": { "type": "object", "properties": { "driveFile": { "type": "object", "description": "Drive file that is used as material for course work." }, "youtubeVideo": { "type": "object", "description": "YouTube video item." }, "link": { "type": "object", "description": "URL item." }, "form": { "type": "object", "description": "Google Forms item." }, "gem": { "type": "object", "description": "Gemini Gem link." }, "notebook": { "type": "object", "description": "NotebookLM Notebook link." } } }, "description": "Additional materials. A course work material must have no more than 20 material items." }, "scheduledTime": { "type": "string", "description": "Optional timestamp when this course work material is scheduled to be published." }, "state": { "type": "string", "description": "Status of this course work material. If unspecified, the default state is `DRAFT`.", "enum": [ "COURSEWORK_MATERIAL_STATE_UNSPECIFIED", "PUBLISHED", "DRAFT", "DELETED" ] }, "title": { "type": "string", "description": "Title of this course work material. The title must be a valid UTF-8 string containing between 1 and 3000 characters." }, "topicId": { "type": "string", "description": "Identifier for the topic that this course work material is associated with. Must match an existing topic in the course." }, "updateTime": { "type": "string", "description": "Timestamp of the most recent change to this course work material. Read-only." } }, "required": [ "PCID", "courseId", "id", "updateMask" ] } ``` *** ## 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](https://support.google.com/edu/classroom/answer/9335069). 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "Required. Identifier of the course." }, "courseWorkId": { "type": "string", "description": "Required. Identifier of the course work." }, "id": { "type": "string", "description": "Optional. Identifier of the rubric." }, "updateMask": { "type": "string", "description": "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": { "type": "string", "description": "Output only. Timestamp when this rubric was created. Read-only." }, "criteria": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The criterion ID. On creation, an ID is assigned." }, "title": { "type": "string", "description": "The title of the criterion." }, "description": { "type": "string", "description": "The description of the criterion." }, "levels": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The level ID. On creation, an ID is assigned." }, "title": { "type": "string", "description": "The title of the level. If the level has no points set, title must be set." }, "description": { "type": "string", "description": "The description of the level." }, "points": { "type": "number", "description": "Optional points associated with this level. If set, all levels within the rubric must specify points and the value must be distinct across all levels within a single criterion. 0 is distinct from no points." } } }, "description": "The list of levels within this criterion." } } }, "description": "List of criteria. Each criterion is a dimension on which performance is rated." }, "sourceSpreadsheetId": { "type": "string", "description": "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](https://support.google.com/edu/classroom/answer/9335069). Use of this field requires the `https://www.googleapis.com/auth/spreadsheets.readonly` or `https://www.googleapis.com/auth/spreadsheets` scope." }, "updateTime": { "type": "string", "description": "Output only. Timestamp of the most recent change to this rubric. Read-only." } }, "required": [ "PCID", "courseId", "courseWorkId", "id", "updateMask" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias." }, "courseWorkId": { "type": "string", "description": "Identifier of the course work." }, "id": { "type": "string", "description": "Identifier of the student submission." }, "updateMask": { "type": "string", "description": "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": { "type": "string", "description": "Absolute link to the submission in the Classroom web UI. Read-only." }, "assignedGrade": { "type": "number", "description": "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": { "type": "object", "description": "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": { "type": "object", "description": "Student work for an assignment.", "properties": { "attachments": { "type": "array", "items": { "type": "object" }, "description": "Attachments added by the student. Drive files that correspond to materials with a share mode of STUDENT_COPY may not exist yet if the student has not accessed the assignment in Classroom. Some attachment metadata is only populated if the requesting user has permission to access it. Identifier and alternate_link fields are always available, but others (for example, title) may not be." } } }, "associatedWithDeveloper": { "type": "boolean", "description": "Whether this student submission is associated with the Developer Console project making the request. See CreateCourseWork for more details. Read-only." }, "courseWorkType": { "type": "string", "description": "Type of course work this submission is for. Read-only.", "enum": [ "COURSE_WORK_TYPE_UNSPECIFIED", "ASSIGNMENT", "SHORT_ANSWER_QUESTION", "MULTIPLE_CHOICE_QUESTION" ] }, "creationTime": { "type": "string", "description": "Creation time of this submission. This may be unset if the student has not accessed this item. Read-only." }, "draftGrade": { "type": "number", "description": "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": { "type": "object", "description": "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": { "type": "boolean", "description": "Whether this submission is late. Read-only." }, "multipleChoiceSubmission": { "type": "object", "description": "Student work for a multiple-choice question.", "properties": { "answer": { "type": "string", "description": "Student's select choice." } } }, "shortAnswerSubmission": { "type": "object", "description": "Student work for a short answer question.", "properties": { "answer": { "type": "string", "description": "Student response to a short-answer question." } } }, "state": { "type": "string", "description": "State of this submission. Read-only.", "enum": [ "SUBMISSION_STATE_UNSPECIFIED", "NEW", "CREATED", "TURNED_IN", "RETURNED", "RECLAIMED_BY_STUDENT" ] }, "submissionHistory": { "type": "array", "items": { "type": "object", "properties": { "stateHistory": { "type": "object", "description": "The history of each state this submission has been in." }, "gradeHistory": { "type": "object", "description": "The history of each grade on this submission." } } }, "description": "The history of the submission (includes state and grade histories). Read-only." }, "updateTime": { "type": "string", "description": "Last update time of this submission. This may be unset if the student has not accessed this item. Read-only." }, "userId": { "type": "string", "description": "Identifier for the student that owns this submission. Read-only." } }, "required": [ "PCID", "courseId", "courseWorkId", "id", "updateMask" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias." }, "id": { "type": "string", "description": "Identifier of the topic." }, "updateMask": { "type": "string", "description": "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": { "type": "string", "description": "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": { "type": "string", "description": "Unique identifier for the topic. Read-only." }, "updateTime": { "type": "string", "description": "The time the topic was last updated by the system. Read-only." } }, "required": [ "PCID", "courseId", "id", "updateMask", "name" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias." }, "courseWorkId": { "type": "string", "description": "Identifier of the course work." }, "id": { "type": "string", "description": "Identifier of the student submission." } }, "required": [ "PCID", "courseId", "courseWorkId", "id" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias." }, "courseWorkId": { "type": "string", "description": "Identifier of the course work." }, "id": { "type": "string", "description": "Identifier of the student submission." } }, "required": [ "PCID", "courseId", "courseWorkId", "id" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias." }, "courseWorkId": { "type": "string", "description": "Identifier of the course work." }, "id": { "type": "string", "description": "Identifier of the student submission." } }, "required": [ "PCID", "courseId", "courseWorkId", "id" ] } ``` *** ## 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](https://support.google.com/edu/classroom/answer/9184995) 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias." }, "alternateLink": { "type": "string", "description": "Absolute link to this course in the Classroom web UI. Read-only." }, "calendarId": { "type": "string", "description": "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": { "type": "string", "description": "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": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string", "description": "Title for this set." }, "materials": { "type": "array", "items": { "type": "object", "properties": { "driveFile": { "type": "object", "description": "Representation of a Google Drive file." }, "link": { "type": "object", "description": "URL item." }, "form": { "type": "object", "description": "Google Forms item." }, "youtubeVideo": { "type": "object", "description": "YouTube video item." } } }, "description": "Materials attached to this set." } } }, "description": "Sets of materials that appear on the \"about\" page of this course. Read-only." }, "courseState": { "type": "string", "description": "State of the course. If unspecified, the default state is `PROVISIONED`.", "enum": [ "COURSE_STATE_UNSPECIFIED", "ACTIVE", "ARCHIVED", "PROVISIONED", "DECLINED", "SUSPENDED" ] }, "creationTime": { "type": "string", "description": "Creation time of the course. Specifying this field in a course update mask results in an error. Read-only." }, "description": { "type": "string", "description": "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": { "type": "string", "description": "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": { "type": "string", "description": "Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only." }, "gradebookSettings": { "type": "object", "description": "The gradebook settings for a course. See the [help center article](https://support.google.com/edu/classroom/answer/9184995) for details.", "properties": { "calculationType": { "type": "string", "description": "Indicates how the overall grade is calculated.", "enum": [ "CALCULATION_TYPE_UNSPECIFIED", "TOTAL_POINTS", "WEIGHTED_CATEGORIES" ] }, "displaySetting": { "type": "string", "description": "Indicates who can see the overall grade..", "enum": [ "DISPLAY_SETTING_UNSPECIFIED", "SHOW_OVERALL_GRADE", "HIDE_OVERALL_GRADE", "SHOW_TEACHERS_ONLY" ] }, "gradeCategories": { "type": "array", "items": { "type": "object" }, "description": "Grade categories that are available for coursework in the course." } } }, "guardiansEnabled": { "type": "boolean", "description": "Whether or not guardian notifications are enabled for this course. Read-only." }, "levels": { "type": "string", "description": "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": { "type": "string", "description": "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": { "type": "string", "description": "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": { "type": "string", "description": "Optional room location. For example, \"301\". If set, this field must be a valid UTF-8 string and no longer than 650 characters." }, "section": { "type": "string", "description": "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": { "type": "string", "description": "Optional. The subject of the course." }, "teacherFolder": { "type": "object", "description": "Representation of a Google Drive folder.", "properties": { "id": { "type": "string", "description": "Drive API resource ID." }, "title": { "type": "string", "description": "Title of the Drive folder. Read-only." }, "alternateLink": { "type": "string", "description": "URL that can be used to access the Drive folder. Read-only." } } }, "teacherGroupEmail": { "type": "string", "description": "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": { "type": "string", "description": "Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only." } }, "required": [ "PCID", "id" ] } ```