{ "parameters": { "quotaUser": { "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "type": "string", "location": "query" }, "callback": { "type": "string", "location": "query", "description": "JSONP" }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "type": "string", "location": "query" }, "prettyPrint": { "type": "boolean", "default": "true", "location": "query", "description": "Returns response with indentations and line breaks." }, "alt": { "enum": [ "json", "media", "proto" ], "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "description": "Data format for response.", "type": "string", "default": "json", "location": "query" }, "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string", "location": "query" }, "$.xgafv": { "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ], "description": "V1 error format.", "type": "string", "location": "query" }, "fields": { "type": "string", "location": "query", "description": "Selector specifying which fields to include in a partial response." }, "key": { "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "type": "string", "location": "query" }, "uploadType": { "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string", "location": "query" }, "access_token": { "type": "string", "location": "query", "description": "OAuth access token." } }, "version": "v1", "ownerName": "Google", "baseUrl": "https://classroom.googleapis.com/", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/classroom.courseworkmaterials": { "description": "See, edit, and create classwork materials in Google Classroom" }, "https://www.googleapis.com/auth/classroom.courses": { "description": "See, edit, create, and permanently delete your Google Classroom classes" }, "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly": { "description": "View guardians for students in your Google Classroom classes" }, "https://www.googleapis.com/auth/classroom.student-submissions.me.readonly": { "description": "View your course work and grades in Google Classroom" }, "https://www.googleapis.com/auth/classroom.courses.readonly": { "description": "View your Google Classroom classes" }, "https://www.googleapis.com/auth/classroom.profile.emails": { "description": "View the email addresses of people in your classes" }, "https://www.googleapis.com/auth/classroom.push-notifications": { "description": "Receive notifications about your Google Classroom data" }, "https://www.googleapis.com/auth/classroom.student-submissions.students.readonly": { "description": "View course work and grades for students in the Google Classroom classes you teach or administer" }, "https://www.googleapis.com/auth/classroom.announcements": { "description": "View and manage announcements in Google Classroom" }, "https://www.googleapis.com/auth/classroom.addons.student": { "description": "See and update its own attachments to posts in Google Classroom" }, "https://www.googleapis.com/auth/classroom.coursework.me": { "description": "See, create and edit coursework items including assignments, questions, and grades" }, "https://www.googleapis.com/auth/classroom.coursework.students": { "description": "Manage course work and grades for students in the Google Classroom classes you teach and view the course work and grades for classes you administer" }, "https://www.googleapis.com/auth/classroom.topics.readonly": { "description": "View topics in Google Classroom" }, "https://www.googleapis.com/auth/classroom.profile.photos": { "description": "View the profile photos of people in your classes" }, "https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly": { "description": "View your Google Classroom guardians" }, "https://www.googleapis.com/auth/classroom.rosters.readonly": { "description": "View your Google Classroom class rosters" }, "https://www.googleapis.com/auth/classroom.guardianlinks.students": { "description": "View and manage guardians for students in your Google Classroom classes" }, "https://www.googleapis.com/auth/classroom.topics": { "description": "See, create, and edit topics in Google Classroom" }, "https://www.googleapis.com/auth/classroom.addons.teacher": { "description": "See, create, and update its own attachments to posts in classes you teach in Google Classroom" }, "https://www.googleapis.com/auth/classroom.rosters": { "description": "Manage your Google Classroom class rosters" }, "https://www.googleapis.com/auth/classroom.courseworkmaterials.readonly": { "description": "See all classwork materials for your Google Classroom classes" }, "https://www.googleapis.com/auth/classroom.announcements.readonly": { "description": "View announcements in Google Classroom" }, "https://www.googleapis.com/auth/classroom.coursework.students.readonly": { "description": "View course work and grades for students in the Google Classroom classes you teach or administer" }, "https://www.googleapis.com/auth/classroom.coursework.me.readonly": { "description": "View your course work and grades in Google Classroom" } } } }, "ownerDomain": "google.com", "fullyEncodeReservedExpansion": true, "schemas": { "Empty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "id": "Empty", "type": "object", "properties": {} }, "StudentGroupMember": { "type": "object", "properties": { "courseId": { "description": "The identifier of the course.", "type": "string" }, "studentGroupId": { "description": "The identifier of the student group.", "type": "string" }, "userId": { "description": "Identifier of the student.", "type": "string" } }, "description": "A student member in a student group.", "id": "StudentGroupMember" }, "ListStudentsResponse": { "description": "Response when listing students.", "id": "ListStudentsResponse", "type": "object", "properties": { "students": { "type": "array", "description": "Students who match the list request.", "items": { "$ref": "Student" } }, "nextPageToken": { "description": "Token identifying the next page of results to return. If empty, no further results are available.", "type": "string" } } }, "SubmissionHistory": { "type": "object", "properties": { "stateHistory": { "description": "The state history information of the submission, if present.", "$ref": "StateHistory" }, "gradeHistory": { "description": "The grade history information of the submission, if present.", "$ref": "GradeHistory" } }, "id": "SubmissionHistory", "description": "The history of the submission. This currently includes state and grade histories." }, "DriveFolder": { "type": "object", "properties": { "alternateLink": { "description": "URL that can be used to access the Drive folder. Read-only.", "type": "string" }, "title": { "description": "Title of the Drive folder. Read-only.", "type": "string" }, "id": { "description": "Drive API resource ID.", "type": "string" } }, "id": "DriveFolder", "description": "Representation of a Google Drive folder." }, "Form": { "type": "object", "properties": { "formUrl": { "description": "URL of the form.", "type": "string" }, "thumbnailUrl": { "description": "URL of a thumbnail image of the Form. Read-only.", "type": "string" }, "title": { "description": "Title of the Form. Read-only.", "type": "string" }, "responseUrl": { "description": "URL of the form responses document. Only set if responses have been recorded and only when the requesting user is an editor of the form. Read-only.", "type": "string" } }, "description": "Google Forms item.", "id": "Form" }, "TeacherContext": { "type": "object", "properties": {}, "id": "TeacherContext", "description": "Role-specific context if the requesting user is a teacher." }, "GradingPeriod": { "description": "An individual grading period. Grading periods must not have overlapping date ranges and must be listed in chronological order. For example, if the end_date of a grading period is 2024-01-25, then the start_date of the next grading period must be 2024-01-26 or later. Each grading period must have a unique title within a course.", "id": "GradingPeriod", "type": "object", "properties": { "title": { "description": "Required. Title of the grading period. For example, “Semester 1”.", "type": "string" }, "startDate": { "description": "Required. Start date, in UTC, of the grading period. Inclusive.", "$ref": "Date" }, "id": { "description": "Output only. System generated grading period ID. Read-only.", "type": "string", "readOnly": true }, "endDate": { "description": "Required. End date, in UTC, of the grading period. Inclusive.", "$ref": "Date" } } }, "GlobalPermission": { "type": "object", "properties": { "permission": { "enumDescriptions": [ "No permission is specified. This is not returned and is not a valid value.", "User is permitted to create a course." ], "enum": [ "PERMISSION_UNSPECIFIED", "CREATE_COURSE" ], "description": "Permission value.", "type": "string" } }, "description": "Global user permission description.", "id": "GlobalPermission" }, "SharedDriveFile": { "type": "object", "properties": { "shareMode": { "type": "string", "enumDescriptions": [ "No sharing mode specified. This should never be returned.", "Students can view the shared file.", "Students can edit the shared file.", "Students have a personal copy of the shared file." ], "enum": [ "UNKNOWN_SHARE_MODE", "VIEW", "EDIT", "STUDENT_COPY" ], "description": "Mechanism by which students access the Drive item." }, "driveFile": { "description": "Drive file details.", "$ref": "DriveFile" } }, "description": "Drive file that is used as material for course work.", "id": "SharedDriveFile" }, "StudentSubmission": { "type": "object", "properties": { "state": { "description": "State of this submission. Read-only.", "enumDescriptions": [ "No state specified. This should never be returned.", "The student has never accessed this submission. Attachments are not returned and timestamps is not set.", "Has been created.", "Has been turned in to the teacher.", "Has been returned to the student.", "Student chose to \"unsubmit\" the assignment." ], "enum": [ "SUBMISSION_STATE_UNSPECIFIED", "NEW", "CREATED", "TURNED_IN", "RETURNED", "RECLAIMED_BY_STUDENT" ], "type": "string" }, "creationTime": { "type": "string", "format": "google-datetime", "description": "Creation time of this submission. This may be unset if the student has not accessed this item. Read-only." }, "multipleChoiceSubmission": { "description": "Submission content when course_work_type is MULTIPLE_CHOICE_QUESTION.", "$ref": "MultipleChoiceSubmission" }, "shortAnswerSubmission": { "description": "Submission content when course_work_type is SHORT_ANSWER_QUESTION.", "$ref": "ShortAnswerSubmission" }, "assignedRubricGrades": { "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.", "additionalProperties": { "$ref": "RubricGrade" }, "type": "object" }, "userId": { "description": "Identifier for the student that owns this submission. Read-only.", "type": "string" }, "draftRubricGrades": { "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.", "additionalProperties": { "$ref": "RubricGrade" }, "type": "object" }, "courseWorkType": { "enumDescriptions": [ "No work type specified. This is never returned.", "An assignment.", "A short answer question.", "A multiple-choice question." ], "enum": [ "COURSE_WORK_TYPE_UNSPECIFIED", "ASSIGNMENT", "SHORT_ANSWER_QUESTION", "MULTIPLE_CHOICE_QUESTION" ], "description": "Type of course work this submission is for. Read-only.", "type": "string" }, "updateTime": { "type": "string", "format": "google-datetime", "description": "Last update time of this submission. This may be unset if the student has not accessed this item. Read-only." }, "submissionHistory": { "description": "The history of the submission (includes state and grade histories). Read-only.", "items": { "$ref": "SubmissionHistory" }, "type": "array" }, "courseWorkId": { "description": "Identifier for the course work this corresponds to. Read-only.", "type": "string" }, "alternateLink": { "description": "Absolute link to the submission in the Classroom web UI. Read-only.", "type": "string" }, "associatedWithDeveloper": { "description": "Whether this student submission is associated with the Developer Console project making the request. See CreateCourseWork for more details. Read-only.", "type": "boolean" }, "courseId": { "description": "Identifier of the course. Read-only.", "type": "string" }, "id": { "description": "Classroom-assigned Identifier for the student submission. This is unique among submissions for the relevant course work. Read-only.", "type": "string" }, "assignedGrade": { "type": "number", "format": "double", "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." }, "assignmentSubmission": { "description": "Submission content when course_work_type is ASSIGNMENT. Students can modify this content using ModifyAttachments.", "$ref": "AssignmentSubmission" }, "draftGrade": { "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.", "type": "number", "format": "double" }, "late": { "description": "Whether this submission is late. Read-only.", "type": "boolean" } }, "description": "Student submission for course work. `StudentSubmission` items are generated when a `CourseWork` item is created. Student submissions that have never been accessed (i.e. with `state` = NEW) may not have a creation time or update time.", "id": "StudentSubmission" }, "CourseWorkMaterial": { "description": "Course work material created by a teacher for students of the course", "id": "CourseWorkMaterial", "type": "object", "properties": { "materials": { "type": "array", "description": "Additional materials. A course work material must have no more than 20 material items.", "items": { "$ref": "Material" } }, "alternateLink": { "description": "Absolute link to this course work material in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.", "type": "string" }, "scheduledTime": { "type": "string", "format": "google-datetime", "description": "Optional timestamp when this course work material is scheduled to be published." }, "courseId": { "description": "Identifier of the course. Read-only.", "type": "string" }, "id": { "description": "Classroom-assigned identifier of this course work material, unique per course. Read-only.", "type": "string" }, "individualStudentsOptions": { "description": "Identifiers of students with access to the course work material. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field can see the course work material.", "$ref": "IndividualStudentsOptions" }, "title": { "description": "Title of this course work material. The title must be a valid UTF-8 string containing between 1 and 3000 characters.", "type": "string" }, "creationTime": { "description": "Timestamp when this course work material was created. Read-only.", "type": "string", "format": "google-datetime" }, "creatorUserId": { "description": "Identifier for the user that created the course work material. Read-only.", "type": "string" }, "state": { "type": "string", "description": "Status of this course work material. If unspecified, the default state is `DRAFT`.", "enumDescriptions": [ "No state specified. This is never returned.", "Status for course work material that has been published. This is the default state.", "Status for a course work material that is not yet published. Course work material in this state is visible only to course teachers and domain administrators.", "Status for course work material that was published but is now deleted. Course work material in this state is visible only to course teachers and domain administrators. Course work material in this state is deleted after some time." ], "enum": [ "COURSEWORK_MATERIAL_STATE_UNSPECIFIED", "PUBLISHED", "DRAFT", "DELETED" ] }, "topicId": { "description": "Identifier for the topic that this course work material is associated with. Must match an existing topic in the course.", "type": "string" }, "description": { "description": "Optional description of this course work material. The text must be a valid UTF-8 string containing no more than 30,000 characters.", "type": "string" }, "updateTime": { "type": "string", "format": "google-datetime", "description": "Timestamp of the most recent change to this course work material. Read-only." }, "assigneeMode": { "type": "string", "enumDescriptions": [ "No mode specified. This is never returned.", "All students can see the item. This is the default state.", "A subset of the students can see the item." ], "enum": [ "ASSIGNEE_MODE_UNSPECIFIED", "ALL_STUDENTS", "INDIVIDUAL_STUDENTS" ], "description": "Assignee mode of the course work material. If unspecified, the default value is `ALL_STUDENTS`." } } }, "ListCourseAliasesResponse": { "id": "ListCourseAliasesResponse", "description": "Response when listing course aliases.", "type": "object", "properties": { "nextPageToken": { "description": "Token identifying the next page of results to return. If empty, no further results are available.", "type": "string" }, "aliases": { "type": "array", "description": "The course aliases.", "items": { "$ref": "CourseAlias" } } } }, "GradeHistory": { "type": "object", "properties": { "pointsEarned": { "type": "number", "format": "double", "description": "The numerator of the grade at this time in the submission grade history." }, "maxPoints": { "type": "number", "format": "double", "description": "The denominator of the grade at this time in the submission grade history." }, "gradeTimestamp": { "type": "string", "format": "google-datetime", "description": "When the grade of the submission was changed." }, "gradeChangeType": { "description": "The type of grade change at this time in the submission grade history.", "enumDescriptions": [ "No grade change type specified. This should never be returned.", "A change in the numerator of the draft grade.", "A change in the numerator of the assigned grade.", "A change in the denominator of the grade." ], "enum": [ "UNKNOWN_GRADE_CHANGE_TYPE", "DRAFT_GRADE_POINTS_EARNED_CHANGE", "ASSIGNED_GRADE_POINTS_EARNED_CHANGE", "MAX_POINTS_CHANGE" ], "type": "string" }, "actorUserId": { "description": "The teacher who made the grade change.", "type": "string" } }, "description": "The history of each grade on this submission.", "id": "GradeHistory" }, "ListCourseWorkMaterialResponse": { "description": "Response when listing course work material.", "id": "ListCourseWorkMaterialResponse", "type": "object", "properties": { "courseWorkMaterial": { "type": "array", "description": "Course work material items that match the request.", "items": { "$ref": "CourseWorkMaterial" } }, "nextPageToken": { "description": "Token identifying the next page of results to return. If empty, no further results are available.", "type": "string" } } }, "ReclaimStudentSubmissionRequest": { "description": "Request to reclaim a student submission.", "id": "ReclaimStudentSubmissionRequest", "type": "object", "properties": {} }, "CourseRosterChangesInfo": { "type": "object", "properties": { "courseId": { "description": "The `course_id` of the course to subscribe to roster changes for.", "type": "string" } }, "id": "CourseRosterChangesInfo", "description": "Information about a `Feed` with a `feed_type` of `COURSE_ROSTER_CHANGES`." }, "ListRubricsResponse": { "type": "object", "properties": { "nextPageToken": { "description": "Token identifying the next page of results to return. If empty, no further results are available.", "type": "string" }, "rubrics": { "type": "array", "description": "Rubrics that match the request.", "items": { "$ref": "Rubric" } } }, "id": "ListRubricsResponse", "description": "Response when listing rubrics." }, "NotebookLmNotebook": { "id": "NotebookLmNotebook", "description": "NotebookLM Notebook link.", "type": "object", "properties": { "title": { "description": "Title of the Notebook.", "type": "string" }, "url": { "description": "URL that can be used to access the Notebook.", "type": "string" }, "id": { "description": "Notebook resource id.", "type": "string" } } }, "Topic": { "type": "object", "properties": { "courseId": { "description": "Identifier of the course. Read-only.", "type": "string" }, "name": { "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.", "type": "string" }, "updateTime": { "description": "The time the topic was last updated by the system. Read-only.", "type": "string", "format": "google-datetime" }, "topicId": { "description": "Unique identifier for the topic. Read-only.", "type": "string" } }, "id": "Topic", "description": "Topic created by a teacher for the course" }, "MultipleChoiceSubmission": { "description": "Student work for a multiple-choice question.", "id": "MultipleChoiceSubmission", "type": "object", "properties": { "answer": { "description": "Student's select choice.", "type": "string" } } }, "ListTopicResponse": { "description": "Response when listing topics.", "id": "ListTopicResponse", "type": "object", "properties": { "topic": { "type": "array", "description": "Topic items that match the request.", "items": { "$ref": "Topic" } }, "nextPageToken": { "description": "Token identifying the next page of results to return. If empty, no further results are available.", "type": "string" } } }, "Student": { "description": "Student in a course.", "id": "Student", "type": "object", "properties": { "courseId": { "description": "Identifier of the course. Read-only.", "type": "string" }, "studentWorkFolder": { "description": "Information about a Drive Folder for this student's work in this course. Only visible to the student and domain administrators. Read-only.", "$ref": "DriveFolder" }, "userId": { "description": "Identifier of the user. When specified as a parameter of a request, this 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", "type": "string" }, "profile": { "description": "Global user information for the student. Read-only.", "$ref": "UserProfile" } } }, "GradingPeriodSettings": { "type": "object", "properties": { "gradingPeriods": { "description": "The list of grading periods in a specific course. Grading periods must not have overlapping date ranges and must be listed in chronological order. Each grading period must have a unique title within a course.", "items": { "$ref": "GradingPeriod" }, "type": "array" }, "applyToExistingCoursework": { "description": "Supports toggling the application of grading periods on existing stream items. Once set, this value is persisted meaning that it does not need to be set in every request to update `GradingPeriodSettings`. If not previously set, the default is False.", "type": "boolean" } }, "description": "Grading period settings that include all the individual grading periods in a course.", "id": "GradingPeriodSettings" }, "ListAnnouncementsResponse": { "description": "Response when listing course work.", "id": "ListAnnouncementsResponse", "type": "object", "properties": { "announcements": { "description": "Announcement items that match the request.", "items": { "$ref": "Announcement" }, "type": "array" }, "nextPageToken": { "description": "Token identifying the next page of results to return. If empty, no further results are available.", "type": "string" } } }, "GuardianInvitation": { "type": "object", "properties": { "invitationId": { "description": "Unique identifier for this invitation. Read-only.", "type": "string" }, "state": { "type": "string", "enumDescriptions": [ "Should never be returned.", "The invitation is active and awaiting a response.", "The invitation is no longer active. It may have been accepted, declined, withdrawn or it may have expired." ], "enum": [ "GUARDIAN_INVITATION_STATE_UNSPECIFIED", "PENDING", "COMPLETE" ], "description": "The state that this invitation is in." }, "creationTime": { "description": "The time that this invitation was created. Read-only.", "type": "string", "format": "google-datetime" }, "studentId": { "description": "ID of the student (in standard format)", "type": "string" }, "invitedEmailAddress": { "description": "Email address that the invitation was sent to. This field is only visible to domain administrators.", "type": "string" } }, "description": "An invitation to become the guardian of a specified user, sent to a specified email address.", "id": "GuardianInvitation" }, "Material": { "type": "object", "properties": { "notebook": { "description": "NotebookLM Notebook material. Read-only.", "$ref": "NotebookLmNotebook" }, "gem": { "description": "Gemini Gem material. Read-only.", "$ref": "GeminiGem" }, "youtubeVideo": { "description": "YouTube video material.", "$ref": "YouTubeVideo" }, "driveFile": { "description": "Google Drive file material.", "$ref": "SharedDriveFile" }, "link": { "description": "Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response.", "$ref": "Link" }, "form": { "description": "Google Forms material. Read-only.", "$ref": "Form" } }, "id": "Material", "description": "Material attached to course work. When creating attachments, setting the `form`, `gem`, or `notebook` field is not supported." }, "ListCourseWorkResponse": { "id": "ListCourseWorkResponse", "description": "Response when listing course work.", "type": "object", "properties": { "nextPageToken": { "description": "Token identifying the next page of results to return. If empty, no further results are available.", "type": "string" }, "courseWork": { "type": "array", "description": "Course work items that match the request.", "items": { "$ref": "CourseWork" } } } }, "Announcement": { "description": "Announcement created by a teacher for students of the course", "id": "Announcement", "type": "object", "properties": { "courseId": { "description": "Identifier of the course. Read-only.", "type": "string" }, "id": { "description": "Classroom-assigned identifier of this announcement, unique per course. Read-only.", "type": "string" }, "updateTime": { "description": "Timestamp of the most recent change to this announcement. Read-only.", "type": "string", "format": "google-datetime" }, "assigneeMode": { "type": "string", "description": "Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.", "enumDescriptions": [ "No mode specified. This is never returned.", "All students can see the item. This is the default state.", "A subset of the students can see the item." ], "enum": [ "ASSIGNEE_MODE_UNSPECIFIED", "ALL_STUDENTS", "INDIVIDUAL_STUDENTS" ] }, "individualStudentsOptions": { "description": "Identifiers of students with access to the announcement. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field can see the announcement.", "$ref": "IndividualStudentsOptions" }, "materials": { "type": "array", "description": "Additional materials. Announcements must have no more than 20 material items.", "items": { "$ref": "Material" } }, "state": { "description": "Status of this announcement. If unspecified, the default state is `DRAFT`.", "enumDescriptions": [ "No state specified. This is never returned.", "Status for announcement that has been published. This is the default state.", "Status for an announcement that is not yet published. Announcement in this state is visible only to course teachers and domain administrators.", "Status for announcement that was published but is now deleted. Announcement in this state is visible only to course teachers and domain administrators. Announcement in this state is deleted after some time." ], "enum": [ "ANNOUNCEMENT_STATE_UNSPECIFIED", "PUBLISHED", "DRAFT", "DELETED" ], "type": "string" }, "creationTime": { "type": "string", "format": "google-datetime", "description": "Timestamp when this announcement was created. Read-only." }, "creatorUserId": { "description": "Identifier for the user that created the announcement. Read-only.", "type": "string" }, "text": { "description": "Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters.", "type": "string" }, "scheduledTime": { "description": "Optional timestamp when this announcement is scheduled to be published.", "type": "string", "format": "google-datetime" }, "alternateLink": { "description": "Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.", "type": "string" } } }, "ListCoursesResponse": { "type": "object", "properties": { "courses": { "description": "Courses that match the list request.", "items": { "$ref": "Course" }, "type": "array" }, "nextPageToken": { "description": "Token identifying the next page of results to return. If empty, no further results are available.", "type": "string" } }, "description": "Response when listing courses.", "id": "ListCoursesResponse" }, "ListStudentGroupMembersResponse": { "id": "ListStudentGroupMembersResponse", "description": "Response when listing students in a group.", "type": "object", "properties": { "studentGroupMembers": { "description": "The student group members.", "items": { "$ref": "StudentGroupMember" }, "type": "array" }, "nextPageToken": { "description": "Token identifying the next page of results to return. If empty, no further results are available.", "type": "string" } } }, "Registration": { "description": "An instruction to Classroom to send notifications from the `feed` to the provided destination.", "id": "Registration", "type": "object", "properties": { "registrationId": { "description": "A server-generated unique identifier for this `Registration`. Read-only.", "type": "string" }, "expiryTime": { "description": "The time until which the `Registration` is effective. This is a read-only field assigned by the server.", "type": "string", "format": "google-datetime" }, "cloudPubsubTopic": { "description": "The Cloud Pub/Sub topic that notifications are to be sent to.", "$ref": "CloudPubsubTopic" }, "feed": { "description": "Specification for the class of notifications that Classroom should deliver to the destination.", "$ref": "Feed" } } }, "ModifyAttachmentsRequest": { "type": "object", "properties": { "addAttachments": { "type": "array", "description": "Attachments to add. A student submission may not have more than 20 attachments. Form attachments are not supported.", "items": { "$ref": "Attachment" } } }, "description": "Request to modify the attachments of a student submission.", "id": "ModifyAttachmentsRequest" }, "ListGuardianInvitationsResponse": { "type": "object", "properties": { "guardianInvitations": { "description": "Guardian invitations that matched the list request.", "items": { "$ref": "GuardianInvitation" }, "type": "array" }, "nextPageToken": { "description": "Token identifying the next page of results to return. If empty, no further results are available.", "type": "string" } }, "description": "Response when listing guardian invitations.", "id": "ListGuardianInvitationsResponse" }, "Course": { "description": "A Course in Classroom.", "id": "Course", "type": "object", "properties": { "creationTime": { "description": "Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.", "type": "string", "format": "google-datetime" }, "courseGroupEmail": { "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.", "type": "string" }, "guardiansEnabled": { "description": "Whether or not guardian notifications are enabled for this course. Read-only.", "type": "boolean" }, "descriptionHeading": { "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.", "type": "string" }, "ownerId": { "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.", "type": "string" }, "description": { "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.", "type": "string" }, "name": { "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.", "type": "string" }, "section": { "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.", "type": "string" }, "updateTime": { "type": "string", "format": "google-datetime", "description": "Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only." }, "teacherGroupEmail": { "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.", "type": "string" }, "calendarId": { "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.", "type": "string" }, "gradebookSettings": { "description": "The gradebook settings that specify how a student's overall grade for the course will be calculated and who it will be displayed to. Read-only.", "$ref": "GradebookSettings" }, "courseState": { "enumDescriptions": [ "No course state. No returned Course message will use this value.", "The course is active.", "The course has been archived. You cannot modify it except to change it to a different state.", "The course has been created, but not yet activated. It is accessible by the primary teacher and domain administrators, who may modify it or change it to the `ACTIVE` or `DECLINED` states. A course may only be changed to `PROVISIONED` if it is in the `DECLINED` state.", "The course has been created, but declined. It is accessible by the course owner and domain administrators, though it will not be displayed in the web UI. You cannot modify the course except to change it to the `PROVISIONED` state. A course may only be changed to `DECLINED` if it is in the `PROVISIONED` state.", "The course has been suspended. You cannot modify the course, and only the user identified by the `owner_id` can view the course. A course may be placed in this state if it potentially violates the Terms of Service." ], "enum": [ "COURSE_STATE_UNSPECIFIED", "ACTIVE", "ARCHIVED", "PROVISIONED", "DECLINED", "SUSPENDED" ], "description": "State of the course. If unspecified, the default state is `PROVISIONED`.", "type": "string" }, "subject": { "description": "Optional. The subject of the course.", "type": "string" }, "alternateLink": { "description": "Absolute link to this course in the Classroom web UI. Read-only.", "type": "string" }, "room": { "description": "Optional room location. For example, \"301\". If set, this field must be a valid UTF-8 string and no longer than 650 characters.", "type": "string" }, "teacherFolder": { "description": "Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only.", "$ref": "DriveFolder" }, "id": { "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.", "type": "string" }, "enrollmentCode": { "description": "Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.", "type": "string" }, "courseMaterialSets": { "deprecated": true, "description": "Sets of materials that appear on the \"about\" page of this course. Read-only.", "items": { "$ref": "CourseMaterialSet" }, "type": "array" } } }, "ListTeachersResponse": { "type": "object", "properties": { "teachers": { "type": "array", "description": "Teachers who match the list request.", "items": { "$ref": "Teacher" } }, "nextPageToken": { "description": "Token identifying the next page of results to return. If empty, no further results are available.", "type": "string" } }, "id": "ListTeachersResponse", "description": "Response when listing teachers." }, "Guardian": { "id": "Guardian", "description": "Association between a student and a guardian of that student. The guardian may receive information about the student's course work.", "type": "object", "properties": { "guardianId": { "description": "Identifier for the guardian.", "type": "string" }, "studentId": { "description": "Identifier for the student to whom the guardian relationship applies.", "type": "string" }, "guardianProfile": { "description": "User profile for the guardian.", "$ref": "UserProfile" }, "invitedEmailAddress": { "description": "The email address to which the initial guardian invitation was sent. This field is only visible to domain administrators.", "type": "string" } } }, "CourseMaterialSet": { "type": "object", "properties": { "title": { "description": "Title for this set.", "type": "string" }, "materials": { "description": "Materials attached to this set.", "items": { "$ref": "CourseMaterial" }, "type": "array" } }, "description": "A set of materials that appears on the \"About\" page of the course. These materials might include a syllabus, schedule, or other background information relating to the course as a whole.", "id": "CourseMaterialSet" }, "EmbedUri": { "id": "EmbedUri", "description": "URI to be iframed after being populated with query parameters.", "type": "object", "properties": { "uri": { "description": "Required. URI to be iframed after being populated with query parameters. This must be a valid UTF-8 string containing between 1 and 1800 characters.", "type": "string" } } }, "YouTubeVideo": { "id": "YouTubeVideo", "description": "YouTube video item.", "type": "object", "properties": { "thumbnailUrl": { "description": "URL of a thumbnail image of the YouTube video. Read-only.", "type": "string" }, "id": { "description": "YouTube API resource ID.", "type": "string" }, "alternateLink": { "description": "URL that can be used to view the YouTube video. Read-only.", "type": "string" }, "title": { "description": "Title of the YouTube video. Read-only.", "type": "string" } } }, "ShortAnswerSubmission": { "type": "object", "properties": { "answer": { "description": "Student response to a short-answer question.", "type": "string" } }, "description": "Student work for a short answer question.", "id": "ShortAnswerSubmission" }, "MultipleChoiceQuestion": { "description": "Additional details for multiple-choice questions.", "id": "MultipleChoiceQuestion", "type": "object", "properties": { "choices": { "description": "Possible choices.", "items": { "type": "string" }, "type": "array" } } }, "StateHistory": { "type": "object", "properties": { "state": { "enumDescriptions": [ "No state specified. This should never be returned.", "The Submission has been created.", "The student has turned in an assigned document, which may or may not be a template.", "The teacher has returned the assigned document to the student.", "The student turned in the assigned document, and then chose to \"unsubmit\" the assignment, giving the student control again as the owner.", "The student edited their submission after turning it in. Currently, only used by Questions, when the student edits their answer." ], "enum": [ "STATE_UNSPECIFIED", "CREATED", "TURNED_IN", "RETURNED", "RECLAIMED_BY_STUDENT", "STUDENT_EDITED_AFTER_TURN_IN" ], "description": "The workflow pipeline stage.", "type": "string" }, "stateTimestamp": { "description": "When the submission entered this state.", "type": "string", "format": "google-datetime" }, "actorUserId": { "description": "The teacher or student who made the change.", "type": "string" } }, "description": "The history of each state this submission has been in.", "id": "StateHistory" }, "AddOnAttachment": { "type": "object", "properties": { "dueDate": { "description": "Date, in UTC, that work on this attachment is due. This must be specified if `due_time` is specified.", "$ref": "Date" }, "courseId": { "description": "Immutable. Identifier of the course.", "type": "string" }, "id": { "description": "Immutable. Classroom-assigned identifier for this attachment, unique per post.", "type": "string" }, "title": { "description": "Required. Title of this attachment. The title must be between 1 and 1000 characters.", "type": "string" }, "copyHistory": { "readOnly": true, "type": "array", "description": "Output only. Identifiers of attachments that were previous copies of this attachment. If the attachment was previously copied by virtue of its parent post being copied, this enumerates the identifiers of attachments that were its previous copies in ascending chronological order of copy.", "items": { "$ref": "CopyHistory" } }, "postId": { "deprecated": true, "description": "Immutable. Deprecated, use `item_id` instead.", "type": "string" }, "teacherViewUri": { "description": "Required. URI to show the teacher view of the attachment. The URI will be opened in an iframe with the `courseId`, `itemId`, `itemType`, and `attachmentId` query parameters set.", "$ref": "EmbedUri" }, "studentWorkReviewUri": { "description": "URI for the teacher to see student work on the attachment, if applicable. The URI will be opened in an iframe with the `courseId`, `itemId`, `itemType`, `attachmentId`, and `submissionId` query parameters set. This is the same `submissionId` returned in the [`AddOnContext.studentContext`](//devsite.google.com/classroom/reference/rest/v1/AddOnContext#StudentContext) field when a student views the attachment. If the URI is omitted or removed, `max_points` will also be discarded.", "$ref": "EmbedUri" }, "itemId": { "description": "Immutable. Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. Unique per course.", "type": "string" }, "studentViewUri": { "description": "Required. URI to show the student view of the attachment. The URI will be opened in an iframe with the `courseId`, `itemId`, `itemType`, and `attachmentId` query parameters set.", "$ref": "EmbedUri" }, "dueTime": { "description": "Time of day, in UTC, that work on this attachment is due. This must be specified if `due_date` is specified.", "$ref": "TimeOfDay" }, "maxPoints": { "type": "number", "format": "double", "description": "Maximum grade for this attachment. Can only be set if `studentWorkReviewUri` is set. Set to a non-zero value to indicate that the attachment supports grade passback. If set, this must be a non-negative integer value. When set to zero, the attachment will not support grade passback." } }, "description": "An add-on attachment on a post.", "id": "AddOnAttachment" }, "Feed": { "id": "Feed", "description": "A class of notifications that an application can register to receive. For example: \"all roster changes for a domain\".", "type": "object", "properties": { "courseWorkChangesInfo": { "description": "Information about a `Feed` with a `feed_type` of `COURSE_WORK_CHANGES`. This field must be specified if `feed_type` is `COURSE_WORK_CHANGES`.", "$ref": "CourseWorkChangesInfo" }, "feedType": { "type": "string", "enumDescriptions": [ "Should never be returned or provided.", "All roster changes for a particular domain. Notifications will be generated whenever a user joins or leaves a course. No notifications will be generated when an invitation is created or deleted, but notifications will be generated when a user joins a course by accepting an invitation.", "All roster changes for a particular course. Notifications will be generated whenever a user joins or leaves a course. No notifications will be generated when an invitation is created or deleted, but notifications will be generated when a user joins a course by accepting an invitation.", "All course work activity for a particular course. Notifications will be generated when a CourseWork or StudentSubmission object is created or modified. No notification will be generated when a StudentSubmission object is created in connection with the creation or modification of its parent CourseWork object (but a notification will be generated for that CourseWork object's creation or modification)." ], "enum": [ "FEED_TYPE_UNSPECIFIED", "DOMAIN_ROSTER_CHANGES", "COURSE_ROSTER_CHANGES", "COURSE_WORK_CHANGES" ], "description": "The type of feed." }, "courseRosterChangesInfo": { "description": "Information about a `Feed` with a `feed_type` of `COURSE_ROSTER_CHANGES`. This field must be specified if `feed_type` is `COURSE_ROSTER_CHANGES`.", "$ref": "CourseRosterChangesInfo" } } }, "ModifyAnnouncementAssigneesRequest": { "description": "Request to modify assignee mode and options of an announcement.", "id": "ModifyAnnouncementAssigneesRequest", "type": "object", "properties": { "modifyIndividualStudentsOptions": { "description": "Set which students can view or cannot view the announcement. Must be specified only when `assigneeMode` is `INDIVIDUAL_STUDENTS`.", "$ref": "ModifyIndividualStudentsOptions" }, "assigneeMode": { "description": "Mode of the announcement describing whether it is accessible by all students or specified individual students.", "enumDescriptions": [ "No mode specified. This is never returned.", "All students can see the item. This is the default state.", "A subset of the students can see the item." ], "enum": [ "ASSIGNEE_MODE_UNSPECIFIED", "ALL_STUDENTS", "INDIVIDUAL_STUDENTS" ], "type": "string" } } }, "AddOnAttachmentStudentSubmission": { "id": "AddOnAttachmentStudentSubmission", "description": "Payload for grade update requests.", "type": "object", "properties": { "pointsEarned": { "description": "Student grade on this attachment. If unset, no grade was set.", "type": "number", "format": "double" }, "userId": { "description": "Identifier for the student that owns this submission. Requires the user to be a teacher in the course and have permission to read student submissions. Read-only.", "type": "string" }, "postSubmissionState": { "type": "string", "description": "Submission state of add-on attachment's parent post (i.e. assignment).", "enumDescriptions": [ "No state specified. This should never be returned.", "The student has never accessed this submission. Attachments are not returned and timestamps is not set.", "Has been created.", "Has been turned in to the teacher.", "Has been returned to the student.", "Student chose to \"unsubmit\" the assignment." ], "enum": [ "SUBMISSION_STATE_UNSPECIFIED", "NEW", "CREATED", "TURNED_IN", "RETURNED", "RECLAIMED_BY_STUDENT" ] } } }, "CourseMaterial": { "description": "A material attached to a course as part of a material set.", "id": "CourseMaterial", "type": "object", "properties": { "link": { "description": "Link atatchment.", "$ref": "Link" }, "form": { "description": "Google Forms attachment.", "$ref": "Form" }, "driveFile": { "description": "Google Drive file attachment.", "$ref": "DriveFile" }, "youTubeVideo": { "description": "Youtube video attachment.", "$ref": "YouTubeVideo" } } }, "CourseWorkChangesInfo": { "id": "CourseWorkChangesInfo", "description": "Information about a `Feed` with a `feed_type` of `COURSE_WORK_CHANGES`.", "type": "object", "properties": { "courseId": { "description": "The `course_id` of the course to subscribe to work changes for.", "type": "string" } } }, "ListInvitationsResponse": { "description": "Response when listing invitations.", "id": "ListInvitationsResponse", "type": "object", "properties": { "nextPageToken": { "description": "Token identifying the next page of results to return. If empty, no further results are available.", "type": "string" }, "invitations": { "description": "Invitations that match the list request.", "items": { "$ref": "Invitation" }, "type": "array" } } }, "AssignmentSubmission": { "type": "object", "properties": { "attachments": { "type": "array", "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.", "items": { "$ref": "Attachment" } } }, "description": "Student work for an assignment.", "id": "AssignmentSubmission" }, "CourseAlias": { "description": "Alternative identifier for a course. An alias uniquely identifies a course. It must be unique within one of the following scopes: * domain: A domain-scoped alias is visible to all users within the alias creator's domain and can be created only by a domain admin. A domain-scoped alias is often used when a course has an identifier external to Classroom. * project: A project-scoped alias is visible to any request from an application using the Developer Console project ID that created the alias and can be created by any project. A project-scoped alias is often used when an application has alternative identifiers. A random value can also be used to avoid duplicate courses in the event of transmission failures, as retrying a request will return `ALREADY_EXISTS` if a previous one has succeeded.", "id": "CourseAlias", "type": "object", "properties": { "alias": { "description": "Alias string. The format of the string indicates the desired alias scoping. * `d:` indicates a domain-scoped alias. Example: `d:math_101` * `p:` indicates a project-scoped alias. Example: `p:abc123` This field has a maximum length of 256 characters.", "type": "string" } } }, "ModifyCourseWorkAssigneesRequest": { "description": "Request to modify assignee mode and options of a coursework.", "id": "ModifyCourseWorkAssigneesRequest", "type": "object", "properties": { "assigneeMode": { "description": "Mode of the coursework describing whether it will be assigned to all students or specified individual students.", "enumDescriptions": [ "No mode specified. This is never returned.", "All students can see the item. This is the default state.", "A subset of the students can see the item." ], "enum": [ "ASSIGNEE_MODE_UNSPECIFIED", "ALL_STUDENTS", "INDIVIDUAL_STUDENTS" ], "type": "string" }, "modifyIndividualStudentsOptions": { "description": "Set which students are assigned or not assigned to the coursework. Must be specified only when `assigneeMode` is `INDIVIDUAL_STUDENTS`.", "$ref": "ModifyIndividualStudentsOptions" } } }, "StudentGroup": { "description": "A student group in a course.", "id": "StudentGroup", "type": "object", "properties": { "title": { "description": "The title of the student group.", "type": "string" }, "courseId": { "description": "The identifier of the course.", "type": "string" }, "id": { "description": "The identifier of the student group.", "type": "string" } } }, "RubricGrade": { "description": "A rubric grade set for the student submission. There is at most one entry per rubric criterion.", "id": "RubricGrade", "type": "object", "properties": { "criterionId": { "description": "Optional. Criterion ID.", "type": "string" }, "points": { "type": "number", "format": "double", "description": "Optional. Optional points assigned for this criterion, typically based on the level. Levels might or might not have points. If unset, no points were set for this criterion." }, "levelId": { "description": "Optional. Optional level ID of the selected level. If empty, no level was selected.", "type": "string" } } }, "ListAddOnAttachmentsResponse": { "type": "object", "properties": { "addOnAttachments": { "description": "Attachments under the given post.", "items": { "$ref": "AddOnAttachment" }, "type": "array" }, "nextPageToken": { "description": "A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "id": "ListAddOnAttachmentsResponse", "description": "Response when listing add-on attachments." }, "UserProfile": { "description": "Global information for a user.", "id": "UserProfile", "type": "object", "properties": { "verifiedTeacher": { "description": "Represents whether a Google Workspace for Education user's domain administrator has explicitly verified them as being a teacher. This field is always false if the user is not a member of a Google Workspace for Education domain. Read-only", "type": "boolean" }, "photoUrl": { "description": "URL of user's profile photo. Must request `https://www.googleapis.com/auth/classroom.profile.photos` scope for this field to be populated in a response body. Read-only.", "type": "string" }, "emailAddress": { "description": "Email address of the user. Must request `https://www.googleapis.com/auth/classroom.profile.emails` scope for this field to be populated in a response body. Read-only.", "type": "string" }, "id": { "description": "Identifier of the user. Read-only.", "type": "string" }, "name": { "description": "Name of the user. Read-only.", "$ref": "Name" }, "permissions": { "type": "array", "description": "Global permissions of the user. Read-only.", "items": { "$ref": "GlobalPermission" } } } }, "DriveFile": { "type": "object", "properties": { "title": { "description": "Title of the Drive item. Read-only.", "type": "string" }, "alternateLink": { "description": "URL that can be used to access the Drive item. Read-only.", "type": "string" }, "id": { "description": "Drive API resource ID.", "type": "string" }, "thumbnailUrl": { "description": "URL of a thumbnail image of the Drive item. Read-only.", "type": "string" } }, "description": "Representation of a Google Drive file.", "id": "DriveFile" }, "CopyHistory": { "type": "object", "properties": { "postId": { "deprecated": true, "description": "Immutable. Deprecated, use `item_id` instead.", "type": "string" }, "itemId": { "description": "Immutable. Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached.", "type": "string" }, "attachmentId": { "description": "Immutable. Identifier of the attachment.", "type": "string" }, "courseId": { "description": "Immutable. Identifier of the course.", "type": "string" } }, "id": "CopyHistory", "description": "Identifier of a previous copy of a given attachment." }, "ListStudentSubmissionsResponse": { "type": "object", "properties": { "studentSubmissions": { "type": "array", "description": "Student work that matches the request.", "items": { "$ref": "StudentSubmission" } }, "nextPageToken": { "description": "Token identifying the next page of results to return. If empty, no further results are available.", "type": "string" } }, "description": "Response when listing student submissions.", "id": "ListStudentSubmissionsResponse" }, "ModifyIndividualStudentsOptions": { "description": "Contains fields to add or remove students from a course work or announcement where the `assigneeMode` is set to `INDIVIDUAL_STUDENTS`.", "id": "ModifyIndividualStudentsOptions", "type": "object", "properties": { "addStudentIds": { "description": "IDs of students to be added as having access to this coursework/announcement.", "items": { "type": "string" }, "type": "array" }, "removeStudentIds": { "description": "IDs of students to be removed from having access to this coursework/announcement.", "items": { "type": "string" }, "type": "array" } } }, "TurnInStudentSubmissionRequest": { "description": "Request to turn in a student submission.", "id": "TurnInStudentSubmissionRequest", "type": "object", "properties": {} }, "Name": { "id": "Name", "description": "Details of the user's name.", "type": "object", "properties": { "givenName": { "description": "The user's first name. Read-only.", "type": "string" }, "fullName": { "description": "The user's full name formed by concatenating the first and last name values. Read-only.", "type": "string" }, "familyName": { "description": "The user's last name. Read-only.", "type": "string" } } }, "StudentContext": { "description": "Role-specific context if the requesting user is a student.", "id": "StudentContext", "type": "object", "properties": { "submissionId": { "description": "Requesting user's submission id to be used for grade passback and to identify the student when showing student work to the teacher. This is set exactly when `supportsStudentWork` is `true`.", "type": "string" } } }, "Link": { "id": "Link", "description": "URL item.", "type": "object", "properties": { "url": { "description": "URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.", "type": "string" }, "thumbnailUrl": { "description": "URL of a thumbnail image of the target URL. Read-only.", "type": "string" }, "title": { "description": "Title of the target of the URL. Read-only.", "type": "string" } } }, "CloudPubsubTopic": { "id": "CloudPubsubTopic", "description": "A reference to a Cloud Pub/Sub topic. To register for notifications, the owner of the topic must grant `classroom-notifications@system.gserviceaccount.com` the `projects.topics.publish` permission.", "type": "object", "properties": { "topicName": { "description": "The `name` field of a Cloud Pub/Sub [Topic](https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic).", "type": "string" } } }, "Attachment": { "description": "Attachment added to student assignment work. When creating attachments, setting the `form` field is not supported.", "id": "Attachment", "type": "object", "properties": { "driveFile": { "description": "Google Drive file attachment.", "$ref": "DriveFile" }, "youTubeVideo": { "description": "Youtube video attachment.", "$ref": "YouTubeVideo" }, "link": { "description": "Link attachment.", "$ref": "Link" }, "form": { "description": "Google Forms attachment.", "$ref": "Form" } } }, "ListStudentGroupsResponse": { "type": "object", "properties": { "studentGroups": { "description": "The student groups.", "items": { "$ref": "StudentGroup" }, "type": "array" }, "nextPageToken": { "description": "Token identifying the next page of results to return. If empty, no further results are available.", "type": "string" } }, "description": "Response when listing student groups.", "id": "ListStudentGroupsResponse" }, "Criterion": { "type": "object", "properties": { "title": { "description": "The title of the criterion.", "type": "string" }, "id": { "description": "The criterion ID. On creation, an ID is assigned.", "type": "string" }, "description": { "description": "The description of the criterion.", "type": "string" }, "levels": { "description": "The list of levels within this criterion.", "items": { "$ref": "Level" }, "type": "array" } }, "description": "A rubric criterion. Each criterion is a dimension on which performance is rated.", "id": "Criterion" }, "ReturnStudentSubmissionRequest": { "type": "object", "properties": {}, "id": "ReturnStudentSubmissionRequest", "description": "Request to return a student submission." }, "ListGuardiansResponse": { "type": "object", "properties": { "guardians": { "type": "array", "description": "Guardians on this page of results that met the criteria specified in the request.", "items": { "$ref": "Guardian" } }, "nextPageToken": { "description": "Token identifying the next page of results to return. If empty, no further results are available.", "type": "string" } }, "description": "Response when listing guardians.", "id": "ListGuardiansResponse" }, "GradeCategory": { "id": "GradeCategory", "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.", "type": "object", "properties": { "defaultGradeDenominator": { "type": "integer", "format": "int32", "description": "Default value of denominator. Only applicable when grade calculation type is TOTAL_POINTS." }, "id": { "description": "ID of the grade category.", "type": "string" }, "name": { "description": "Name of the grade category.", "type": "string" }, "weight": { "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.", "type": "integer", "format": "int32" } } }, "IndividualStudentsOptions": { "type": "object", "properties": { "studentIds": { "type": "array", "description": "Identifiers for the students that have access to the coursework/announcement.", "items": { "type": "string" } } }, "description": "Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.", "id": "IndividualStudentsOptions" }, "Level": { "description": "A level of the criterion.", "id": "Level", "type": "object", "properties": { "title": { "description": "The title of the level. If the level has no points set, title must be set.", "type": "string" }, "id": { "description": "The level ID. On creation, an ID is assigned.", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "points": { "type": "number", "format": "double", "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." } } }, "AddOnContext": { "type": "object", "properties": { "itemId": { "description": "Immutable. Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached.", "type": "string" }, "supportsStudentWork": { "description": "Optional. Whether the post allows the teacher to see student work and passback grades.", "type": "boolean" }, "teacherContext": { "description": "Add-on context corresponding to the requesting user's role as a teacher. Its presence implies that the requesting user is a teacher in the course.", "$ref": "TeacherContext" }, "postId": { "deprecated": true, "description": "Immutable. Deprecated, use `item_id` instead.", "type": "string" }, "courseId": { "description": "Immutable. Identifier of the course.", "type": "string" }, "studentContext": { "description": "Add-on context corresponding to the requesting user's role as a student. Its presence implies that the requesting user is a student in the course.", "$ref": "StudentContext" } }, "description": "Attachment-relevant metadata for Classroom add-ons in the context of a specific post.", "id": "AddOnContext" }, "Invitation": { "type": "object", "properties": { "userId": { "description": "Identifier of the invited user. When specified as a parameter of a request, this identifier can be set to one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user", "type": "string" }, "role": { "type": "string", "description": "Role to invite the user to have. Must not be `COURSE_ROLE_UNSPECIFIED`.", "enumDescriptions": [ "No course role.", "Student in the course.", "Teacher of the course.", "Owner of the course." ], "enum": [ "COURSE_ROLE_UNSPECIFIED", "STUDENT", "TEACHER", "OWNER" ] }, "id": { "description": "Identifier assigned by Classroom. Read-only.", "type": "string" }, "courseId": { "description": "Identifier of the course to invite the user to.", "type": "string" } }, "description": "An invitation to join a course.", "id": "Invitation" }, "Assignment": { "type": "object", "properties": { "studentWorkFolder": { "description": "Drive folder where attachments from student submissions are placed. This is only populated for course teachers and administrators.", "$ref": "DriveFolder" } }, "description": "Additional details for assignments.", "id": "Assignment" }, "GradebookSettings": { "id": "GradebookSettings", "description": "The gradebook settings for a course. See the [help center article](https://support.google.com/edu/classroom/answer/9184995) for details.", "type": "object", "properties": { "gradeCategories": { "description": "Grade categories that are available for coursework in the course.", "items": { "$ref": "GradeCategory" }, "type": "array" }, "calculationType": { "description": "Indicates how the overall grade is calculated.", "enumDescriptions": [ "No method specified. This is never returned.", "Overall grade is the sum of grades divided by the sum of total points regardless of category.", "Overall grade is the weighted average by category." ], "enum": [ "CALCULATION_TYPE_UNSPECIFIED", "TOTAL_POINTS", "WEIGHTED_CATEGORIES" ], "type": "string" }, "displaySetting": { "enumDescriptions": [ "No setting specified. This is never returned.", "Shows overall grade in the gradebook and student profile to both teachers and students.", "Does not show overall grade in the gradebook or student profile.", "Shows the overall grade to teachers in the gradebook and student profile. Hides from students in their student profile." ], "enum": [ "DISPLAY_SETTING_UNSPECIFIED", "SHOW_OVERALL_GRADE", "HIDE_OVERALL_GRADE", "SHOW_TEACHERS_ONLY" ], "description": "Indicates who can see the overall grade..", "type": "string" } } }, "GeminiGem": { "type": "object", "properties": { "url": { "description": "URL that can be used to access the Gem.", "type": "string" }, "id": { "description": "Gems resource id.", "type": "string" }, "title": { "description": "Title of the Gem.", "type": "string" } }, "description": "Gemini Gem link.", "id": "GeminiGem" }, "TimeOfDay": { "type": "object", "properties": { "hours": { "type": "integer", "format": "int32", "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." }, "nanos": { "type": "integer", "format": "int32", "description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999." }, "minutes": { "type": "integer", "format": "int32", "description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59." }, "seconds": { "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.", "type": "integer", "format": "int32" } }, "id": "TimeOfDay", "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`." }, "Date": { "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", "id": "Date", "type": "object", "properties": { "year": { "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", "type": "integer", "format": "int32" }, "day": { "type": "integer", "format": "int32", "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." }, "month": { "type": "integer", "format": "int32", "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day." } } }, "CourseWork": { "description": "Course work created by a teacher for students of the course.", "id": "CourseWork", "type": "object", "properties": { "topicId": { "description": "Identifier for the topic that this coursework is associated with. Must match an existing topic in the course.", "type": "string" }, "gradingPeriodId": { "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.", "type": "string" }, "creationTime": { "description": "Timestamp when this course work was created. Read-only.", "type": "string", "format": "google-datetime" }, "creatorUserId": { "description": "Identifier for the user that created the coursework. Read-only.", "type": "string" }, "state": { "enumDescriptions": [ "No state specified. This is never returned.", "Status for work that has been published. This is the default state.", "Status for work that is not yet published. Work in this state is visible only to course teachers and domain administrators.", "Status for work that was published but is now deleted. Work in this state is visible only to course teachers and domain administrators. Work in this state is deleted after some time." ], "enum": [ "COURSE_WORK_STATE_UNSPECIFIED", "PUBLISHED", "DRAFT", "DELETED" ], "description": "Status of this course work. If unspecified, the default state is `DRAFT`.", "type": "string" }, "workType": { "type": "string", "enumDescriptions": [ "No work type specified. This is never returned.", "An assignment.", "A short answer question.", "A multiple-choice question." ], "enum": [ "COURSE_WORK_TYPE_UNSPECIFIED", "ASSIGNMENT", "SHORT_ANSWER_QUESTION", "MULTIPLE_CHOICE_QUESTION" ], "description": "Type of this course work. The type is set when the course work is created and cannot be changed." }, "multipleChoiceQuestion": { "description": "Multiple choice question details. For read operations, this field is populated only when `work_type` is `MULTIPLE_CHOICE_QUESTION`. For write operations, this field must be specified when creating course work with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be set otherwise.", "$ref": "MultipleChoiceQuestion" }, "updateTime": { "type": "string", "format": "google-datetime", "description": "Timestamp of the most recent change to this course work. Read-only." }, "assigneeMode": { "type": "string", "enumDescriptions": [ "No mode specified. This is never returned.", "All students can see the item. This is the default state.", "A subset of the students can see the item." ], "enum": [ "ASSIGNEE_MODE_UNSPECIFIED", "ALL_STUDENTS", "INDIVIDUAL_STUDENTS" ], "description": "Assignee mode of the coursework. If unspecified, the default value is `ALL_STUDENTS`." }, "assignment": { "description": "Assignment details. This is populated only when `work_type` is `ASSIGNMENT`. Read-only.", "$ref": "Assignment" }, "description": { "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.", "type": "string" }, "gradeCategory": { "description": "The category that this coursework's grade contributes to. Present only when a category has been chosen for the coursework. May be used in calculating the overall grade. Read-only.", "$ref": "GradeCategory" }, "alternateLink": { "description": "Absolute link to this course work in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.", "type": "string" }, "dueTime": { "description": "Optional time of day, in UTC, that submissions for this course work are due. This must be specified if `due_date` is specified.", "$ref": "TimeOfDay" }, "maxPoints": { "type": "number", "format": "double", "description": "Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value." }, "scheduledTime": { "description": "Optional timestamp when this course work is scheduled to be published.", "type": "string", "format": "google-datetime" }, "submissionModificationMode": { "type": "string", "enumDescriptions": [ "No modification mode specified. This is never returned.", "Submissions can be modified before being turned in.", "Submissions can be modified at any time." ], "enum": [ "SUBMISSION_MODIFICATION_MODE_UNSPECIFIED", "MODIFIABLE_UNTIL_TURNED_IN", "MODIFIABLE" ], "description": "Setting to determine when students are allowed to modify submissions. If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`." }, "materials": { "type": "array", "description": "Additional materials. CourseWork must have no more than 20 material items.", "items": { "$ref": "Material" } }, "individualStudentsOptions": { "description": "Identifiers of students with access to the coursework. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field are assigned the coursework.", "$ref": "IndividualStudentsOptions" }, "title": { "description": "Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters.", "type": "string" }, "dueDate": { "description": "Optional date, in UTC, that submissions for this course work are due. This must be specified if `due_time` is specified.", "$ref": "Date" }, "associatedWithDeveloper": { "description": "Whether this course work item is associated with the Developer Console project making the request. See CreateCourseWork for more details. Read-only.", "type": "boolean" }, "courseId": { "description": "Identifier of the course. Read-only.", "type": "string" }, "id": { "description": "Classroom-assigned identifier of this course work, unique per course. Read-only.", "type": "string" } } }, "Teacher": { "id": "Teacher", "description": "Teacher of a course.", "type": "object", "properties": { "courseId": { "description": "Identifier of the course. Read-only.", "type": "string" }, "userId": { "description": "Identifier of the user. When specified as a parameter of a request, this 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", "type": "string" }, "profile": { "description": "Global user information for the teacher. Read-only.", "$ref": "UserProfile" } } }, "Rubric": { "type": "object", "properties": { "criteria": { "type": "array", "description": "List of criteria. Each criterion is a dimension on which performance is rated.", "items": { "$ref": "Criterion" } }, "sourceSpreadsheetId": { "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.", "type": "string" }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. Timestamp of the most recent change to this rubric. Read-only." }, "courseId": { "description": "Identifier of the course. Read-only.", "type": "string" }, "id": { "description": "Classroom-assigned identifier for the rubric. This is unique among rubrics for the relevant course work. Read-only.", "type": "string" }, "courseWorkId": { "description": "Identifier for the course work this corresponds to. Read-only.", "type": "string" }, "creationTime": { "description": "Output only. Timestamp when this rubric was created. Read-only.", "readOnly": true, "type": "string", "format": "google-datetime" } }, "description": "The rubric of the course work. A rubric is a scoring guide used to evaluate student work and give feedback. For further details, see [Rubrics structure and known limitations](/classroom/rubrics/limitations).", "id": "Rubric" } }, "batchPath": "batch", "name": "classroom", "description": "Manages classes, rosters, and invitations in Google Classroom.", "resources": { "invitations": { "methods": { "create": { "request": { "$ref": "Invitation" }, "httpMethod": "POST", "parameters": {}, "path": "v1/invitations", "parameterOrder": [], "scopes": [ "https://www.googleapis.com/auth/classroom.rosters" ], "response": { "$ref": "Invitation" }, "flatPath": "v1/invitations", "description": "Creates an invitation. Only one invitation for a user and course may exist at a time. Delete and re-create an invitation to make changes. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create invitations for this course or for access errors. * `NOT_FOUND` if the course or the user does not exist. * `FAILED_PRECONDITION`: * if the requested user's account is disabled. * if the user already has this role or a role with greater permissions. * for the following request errors: * IneligibleOwner * `ALREADY_EXISTS` if an invitation for the specified user and course already exists.", "id": "classroom.invitations.create" }, "list": { "parameterOrder": [], "scopes": [ "https://www.googleapis.com/auth/classroom.rosters", "https://www.googleapis.com/auth/classroom.rosters.readonly" ], "flatPath": "v1/invitations", "description": "Returns a list of invitations that the requesting user is permitted to view, restricted to those that match the list request. *Note:* At least one of `user_id` or `course_id` must be supplied. Both fields can be supplied. This method returns the following error codes: * `PERMISSION_DENIED` for access errors.", "id": "classroom.invitations.list", "response": { "$ref": "ListInvitationsResponse" }, "httpMethod": "GET", "path": "v1/invitations", "parameters": { "courseId": { "location": "query", "type": "string", "description": "Restricts returned invitations to those for a course with the specified identifier." }, "pageToken": { "location": "query", "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." }, "userId": { "description": "Restricts returned invitations to those for a specific user. 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", "location": "query", "type": "string" }, "pageSize": { "description": "Maximum number of items to return. The default is 500 if unspecified or `0`. The server may return fewer than the specified number of results.", "location": "query", "type": "integer", "format": "int32" } } }, "accept": { "response": { "$ref": "Empty" }, "id": "classroom.invitations.accept", "flatPath": "v1/invitations/{id}:accept", "description": "Accepts an invitation, removing it and adding the invited user to the teachers or students (as appropriate) of the specified course. Only the invited user may accept an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to accept the requested invitation or for access errors. * `FAILED_PRECONDITION` for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `NOT_FOUND` if no invitation exists with the requested ID.", "parameterOrder": [ "id" ], "scopes": [ "https://www.googleapis.com/auth/classroom.rosters" ], "parameters": { "id": { "description": "Identifier of the invitation to accept.", "required": true, "location": "path", "type": "string" } }, "path": "v1/invitations/{id}:accept", "httpMethod": "POST" }, "get": { "response": { "$ref": "Invitation" }, "id": "classroom.invitations.get", "flatPath": "v1/invitations/{id}", "description": "Returns an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID.", "parameterOrder": [ "id" ], "scopes": [ "https://www.googleapis.com/auth/classroom.rosters", "https://www.googleapis.com/auth/classroom.rosters.readonly" ], "parameters": { "id": { "location": "path", "type": "string", "required": true, "description": "Identifier of the invitation to return." } }, "path": "v1/invitations/{id}", "httpMethod": "GET" }, "delete": { "response": { "$ref": "Empty" }, "flatPath": "v1/invitations/{id}", "description": "Deletes an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID.", "id": "classroom.invitations.delete", "parameterOrder": [ "id" ], "scopes": [ "https://www.googleapis.com/auth/classroom.rosters" ], "parameters": { "id": { "description": "Identifier of the invitation to delete.", "required": true, "location": "path", "type": "string" } }, "path": "v1/invitations/{id}", "httpMethod": "DELETE" } } }, "registrations": { "methods": { "create": { "request": { "$ref": "Registration" }, "httpMethod": "POST", "parameters": {}, "path": "v1/registrations", "parameterOrder": [], "scopes": [ "https://www.googleapis.com/auth/classroom.push-notifications" ], "response": { "$ref": "Registration" }, "flatPath": "v1/registrations", "description": "Creates a `Registration`, causing Classroom to start sending notifications from the provided `feed` to the destination provided in `cloudPubSubTopic`. Returns the created `Registration`. Currently, this will be the same as the argument, but with server-assigned fields such as `expiry_time` and `id` filled in. Note that any value specified for the `expiry_time` or `id` fields will be ignored. While Classroom may validate the `cloudPubSubTopic` and return errors on a best effort basis, it is the caller's responsibility to ensure that it exists and that Classroom has permission to publish to it. This method may return the following error codes: * `PERMISSION_DENIED` if: * the authenticated user does not have permission to receive notifications from the requested field; or * the current user has not granted access to the current Cloud project with the appropriate scope for the requested feed. Note that domain-wide delegation of authority is not currently supported for this purpose. If the request has the appropriate scope, but no grant exists, a Request Errors is returned. * another access error is encountered. * `INVALID_ARGUMENT` if: * no `cloudPubsubTopic` is specified, or the specified `cloudPubsubTopic` is not valid; or * no `feed` is specified, or the specified `feed` is not valid. * `NOT_FOUND` if: * the specified `feed` cannot be located, or the requesting user does not have permission to determine whether or not it exists; or * the specified `cloudPubsubTopic` cannot be located, or Classroom has not been granted permission to publish to it.", "id": "classroom.registrations.create" }, "delete": { "parameterOrder": [ "registrationId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.push-notifications" ], "response": { "$ref": "Empty" }, "id": "classroom.registrations.delete", "flatPath": "v1/registrations/{registrationId}", "description": "Deletes a `Registration`, causing Classroom to stop sending notifications for that `Registration`.", "httpMethod": "DELETE", "parameters": { "registrationId": { "location": "path", "type": "string", "required": true, "description": "The `registration_id` of the `Registration` to be deleted." } }, "path": "v1/registrations/{registrationId}" } } }, "courses": { "methods": { "get": { "httpMethod": "GET", "path": "v1/courses/{id}", "parameters": { "id": { "required": true, "location": "path", "type": "string", "description": "Identifier of the course to return. This identifier can be either the Classroom-assigned identifier or an alias." } }, "parameterOrder": [ "id" ], "scopes": [ "https://www.googleapis.com/auth/classroom.courses", "https://www.googleapis.com/auth/classroom.courses.readonly" ], "flatPath": "v1/courses/{id}", "description": "Returns a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.", "id": "classroom.courses.get", "response": { "$ref": "Course" } }, "delete": { "path": "v1/courses/{id}", "parameters": { "id": { "location": "path", "type": "string", "required": true, "description": "Identifier of the course to delete. This identifier can be either the Classroom-assigned identifier or an alias." } }, "httpMethod": "DELETE", "id": "classroom.courses.delete", "flatPath": "v1/courses/{id}", "description": "Deletes a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.", "response": { "$ref": "Empty" }, "parameterOrder": [ "id" ], "scopes": [ "https://www.googleapis.com/auth/classroom.courses" ] }, "getGradingPeriodSettings": { "flatPath": "v1/courses/{courseId}/gradingPeriodSettings", "description": "Returns the grading period settings in a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user isn't permitted to access the grading period settings in the requested course or for access errors. * `NOT_FOUND` if the requested course does not exist.", "id": "classroom.courses.getGradingPeriodSettings", "response": { "$ref": "GradingPeriodSettings" }, "parameterOrder": [ "courseId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.courses", "https://www.googleapis.com/auth/classroom.courses.readonly" ], "path": "v1/courses/{courseId}/gradingPeriodSettings", "parameters": { "courseId": { "location": "path", "type": "string", "required": true, "description": "Required. The identifier of the course." } }, "httpMethod": "GET" }, "update": { "response": { "$ref": "Course" }, "id": "classroom.courses.update", "flatPath": "v1/courses/{id}", "description": "Updates a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable * CourseTitleCannotContainUrl", "parameterOrder": [ "id" ], "scopes": [ "https://www.googleapis.com/auth/classroom.courses" ], "parameters": { "id": { "location": "path", "type": "string", "required": true, "description": "Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias." } }, "path": "v1/courses/{id}", "request": { "$ref": "Course" }, "httpMethod": "PUT" }, "updateGradingPeriodSettings": { "path": "v1/courses/{courseId}/gradingPeriodSettings", "parameters": { "updateMask": { "location": "query", "type": "string", "format": "google-fieldmask", "description": "Mask that identifies which fields in the GradingPeriodSettings to update. The GradingPeriodSettings `grading_periods` list will be fully replaced by the grading periods specified in the update request. For example: * Grading periods included in the list without an ID are considered additions, and a new ID will be assigned when the request is made. * Grading periods that currently exist, but are missing from the request will be considered deletions. * Grading periods with an existing ID and modified data are considered edits. Unmodified data will be left as is. * Grading periods included with an unknown ID will result in an error. The following fields may be specified: * `grading_periods` * `apply_to_existing_coursework`" }, "courseId": { "required": true, "location": "path", "type": "string", "description": "Required. The identifier of the course." } }, "httpMethod": "PATCH", "request": { "$ref": "GradingPeriodSettings" }, "id": "classroom.courses.updateGradingPeriodSettings", "flatPath": "v1/courses/{courseId}/gradingPeriodSettings", "description": "Updates grading period settings of a course. Individual grading periods can be added, removed, or modified using this method. The requesting user and course owner must be eligible to modify Grading Periods. For details, see [licensing requirements](https://developers.google.com/workspace/classroom/grading-periods/manage-grading-periods#licensing_requirements). This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the grading period settings in a course or for access errors: * UserIneligibleToUpdateGradingPeriodSettings * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.", "response": { "$ref": "GradingPeriodSettings" }, "parameterOrder": [ "courseId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.courses" ] }, "patch": { "parameters": { "updateMask": { "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` 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=,,...`", "location": "query", "type": "string", "format": "google-fieldmask" }, "id": { "required": true, "location": "path", "type": "string", "description": "Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias." } }, "path": "v1/courses/{id}", "request": { "$ref": "Course" }, "httpMethod": "PATCH", "response": { "$ref": "Course" }, "flatPath": "v1/courses/{id}", "description": "Updates one or more fields in a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable * InactiveCourseOwner * IneligibleOwner * CourseTitleCannotContainUrl", "id": "classroom.courses.patch", "parameterOrder": [ "id" ], "scopes": [ "https://www.googleapis.com/auth/classroom.courses" ] }, "create": { "request": { "$ref": "Course" }, "httpMethod": "POST", "parameters": {}, "path": "v1/courses", "parameterOrder": [], "scopes": [ "https://www.googleapis.com/auth/classroom.courses" ], "response": { "$ref": "Course" }, "flatPath": "v1/courses", "description": "Creates a course. The user specified in `ownerId` is the owner of the created course and added as a teacher. A non-admin requesting user can only create a course with themselves as the owner. Domain admins can create courses owned by any user within their domain. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create courses or for access errors. * `NOT_FOUND` if the primary teacher is not a valid user. * `FAILED_PRECONDITION` if the course owner's account is disabled or for the following request errors: * UserCannotOwnCourse * UserGroupsMembershipLimitReached * CourseTitleCannotContainUrl * `ALREADY_EXISTS` if an alias was specified in the `id` and already exists.", "id": "classroom.courses.create" }, "list": { "parameters": { "teacherId": { "location": "query", "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." }, "pageToken": { "location": "query", "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." }, "courseStates": { "repeated": true, "enumDescriptions": [ "No course state. No returned Course message will use this value.", "The course is active.", "The course has been archived. You cannot modify it except to change it to a different state.", "The course has been created, but not yet activated. It is accessible by the primary teacher and domain administrators, who may modify it or change it to the `ACTIVE` or `DECLINED` states. A course may only be changed to `PROVISIONED` if it is in the `DECLINED` state.", "The course has been created, but declined. It is accessible by the course owner and domain administrators, though it will not be displayed in the web UI. You cannot modify the course except to change it to the `PROVISIONED` state. A course may only be changed to `DECLINED` if it is in the `PROVISIONED` state.", "The course has been suspended. You cannot modify the course, and only the user identified by the `owner_id` can view the course. A course may be placed in this state if it potentially violates the Terms of Service." ], "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.", "location": "query", "type": "string" }, "studentId": { "location": "query", "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." }, "pageSize": { "location": "query", "type": "integer", "format": "int32", "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." } }, "path": "v1/courses", "httpMethod": "GET", "response": { "$ref": "ListCoursesResponse" }, "flatPath": "v1/courses", "description": "Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. Returned courses are ordered by creation time, with the most recently created coming first. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the query argument is malformed. * `NOT_FOUND` if any users specified in the query arguments do not exist.", "id": "classroom.courses.list", "parameterOrder": [], "scopes": [ "https://www.googleapis.com/auth/classroom.courses", "https://www.googleapis.com/auth/classroom.courses.readonly" ] } }, "resources": { "teachers": { "methods": { "get": { "parameterOrder": [ "courseId", "userId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.profile.emails", "https://www.googleapis.com/auth/classroom.profile.photos", "https://www.googleapis.com/auth/classroom.rosters", "https://www.googleapis.com/auth/classroom.rosters.readonly" ], "flatPath": "v1/courses/{courseId}/teachers/{userId}", "description": "Returns a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist.", "id": "classroom.courses.teachers.get", "response": { "$ref": "Teacher" }, "httpMethod": "GET", "path": "v1/courses/{courseId}/teachers/{userId}", "parameters": { "courseId": { "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "required": true, "location": "path", "type": "string" }, "userId": { "required": true, "location": "path", "type": "string", "description": "Identifier of the teacher to return. 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" } } }, "delete": { "httpMethod": "DELETE", "path": "v1/courses/{courseId}/teachers/{userId}", "parameters": { "courseId": { "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "type": "string", "required": true }, "userId": { "description": "Identifier of the teacher to delete. 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", "location": "path", "type": "string", "required": true } }, "parameterOrder": [ "courseId", "userId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.rosters" ], "flatPath": "v1/courses/{courseId}/teachers/{userId}", "description": "Removes the specified teacher from the specified course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist. * `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher of this course. * `FAILED_PRECONDITION` if the requested ID belongs to the owner of the course Drive folder. * `FAILED_PRECONDITION` if the course no longer has an active owner.", "id": "classroom.courses.teachers.delete", "response": { "$ref": "Empty" } }, "create": { "response": { "$ref": "Teacher" }, "id": "classroom.courses.teachers.create", "flatPath": "v1/courses/{courseId}/teachers", "description": "Creates a teacher of a course. Domain administrators are permitted to [directly add](https://developers.google.com/workspace/classroom/guides/manage-users) users within their domain as teachers to courses within their domain. Non-admin users should send an Invitation instead. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create teachers in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * InactiveCourseOwner * `ALREADY_EXISTS` if the user is already a teacher or student in the course.", "parameterOrder": [ "courseId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.profile.emails", "https://www.googleapis.com/auth/classroom.profile.photos", "https://www.googleapis.com/auth/classroom.rosters" ], "parameters": { "courseId": { "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "type": "string", "required": true } }, "path": "v1/courses/{courseId}/teachers", "request": { "$ref": "Teacher" }, "httpMethod": "POST" }, "list": { "response": { "$ref": "ListTeachersResponse" }, "flatPath": "v1/courses/{courseId}/teachers", "description": "Returns a list of teachers of this course that the requester is permitted to view. This method returns the following error codes: * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for access errors.", "id": "classroom.courses.teachers.list", "parameterOrder": [ "courseId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.profile.emails", "https://www.googleapis.com/auth/classroom.profile.photos", "https://www.googleapis.com/auth/classroom.rosters", "https://www.googleapis.com/auth/classroom.rosters.readonly" ], "parameters": { "pageSize": { "description": "Maximum number of items to return. The default is 30 if unspecified or `0`. The server may return fewer than the specified number of results.", "location": "query", "type": "integer", "format": "int32" }, "courseId": { "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "required": true, "location": "path", "type": "string" }, "pageToken": { "location": "query", "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." } }, "path": "v1/courses/{courseId}/teachers", "httpMethod": "GET" } } }, "aliases": { "methods": { "create": { "path": "v1/courses/{courseId}/aliases", "parameters": { "courseId": { "required": true, "location": "path", "type": "string", "description": "Identifier of the course to alias. This identifier can be either the Classroom-assigned identifier or an alias." } }, "httpMethod": "POST", "request": { "$ref": "CourseAlias" }, "id": "classroom.courses.aliases.create", "flatPath": "v1/courses/{courseId}/aliases", "description": "Creates an alias for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create the alias or for access errors. * `NOT_FOUND` if the course does not exist. * `ALREADY_EXISTS` if the alias already exists. * `FAILED_PRECONDITION` if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to access a domain-scoped alias).", "response": { "$ref": "CourseAlias" }, "parameterOrder": [ "courseId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.courses" ] }, "list": { "response": { "$ref": "ListCourseAliasesResponse" }, "flatPath": "v1/courses/{courseId}/aliases", "description": "Returns a list of aliases for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the course or for access errors. * `NOT_FOUND` if the course does not exist.", "id": "classroom.courses.aliases.list", "parameterOrder": [ "courseId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.courses", "https://www.googleapis.com/auth/classroom.courses.readonly" ], "parameters": { "courseId": { "location": "path", "type": "string", "required": true, "description": "The identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias." }, "pageToken": { "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.", "location": "query", "type": "string" }, "pageSize": { "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.", "location": "query", "type": "integer", "format": "int32" } }, "path": "v1/courses/{courseId}/aliases", "httpMethod": "GET" }, "delete": { "path": "v1/courses/{courseId}/aliases/{alias}", "parameters": { "courseId": { "required": true, "location": "path", "type": "string", "description": "Identifier of the course whose alias should be deleted. This identifier can be either the Classroom-assigned identifier or an alias." }, "alias": { "required": true, "location": "path", "type": "string", "description": "Alias to delete. This may not be the Classroom-assigned identifier." } }, "httpMethod": "DELETE", "flatPath": "v1/courses/{courseId}/aliases/{alias}", "description": "Deletes an alias of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to remove the alias or for access errors. * `NOT_FOUND` if the alias does not exist. * `FAILED_PRECONDITION` if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to delete a domain-scoped alias).", "id": "classroom.courses.aliases.delete", "response": { "$ref": "Empty" }, "parameterOrder": [ "courseId", "alias" ], "scopes": [ "https://www.googleapis.com/auth/classroom.courses" ] } } }, "courseWorkMaterials": { "methods": { "getAddOnContext": { "httpMethod": "GET", "parameters": { "courseId": { "required": true, "location": "path", "type": "string", "description": "Required. Identifier of the course." }, "postId": { "location": "query", "type": "string", "description": "Optional. Deprecated, use `item_id` instead.", "deprecated": true }, "addOnToken": { "description": "Optional. Token that authorizes the request. The token is passed as a query parameter when the user is redirected from Classroom to the add-on's URL. The authorization token is required when neither of the following is true: * The add-on has attachments on the post. * The developer project issuing the request is the same project that created the post.", "location": "query", "type": "string" }, "itemId": { "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.", "location": "path", "type": "string", "required": true }, "attachmentId": { "description": "Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/workspace/classroom/add-ons/get-started/iframes/attachment-discovery-iframe).", "location": "query", "type": "string" } }, "path": "v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnContext", "parameterOrder": [ "courseId", "itemId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.addons.student", "https://www.googleapis.com/auth/classroom.addons.teacher" ], "response": { "$ref": "AddOnContext" }, "id": "classroom.courses.courseWorkMaterials.getAddOnContext", "flatPath": "v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnContext", "description": "Gets metadata for Classroom add-ons in the context of a specific post. To maintain the integrity of its own data and permissions model, an add-on should call this to validate query parameters and the requesting user's role whenever the add-on is opened in an [iframe](https://developers.google.com/workspace/classroom/add-ons/get-started/iframes/iframes-overview). This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist." }, "create": { "httpMethod": "POST", "request": { "$ref": "CourseWorkMaterial" }, "path": "v1/courses/{courseId}/courseWorkMaterials", "parameters": { "courseId": { "location": "path", "type": "string", "required": true, "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias." } }, "parameterOrder": [ "courseId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.courseworkmaterials" ], "id": "classroom.courses.courseWorkMaterials.create", "flatPath": "v1/courses/{courseId}/courseWorkMaterials", "description": "Creates a course work material. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create course work material in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed or if more than 20 * materials are provided. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible", "response": { "$ref": "CourseWorkMaterial" } }, "list": { "response": { "$ref": "ListCourseWorkMaterialResponse" }, "flatPath": "v1/courses/{courseId}/courseWorkMaterials", "description": "Returns a list of course work material that the requester is permitted to view. Course students may only view `PUBLISHED` course work material. Course teachers and domain administrators may view all course work material. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.", "id": "classroom.courses.courseWorkMaterials.list", "parameterOrder": [ "courseId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.courseworkmaterials", "https://www.googleapis.com/auth/classroom.courseworkmaterials.readonly" ], "parameters": { "courseId": { "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "type": "string", "required": true }, "pageSize": { "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.", "location": "query", "type": "integer", "format": "int32" }, "orderBy": { "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`", "location": "query", "type": "string" }, "pageToken": { "location": "query", "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": { "description": "Optional filtering for course work material with at least one link material whose URL partially matches the provided string.", "location": "query", "type": "string" }, "materialDriveId": { "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.", "location": "query", "type": "string" }, "courseWorkMaterialStates": { "location": "query", "type": "string", "repeated": true, "enumDescriptions": [ "No state specified. This is never returned.", "Status for course work material that has been published. This is the default state.", "Status for a course work material that is not yet published. Course work material in this state is visible only to course teachers and domain administrators.", "Status for course work material that was published but is now deleted. Course work material in this state is visible only to course teachers and domain administrators. Course work material in this state is deleted after some time." ], "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." } }, "path": "v1/courses/{courseId}/courseWorkMaterials", "httpMethod": "GET" }, "patch": { "id": "classroom.courses.courseWorkMaterials.patch", "flatPath": "v1/courses/{courseId}/courseWorkMaterials/{id}", "description": "Updates one or more fields of a course work material. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested course work material has already been deleted. * `NOT_FOUND` if the requested course or course work material does not exist", "response": { "$ref": "CourseWorkMaterial" }, "parameterOrder": [ "courseId", "id" ], "scopes": [ "https://www.googleapis.com/auth/classroom.courseworkmaterials" ], "path": "v1/courses/{courseId}/courseWorkMaterials/{id}", "parameters": { "updateMask": { "location": "query", "type": "string", "format": "google-fieldmask", "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` * `scheduled_time` * `topic_id`" }, "courseId": { "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "type": "string", "required": true }, "id": { "description": "Identifier of the course work material.", "required": true, "location": "path", "type": "string" } }, "httpMethod": "PATCH", "request": { "$ref": "CourseWorkMaterial" } }, "get": { "id": "classroom.courses.courseWorkMaterials.get", "flatPath": "v1/courses/{courseId}/courseWorkMaterials/{id}", "description": "Returns a course work material. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work material, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work material does not exist.", "response": { "$ref": "CourseWorkMaterial" }, "parameterOrder": [ "courseId", "id" ], "scopes": [ "https://www.googleapis.com/auth/classroom.courseworkmaterials", "https://www.googleapis.com/auth/classroom.courseworkmaterials.readonly" ], "path": "v1/courses/{courseId}/courseWorkMaterials/{id}", "parameters": { "courseId": { "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "type": "string", "required": true }, "id": { "description": "Identifier of the course work material.", "location": "path", "type": "string", "required": true } }, "httpMethod": "GET" }, "delete": { "httpMethod": "DELETE", "path": "v1/courses/{courseId}/courseWorkMaterials/{id}", "parameters": { "courseId": { "location": "path", "type": "string", "required": true, "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias." }, "id": { "required": true, "location": "path", "type": "string", "description": "Identifier of the course work material to delete. This identifier is a Classroom-assigned identifier." } }, "parameterOrder": [ "courseId", "id" ], "scopes": [ "https://www.googleapis.com/auth/classroom.courseworkmaterials" ], "id": "classroom.courses.courseWorkMaterials.delete", "flatPath": "v1/courses/{courseId}/courseWorkMaterials/{id}", "description": "Deletes a course work material. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work material item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work material, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested course work material has already been deleted. * `NOT_FOUND` if no course exists with the requested ID.", "response": { "$ref": "Empty" } } }, "resources": { "addOnAttachments": { "methods": { "patch": { "parameters": { "courseId": { "description": "Required. Identifier of the course.", "required": true, "location": "path", "type": "string" }, "updateMask": { "location": "query", "type": "string", "format": "google-fieldmask", "description": "Required. Mask that identifies which fields on the attachment to 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 `AddOnAttachment` object. If a field that does not support empty values is included in the update mask and not set in the `AddOnAttachment` object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `teacher_view_uri` * `student_view_uri` * `student_work_review_uri` * `due_date` * `due_time` * `max_points`" }, "postId": { "location": "query", "type": "string", "description": "Required. Identifier of the post under which the attachment is attached." }, "itemId": { "required": true, "location": "path", "type": "string", "description": "Identifier of the post under which the attachment is attached." }, "attachmentId": { "description": "Required. Identifier of the attachment.", "required": true, "location": "path", "type": "string" } }, "path": "v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}", "request": { "$ref": "AddOnAttachment" }, "httpMethod": "PATCH", "response": { "$ref": "AddOnAttachment" }, "flatPath": "v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}", "description": "Updates an add-on attachment. Requires the add-on to have been the original creator of the attachment. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.", "id": "classroom.courses.courseWorkMaterials.addOnAttachments.patch", "parameterOrder": [ "courseId", "itemId", "attachmentId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.addons.teacher" ] }, "list": { "response": { "$ref": "ListAddOnAttachmentsResponse" }, "flatPath": "v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments", "description": "Returns all attachments created by an add-on under the post. Requires the add-on to have active attachments on the post or have permission to create new attachments on the post. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.", "id": "classroom.courses.courseWorkMaterials.addOnAttachments.list", "parameterOrder": [ "courseId", "itemId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.addons.student", "https://www.googleapis.com/auth/classroom.addons.teacher" ], "parameters": { "postId": { "location": "query", "type": "string", "description": "Optional. Identifier of the post under the course whose attachments to enumerate. Deprecated, use `item_id` instead.", "deprecated": true }, "pageSize": { "location": "query", "type": "integer", "format": "int32", "description": "The maximum number of attachments to return. The service may return fewer than this value. If unspecified, at most 20 attachments will be returned. The maximum value is 20; values above 20 will be coerced to 20." }, "courseId": { "description": "Required. Identifier of the course.", "location": "path", "type": "string", "required": true }, "itemId": { "location": "path", "type": "string", "required": true, "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` whose attachments should be enumerated. This field is required, but is not marked as such while we are migrating from post_id." }, "pageToken": { "location": "query", "type": "string", "description": "A page token, received from a previous `ListAddOnAttachments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAddOnAttachments` must match the call that provided the page token." } }, "path": "v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments", "httpMethod": "GET" }, "create": { "path": "v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments", "parameters": { "courseId": { "required": true, "location": "path", "type": "string", "description": "Required. Identifier of the course." }, "itemId": { "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which to create the attachment. This field is required, but is not marked as such while we are migrating from post_id.", "required": true, "location": "path", "type": "string" }, "postId": { "description": "Optional. Deprecated, use `item_id` instead.", "deprecated": true, "location": "query", "type": "string" }, "addOnToken": { "description": "Optional. Token that authorizes the request. The token is passed as a query parameter when the user is redirected from Classroom to the add-on's URL. This authorization token is required for in-Classroom attachment creation but optional for partner-first attachment creation. Returns an error if not provided for partner-first attachment creation and the developer projects that created the attachment and its parent stream item do not match.", "location": "query", "type": "string" } }, "httpMethod": "POST", "request": { "$ref": "AddOnAttachment" }, "flatPath": "v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments", "description": "Creates an add-on attachment under a post. Requires the add-on to have permission to create new attachments on the post. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.", "id": "classroom.courses.courseWorkMaterials.addOnAttachments.create", "response": { "$ref": "AddOnAttachment" }, "parameterOrder": [ "courseId", "itemId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.addons.teacher" ] }, "get": { "response": { "$ref": "AddOnAttachment" }, "flatPath": "v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}", "description": "Returns an add-on attachment. Requires the add-on requesting the attachment to be the original creator of the attachment. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.", "id": "classroom.courses.courseWorkMaterials.addOnAttachments.get", "parameterOrder": [ "courseId", "itemId", "attachmentId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.addons.student", "https://www.googleapis.com/auth/classroom.addons.teacher" ], "parameters": { "itemId": { "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.", "required": true, "location": "path", "type": "string" }, "attachmentId": { "required": true, "location": "path", "type": "string", "description": "Required. Identifier of the attachment." }, "postId": { "deprecated": true, "description": "Optional. Deprecated, use `item_id` instead.", "location": "query", "type": "string" }, "courseId": { "description": "Required. Identifier of the course.", "location": "path", "type": "string", "required": true } }, "path": "v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}", "httpMethod": "GET" }, "delete": { "parameterOrder": [ "courseId", "itemId", "attachmentId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.addons.teacher" ], "flatPath": "v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}", "description": "Deletes an add-on attachment. Requires the add-on to have been the original creator of the attachment. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.", "id": "classroom.courses.courseWorkMaterials.addOnAttachments.delete", "response": { "$ref": "Empty" }, "httpMethod": "DELETE", "path": "v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}", "parameters": { "itemId": { "location": "path", "type": "string", "required": true, "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id." }, "attachmentId": { "description": "Required. Identifier of the attachment.", "required": true, "location": "path", "type": "string" }, "postId": { "deprecated": true, "description": "Optional. Deprecated, use `item_id` instead.", "location": "query", "type": "string" }, "courseId": { "location": "path", "type": "string", "required": true, "description": "Required. Identifier of the course." } } } } } } }, "studentGroups": { "methods": { "create": { "httpMethod": "POST", "request": { "$ref": "StudentGroup" }, "path": "v1/courses/{courseId}/studentGroups", "parameters": { "courseId": { "description": "Required. The identifier of the course.", "location": "path", "type": "string", "required": true } }, "parameterOrder": [ "courseId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.rosters" ], "flatPath": "v1/courses/{courseId}/studentGroups", "description": "Creates a student group for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create the student group or for access errors. * `NOT_FOUND` if the course does not exist or the requesting user doesn't have access to the course. * `FAILED_PRECONDITION` if creating the student group would exceed the maximum number of student groups per course.", "id": "classroom.courses.studentGroups.create", "response": { "$ref": "StudentGroup" } }, "list": { "httpMethod": "GET", "parameters": { "courseId": { "description": "Required. The identifier of the course.", "location": "path", "type": "string", "required": true }, "pageToken": { "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.", "location": "query", "type": "string" }, "pageSize": { "description": "Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum, which is currently set to 75 items. The server may return fewer than the specified number of results.", "location": "query", "type": "integer", "format": "int32" } }, "path": "v1/courses/{courseId}/studentGroups", "parameterOrder": [ "courseId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.rosters", "https://www.googleapis.com/auth/classroom.rosters.readonly" ], "response": { "$ref": "ListStudentGroupsResponse" }, "flatPath": "v1/courses/{courseId}/studentGroups", "description": "Returns a list of groups in a course. This method returns the following error codes: * `NOT_FOUND` if the course does not exist.", "id": "classroom.courses.studentGroups.list" }, "delete": { "parameterOrder": [ "courseId", "id" ], "scopes": [ "https://www.googleapis.com/auth/classroom.rosters" ], "flatPath": "v1/courses/{courseId}/studentGroups/{id}", "description": "Deletes a student group. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested student group or for access errors. * `NOT_FOUND` if the student group does not exist or the user does not have access to the student group.", "id": "classroom.courses.studentGroups.delete", "response": { "$ref": "Empty" }, "httpMethod": "DELETE", "path": "v1/courses/{courseId}/studentGroups/{id}", "parameters": { "courseId": { "description": "Required. The identifier of the course containing the student group to delete.", "required": true, "location": "path", "type": "string" }, "id": { "required": true, "location": "path", "type": "string", "description": "Required. The identifier of the student group to delete." } } }, "patch": { "id": "classroom.courses.studentGroups.patch", "flatPath": "v1/courses/{courseId}/studentGroups/{id}", "description": "Updates one or more fields in a student group. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested student group or for access errors. * `NOT_FOUND` if the student group does not exist or the user does not have access to the student group. * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied.", "response": { "$ref": "StudentGroup" }, "parameterOrder": [ "courseId", "id" ], "scopes": [ "https://www.googleapis.com/auth/classroom.rosters" ], "path": "v1/courses/{courseId}/studentGroups/{id}", "parameters": { "updateMask": { "location": "query", "type": "string", "format": "google-fieldmask", "description": "Required. Mask that identifies which fields on the student group to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields can be specified by teachers: * `title`" }, "courseId": { "description": "Required. Identifier of the course.", "location": "path", "type": "string", "required": true }, "id": { "required": true, "location": "path", "type": "string", "description": "Required. Identifier of the student group." } }, "httpMethod": "PATCH", "request": { "$ref": "StudentGroup" } } }, "resources": { "studentGroupMembers": { "methods": { "delete": { "parameters": { "userId": { "required": true, "location": "path", "type": "string", "description": "Required. The identifier of the student group member to delete." }, "courseId": { "description": "Required. The identifier of the course containing the relevant student group.", "location": "path", "type": "string", "required": true }, "studentGroupId": { "location": "path", "type": "string", "required": true, "description": "Required. The identifier of the student group containing the student group member to delete." } }, "path": "v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers/{userId}", "httpMethod": "DELETE", "response": { "$ref": "Empty" }, "flatPath": "v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers/{userId}", "description": "Deletes a student group member. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested student group member or for access errors. * `NOT_FOUND` if the student group member does not exist or the user does not have access to the student group.", "id": "classroom.courses.studentGroups.studentGroupMembers.delete", "parameterOrder": [ "courseId", "studentGroupId", "userId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.rosters" ] }, "create": { "request": { "$ref": "StudentGroupMember" }, "httpMethod": "POST", "parameters": { "courseId": { "location": "path", "type": "string", "required": true, "description": "Required. The identifier of the course." }, "studentGroupId": { "description": "Required. The identifier of the student group.", "location": "path", "type": "string", "required": true } }, "path": "v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers", "parameterOrder": [ "courseId", "studentGroupId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.rosters" ], "response": { "$ref": "StudentGroupMember" }, "id": "classroom.courses.studentGroups.studentGroupMembers.create", "flatPath": "v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers", "description": "Creates a student group member for a student group. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create the student group or member for access errors. * `NOT_FOUND` if the student group does not exist or the user does not have access to the student group. * `ALREADY_EXISTS` if the student group member already exists. * `FAILED_PRECONDITION` if attempting to add a member to a student group that has reached its member limit." }, "list": { "path": "v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers", "parameters": { "pageSize": { "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.", "location": "query", "type": "integer", "format": "int32" }, "courseId": { "description": "Required. The identifier of the course.", "location": "path", "type": "string", "required": true }, "studentGroupId": { "description": "Required. The identifier of the student group.", "location": "path", "type": "string", "required": true }, "pageToken": { "location": "query", "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." } }, "httpMethod": "GET", "id": "classroom.courses.studentGroups.studentGroupMembers.list", "flatPath": "v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers", "description": "Returns a list of students in a group. This method returns the following error codes: * `NOT_FOUND` if the course or student group does not exist.", "response": { "$ref": "ListStudentGroupMembersResponse" }, "parameterOrder": [ "courseId", "studentGroupId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.rosters", "https://www.googleapis.com/auth/classroom.rosters.readonly" ] } } } } }, "students": { "methods": { "create": { "request": { "$ref": "Student" }, "httpMethod": "POST", "parameters": { "courseId": { "description": "Identifier of the course to create the student in. This identifier can be either the Classroom-assigned identifier or an alias.", "required": true, "location": "path", "type": "string" }, "enrollmentCode": { "location": "query", "type": "string", "description": "Enrollment code of the course to create the student in. This code is required if userId corresponds to the requesting user; it may be omitted if the requesting user has administrative permissions to create students for any user." } }, "path": "v1/courses/{courseId}/students", "parameterOrder": [ "courseId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.profile.emails", "https://www.googleapis.com/auth/classroom.profile.photos", "https://www.googleapis.com/auth/classroom.rosters" ], "response": { "$ref": "Student" }, "flatPath": "v1/courses/{courseId}/students", "description": "Adds a user as a student of a course. Domain administrators are permitted to [directly add](https://developers.google.com/workspace/classroom/guides/manage-users) users within their domain as students to courses within their domain. Students are permitted to add themselves to a course using an enrollment code. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create students in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * UserGroupsMembershipLimitReached * InactiveCourseOwner * `ALREADY_EXISTS` if the user is already a student or teacher in the course.", "id": "classroom.courses.students.create" }, "list": { "httpMethod": "GET", "path": "v1/courses/{courseId}/students", "parameters": { "pageSize": { "description": "Maximum number of items to return. The default is 30 if unspecified or `0`. The server may return fewer than the specified number of results.", "location": "query", "type": "integer", "format": "int32" }, "courseId": { "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "required": true, "location": "path", "type": "string" }, "pageToken": { "location": "query", "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." } }, "parameterOrder": [ "courseId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.profile.emails", "https://www.googleapis.com/auth/classroom.profile.photos", "https://www.googleapis.com/auth/classroom.rosters", "https://www.googleapis.com/auth/classroom.rosters.readonly" ], "flatPath": "v1/courses/{courseId}/students", "description": "Returns a list of students of this course that the requester is permitted to view. This method returns the following error codes: * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for access errors.", "id": "classroom.courses.students.list", "response": { "$ref": "ListStudentsResponse" } }, "get": { "parameters": { "courseId": { "required": true, "location": "path", "type": "string", "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias." }, "userId": { "required": true, "location": "path", "type": "string", "description": "Identifier of the student to return. 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" } }, "path": "v1/courses/{courseId}/students/{userId}", "httpMethod": "GET", "response": { "$ref": "Student" }, "id": "classroom.courses.students.get", "flatPath": "v1/courses/{courseId}/students/{userId}", "description": "Returns a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.", "parameterOrder": [ "courseId", "userId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.profile.emails", "https://www.googleapis.com/auth/classroom.profile.photos", "https://www.googleapis.com/auth/classroom.rosters", "https://www.googleapis.com/auth/classroom.rosters.readonly" ] }, "delete": { "httpMethod": "DELETE", "path": "v1/courses/{courseId}/students/{userId}", "parameters": { "courseId": { "required": true, "location": "path", "type": "string", "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias." }, "userId": { "location": "path", "type": "string", "required": true, "description": "Identifier of the student to delete. 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" } }, "parameterOrder": [ "courseId", "userId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.rosters" ], "id": "classroom.courses.students.delete", "flatPath": "v1/courses/{courseId}/students/{userId}", "description": "Deletes a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.", "response": { "$ref": "Empty" } } } }, "topics": { "methods": { "patch": { "parameters": { "courseId": { "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "type": "string", "required": true }, "id": { "required": true, "location": "path", "type": "string", "description": "Identifier of the topic." }, "updateMask": { "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`", "location": "query", "type": "string", "format": "google-fieldmask" } }, "path": "v1/courses/{courseId}/topics/{id}", "request": { "$ref": "Topic" }, "httpMethod": "PATCH", "response": { "$ref": "Topic" }, "id": "classroom.courses.topics.patch", "flatPath": "v1/courses/{courseId}/topics/{id}", "description": "Updates one or more fields of a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding topic or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if there exists a topic in the course with the same name. * `NOT_FOUND` if the requested course or topic does not exist", "parameterOrder": [ "courseId", "id" ], "scopes": [ "https://www.googleapis.com/auth/classroom.topics" ] }, "create": { "request": { "$ref": "Topic" }, "httpMethod": "POST", "parameters": { "courseId": { "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "required": true, "location": "path", "type": "string" } }, "path": "v1/courses/{courseId}/topics", "parameterOrder": [ "courseId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.topics" ], "response": { "$ref": "Topic" }, "flatPath": "v1/courses/{courseId}/topics", "description": "Creates a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create a topic in the requested course, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `ALREADY_EXISTS` if there exists a topic in the course with the same name. * `FAILED_PRECONDITION` for the following request error: * CourseTopicLimitReached * `NOT_FOUND` if the requested course does not exist.", "id": "classroom.courses.topics.create" }, "list": { "parameterOrder": [ "courseId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.topics", "https://www.googleapis.com/auth/classroom.topics.readonly" ], "id": "classroom.courses.topics.list", "flatPath": "v1/courses/{courseId}/topics", "description": "Returns the list of topics that the requester is permitted to view. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.", "response": { "$ref": "ListTopicResponse" }, "httpMethod": "GET", "path": "v1/courses/{courseId}/topics", "parameters": { "courseId": { "required": true, "location": "path", "type": "string", "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias." }, "pageToken": { "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.", "location": "query", "type": "string" }, "pageSize": { "location": "query", "type": "integer", "format": "int32", "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." } } }, "delete": { "httpMethod": "DELETE", "parameters": { "courseId": { "required": true, "location": "path", "type": "string", "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias." }, "id": { "required": true, "location": "path", "type": "string", "description": "Identifier of the topic to delete." } }, "path": "v1/courses/{courseId}/topics/{id}", "parameterOrder": [ "courseId", "id" ], "scopes": [ "https://www.googleapis.com/auth/classroom.topics" ], "response": { "$ref": "Empty" }, "id": "classroom.courses.topics.delete", "flatPath": "v1/courses/{courseId}/topics/{id}", "description": "Deletes a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not allowed to delete the requested topic or for access errors. * `FAILED_PRECONDITION` if the requested topic has already been deleted. * `NOT_FOUND` if no course or topic exists with the requested ID." }, "get": { "httpMethod": "GET", "path": "v1/courses/{courseId}/topics/{id}", "parameters": { "courseId": { "description": "Identifier of the course.", "required": true, "location": "path", "type": "string" }, "id": { "description": "Identifier of the topic.", "location": "path", "type": "string", "required": true } }, "parameterOrder": [ "courseId", "id" ], "scopes": [ "https://www.googleapis.com/auth/classroom.topics", "https://www.googleapis.com/auth/classroom.topics.readonly" ], "id": "classroom.courses.topics.get", "flatPath": "v1/courses/{courseId}/topics/{id}", "description": "Returns a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or topic, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or topic does not exist.", "response": { "$ref": "Topic" } } } }, "courseWork": { "methods": { "modifyAssignees": { "id": "classroom.courses.courseWork.modifyAssignees", "flatPath": "v1/courses/{courseId}/courseWork/{id}:modifyAssignees", "description": "Modifies assignee mode and options of a coursework. Only a teacher of the course that contains the coursework may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist. * `FAILED_PRECONDITION` for the following request error: * EmptyAssignees", "response": { "$ref": "CourseWork" }, "parameterOrder": [ "courseId", "id" ], "scopes": [ "https://www.googleapis.com/auth/classroom.coursework.students" ], "path": "v1/courses/{courseId}/courseWork/{id}:modifyAssignees", "parameters": { "courseId": { "location": "path", "type": "string", "required": true, "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias." }, "id": { "description": "Identifier of the coursework.", "required": true, "location": "path", "type": "string" } }, "httpMethod": "POST", "request": { "$ref": "ModifyCourseWorkAssigneesRequest" } }, "patch": { "parameterOrder": [ "courseId", "id" ], "scopes": [ "https://www.googleapis.com/auth/classroom.coursework.students" ], "flatPath": "v1/courses/{courseId}/courseWork/{id}", "description": "Updates one or more fields of a course work. See google.classroom.v1.CourseWork for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if the requested course or course work does not exist.", "id": "classroom.courses.courseWork.patch", "response": { "$ref": "CourseWork" }, "httpMethod": "PATCH", "request": { "$ref": "CourseWork" }, "path": "v1/courses/{courseId}/courseWork/{id}", "parameters": { "updateMask": { "location": "query", "type": "string", "format": "google-fieldmask", "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` * `due_date` * `due_time` * `max_points` * `scheduled_time` * `submission_modification_mode` * `topic_id` * `grading_period_id`" }, "courseId": { "required": true, "location": "path", "type": "string", "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias." }, "id": { "location": "path", "type": "string", "required": true, "description": "Identifier of the course work." } } }, "create": { "id": "classroom.courses.courseWork.create", "flatPath": "v1/courses/{courseId}/courseWork", "description": "Creates course work. The resulting course work (and corresponding student submissions) are associated with the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to make the request. Classroom API requests to modify course work and student submissions must be made with an OAuth client ID from the associated Developer Console project. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create course work in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible", "response": { "$ref": "CourseWork" }, "parameterOrder": [ "courseId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.coursework.students" ], "path": "v1/courses/{courseId}/courseWork", "parameters": { "courseId": { "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "type": "string", "required": true } }, "httpMethod": "POST", "request": { "$ref": "CourseWork" } }, "list": { "flatPath": "v1/courses/{courseId}/courseWork", "description": "Returns a list of course work that the requester is permitted to view. Course students may only view `PUBLISHED` course work. Course teachers and domain administrators may view all course work. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.", "id": "classroom.courses.courseWork.list", "response": { "$ref": "ListCourseWorkResponse" }, "parameterOrder": [ "courseId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.coursework.me", "https://www.googleapis.com/auth/classroom.coursework.me.readonly", "https://www.googleapis.com/auth/classroom.coursework.students", "https://www.googleapis.com/auth/classroom.coursework.students.readonly" ], "path": "v1/courses/{courseId}/courseWork", "parameters": { "orderBy": { "location": "query", "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": { "location": "query", "type": "integer", "format": "int32", "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." }, "courseId": { "required": true, "location": "path", "type": "string", "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias." }, "courseWorkStates": { "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.", "enumDescriptions": [ "No state specified. This is never returned.", "Status for work that has been published. This is the default state.", "Status for work that is not yet published. Work in this state is visible only to course teachers and domain administrators.", "Status for work that was published but is now deleted. Work in this state is visible only to course teachers and domain administrators. Work in this state is deleted after some time." ], "enum": [ "COURSE_WORK_STATE_UNSPECIFIED", "PUBLISHED", "DRAFT", "DELETED" ], "repeated": true, "location": "query", "type": "string" }, "pageToken": { "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.", "location": "query", "type": "string" } }, "httpMethod": "GET" }, "getAddOnContext": { "httpMethod": "GET", "parameters": { "courseId": { "description": "Required. Identifier of the course.", "location": "path", "type": "string", "required": true }, "postId": { "location": "query", "type": "string", "deprecated": true, "description": "Optional. Deprecated, use `item_id` instead." }, "addOnToken": { "location": "query", "type": "string", "description": "Optional. Token that authorizes the request. The token is passed as a query parameter when the user is redirected from Classroom to the add-on's URL. The authorization token is required when neither of the following is true: * The add-on has attachments on the post. * The developer project issuing the request is the same project that created the post." }, "itemId": { "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.", "location": "path", "type": "string", "required": true }, "attachmentId": { "description": "Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/workspace/classroom/add-ons/get-started/iframes/attachment-discovery-iframe).", "location": "query", "type": "string" } }, "path": "v1/courses/{courseId}/courseWork/{itemId}/addOnContext", "parameterOrder": [ "courseId", "itemId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.addons.student", "https://www.googleapis.com/auth/classroom.addons.teacher" ], "response": { "$ref": "AddOnContext" }, "flatPath": "v1/courses/{courseId}/courseWork/{itemId}/addOnContext", "description": "Gets metadata for Classroom add-ons in the context of a specific post. To maintain the integrity of its own data and permissions model, an add-on should call this to validate query parameters and the requesting user's role whenever the add-on is opened in an [iframe](https://developers.google.com/workspace/classroom/add-ons/get-started/iframes/iframes-overview). This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.", "id": "classroom.courses.courseWork.getAddOnContext" }, "updateRubric": { "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/rubric", "parameters": { "courseWorkId": { "required": true, "location": "path", "type": "string", "description": "Required. Identifier of the course work." }, "updateMask": { "location": "query", "type": "string", "format": "google-fieldmask", "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 `source_spreadsheet_id` 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` * `source_spreadsheet_id`" }, "courseId": { "required": true, "location": "path", "type": "string", "description": "Required. Identifier of the course." }, "id": { "description": "Optional. Identifier of the rubric.", "location": "query", "type": "string" } }, "httpMethod": "PATCH", "request": { "$ref": "Rubric" }, "id": "classroom.courses.courseWork.updateRubric", "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/rubric", "description": "Updates a rubric. See google.classroom.v1.Rubric for details of which fields can be updated. Rubric update capabilities are [limited](/classroom/rubrics/limitations) once grading has started. The requesting user and course owner must have rubrics creation capabilities. For details, see [licensing requirements](https://developers.google.com/workspace/classroom/rubrics/limitations#license-requirements). This request must be made by the Google Cloud console of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the parent course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project didn't create the corresponding course work, if the user isn't permitted to make the requested modification to the rubric, or for access errors. This error code is also returned if grading has already started on the rubric. * `INVALID_ARGUMENT` if the request is malformed and for the following request error: * `RubricCriteriaInvalidFormat` * `NOT_FOUND` if the requested course, course work, or rubric doesn't exist or if the user doesn't have access to the corresponding course work. * `INTERNAL` if grading has already started on the rubric.", "response": { "$ref": "Rubric" }, "parameterOrder": [ "courseId", "courseWorkId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.coursework.students" ] }, "delete": { "parameterOrder": [ "courseId", "id" ], "scopes": [ "https://www.googleapis.com/auth/classroom.coursework.students" ], "id": "classroom.courses.courseWork.delete", "flatPath": "v1/courses/{courseId}/courseWork/{id}", "description": "Deletes a course work. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if no course exists with the requested ID.", "response": { "$ref": "Empty" }, "httpMethod": "DELETE", "path": "v1/courses/{courseId}/courseWork/{id}", "parameters": { "courseId": { "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "type": "string", "required": true }, "id": { "description": "Identifier of the course work to delete. This identifier is a Classroom-assigned identifier.", "required": true, "location": "path", "type": "string" } } }, "get": { "parameterOrder": [ "courseId", "id" ], "scopes": [ "https://www.googleapis.com/auth/classroom.coursework.me", "https://www.googleapis.com/auth/classroom.coursework.me.readonly", "https://www.googleapis.com/auth/classroom.coursework.students", "https://www.googleapis.com/auth/classroom.coursework.students.readonly" ], "flatPath": "v1/courses/{courseId}/courseWork/{id}", "description": "Returns course work. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist.", "id": "classroom.courses.courseWork.get", "response": { "$ref": "CourseWork" }, "httpMethod": "GET", "path": "v1/courses/{courseId}/courseWork/{id}", "parameters": { "courseId": { "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "type": "string", "required": true }, "id": { "required": true, "location": "path", "type": "string", "description": "Identifier of the course work." } } } }, "resources": { "rubrics": { "methods": { "get": { "parameterOrder": [ "courseId", "courseWorkId", "id" ], "scopes": [ "https://www.googleapis.com/auth/classroom.coursework.me", "https://www.googleapis.com/auth/classroom.coursework.me.readonly", "https://www.googleapis.com/auth/classroom.coursework.students", "https://www.googleapis.com/auth/classroom.coursework.students.readonly" ], "id": "classroom.courses.courseWork.rubrics.get", "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}", "description": "Returns a rubric. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or rubric doesn't exist or if the user doesn't have access to the corresponding course work.", "response": { "$ref": "Rubric" }, "httpMethod": "GET", "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}", "parameters": { "courseId": { "location": "path", "type": "string", "required": true, "description": "Required. Identifier of the course." }, "id": { "description": "Required. Identifier of the rubric.", "required": true, "location": "path", "type": "string" }, "courseWorkId": { "description": "Required. Identifier of the course work.", "required": true, "location": "path", "type": "string" } } }, "delete": { "parameters": { "courseId": { "description": "Required. Identifier of the course.", "location": "path", "type": "string", "required": true }, "id": { "location": "path", "type": "string", "required": true, "description": "Required. Identifier of the rubric." }, "courseWorkId": { "required": true, "location": "path", "type": "string", "description": "Required. Identifier of the course work." } }, "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}", "httpMethod": "DELETE", "response": { "$ref": "Empty" }, "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}", "description": "Deletes a rubric. The requesting user and course owner must have rubrics creation capabilities. For details, see [licensing requirements](https://developers.google.com/workspace/classroom/rubrics/limitations#license-requirements). This request must be made by the Google Cloud console of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding rubric. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project didn't create the corresponding rubric, or if the requesting user isn't permitted to delete the requested rubric. * `NOT_FOUND` if no rubric exists with the requested ID or the user does not have access to the course, course work, or rubric. * `INVALID_ARGUMENT` if grading has already started on the rubric.", "id": "classroom.courses.courseWork.rubrics.delete", "parameterOrder": [ "courseId", "courseWorkId", "id" ], "scopes": [ "https://www.googleapis.com/auth/classroom.coursework.students" ] }, "patch": { "request": { "$ref": "Rubric" }, "httpMethod": "PATCH", "parameters": { "courseId": { "description": "Required. Identifier of the course.", "location": "path", "type": "string", "required": true }, "id": { "description": "Optional. Identifier of the rubric.", "location": "path", "type": "string", "required": true }, "courseWorkId": { "required": true, "location": "path", "type": "string", "description": "Required. Identifier of the course work." }, "updateMask": { "location": "query", "type": "string", "format": "google-fieldmask", "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 `source_spreadsheet_id` 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` * `source_spreadsheet_id`" } }, "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}", "parameterOrder": [ "courseId", "courseWorkId", "id" ], "scopes": [ "https://www.googleapis.com/auth/classroom.coursework.students" ], "response": { "$ref": "Rubric" }, "id": "classroom.courses.courseWork.rubrics.patch", "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}", "description": "Updates a rubric. See google.classroom.v1.Rubric for details of which fields can be updated. Rubric update capabilities are [limited](/classroom/rubrics/limitations) once grading has started. The requesting user and course owner must have rubrics creation capabilities. For details, see [licensing requirements](https://developers.google.com/workspace/classroom/rubrics/limitations#license-requirements). This request must be made by the Google Cloud console of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the parent course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project didn't create the corresponding course work, if the user isn't permitted to make the requested modification to the rubric, or for access errors. This error code is also returned if grading has already started on the rubric. * `INVALID_ARGUMENT` if the request is malformed and for the following request error: * `RubricCriteriaInvalidFormat` * `NOT_FOUND` if the requested course, course work, or rubric doesn't exist or if the user doesn't have access to the corresponding course work. * `INTERNAL` if grading has already started on the rubric." }, "create": { "id": "classroom.courses.courseWork.rubrics.create", "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics", "description": "Creates a rubric. The requesting user and course owner must have rubrics creation capabilities. For details, see [licensing requirements](https://developers.google.com/workspace/classroom/rubrics/limitations#license-requirements). For further details, see [Rubrics structure and known limitations](/classroom/rubrics/limitations). This request must be made by the Google Cloud console of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the parent course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user isn't permitted to create rubrics for course work in the requested course. * `INTERNAL` if the request has insufficient OAuth scopes. * `INVALID_ARGUMENT` if the request is malformed and for the following request error: * `RubricCriteriaInvalidFormat` * `NOT_FOUND` if the requested course or course work don't exist or the user doesn't have access to the course or course work. * `FAILED_PRECONDITION` for the following request error: * `AttachmentNotVisible`", "response": { "$ref": "Rubric" }, "parameterOrder": [ "courseId", "courseWorkId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.coursework.students" ], "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics", "parameters": { "courseWorkId": { "required": true, "location": "path", "type": "string", "description": "Required. Identifier of the course work." }, "courseId": { "description": "Required. Identifier of the course.", "required": true, "location": "path", "type": "string" } }, "httpMethod": "POST", "request": { "$ref": "Rubric" } }, "list": { "id": "classroom.courses.courseWork.rubrics.list", "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics", "description": "Returns a list of rubrics that the requester is permitted to view. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work doesn't exist or if the user doesn't have access to the corresponding course work.", "response": { "$ref": "ListRubricsResponse" }, "parameterOrder": [ "courseId", "courseWorkId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.coursework.me", "https://www.googleapis.com/auth/classroom.coursework.me.readonly", "https://www.googleapis.com/auth/classroom.coursework.students", "https://www.googleapis.com/auth/classroom.coursework.students.readonly" ], "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics", "parameters": { "courseWorkId": { "required": true, "location": "path", "type": "string", "description": "Required. Identifier of the course work." }, "pageSize": { "location": "query", "type": "integer", "format": "int32", "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." }, "courseId": { "required": true, "location": "path", "type": "string", "description": "Required. Identifier of the course." }, "pageToken": { "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.", "location": "query", "type": "string" } }, "httpMethod": "GET" } } }, "studentSubmissions": { "methods": { "get": { "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}", "description": "Returns a student submission. * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, course work, or student submission or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.", "id": "classroom.courses.courseWork.studentSubmissions.get", "response": { "$ref": "StudentSubmission" }, "parameterOrder": [ "courseId", "courseWorkId", "id" ], "scopes": [ "https://www.googleapis.com/auth/classroom.coursework.me", "https://www.googleapis.com/auth/classroom.coursework.me.readonly", "https://www.googleapis.com/auth/classroom.coursework.students", "https://www.googleapis.com/auth/classroom.coursework.students.readonly", "https://www.googleapis.com/auth/classroom.student-submissions.me.readonly", "https://www.googleapis.com/auth/classroom.student-submissions.students.readonly" ], "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}", "parameters": { "courseId": { "location": "path", "type": "string", "required": true, "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias." }, "id": { "required": true, "location": "path", "type": "string", "description": "Identifier of the student submission." }, "courseWorkId": { "location": "path", "type": "string", "required": true, "description": "Identifier of the course work." } }, "httpMethod": "GET" }, "reclaim": { "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim", "description": "Reclaims a student submission on behalf of the student that owns it. Reclaiming a student submission transfers ownership of attached Drive files to the student and updates the submission state. Only the student that owns the requested student submission may call this method, and only for a student submission that has been turned in. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, unsubmit the requested student submission, or for access errors. * `FAILED_PRECONDITION` if the student submission has not been turned in. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.", "id": "classroom.courses.courseWork.studentSubmissions.reclaim", "response": { "$ref": "Empty" }, "parameterOrder": [ "courseId", "courseWorkId", "id" ], "scopes": [ "https://www.googleapis.com/auth/classroom.coursework.me" ], "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim", "parameters": { "courseId": { "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "required": true, "location": "path", "type": "string" }, "id": { "location": "path", "type": "string", "required": true, "description": "Identifier of the student submission." }, "courseWorkId": { "description": "Identifier of the course work.", "location": "path", "type": "string", "required": true } }, "httpMethod": "POST", "request": { "$ref": "ReclaimStudentSubmissionRequest" } }, "modifyAttachments": { "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments", "description": "Modifies attachments of student submission. Attachments may only be added to student submissions belonging to course work objects with a `workType` of `ASSIGNMENT`. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, if the user is not permitted to modify attachments on the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.", "id": "classroom.courses.courseWork.studentSubmissions.modifyAttachments", "response": { "$ref": "StudentSubmission" }, "parameterOrder": [ "courseId", "courseWorkId", "id" ], "scopes": [ "https://www.googleapis.com/auth/classroom.coursework.me", "https://www.googleapis.com/auth/classroom.coursework.students" ], "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments", "parameters": { "courseId": { "location": "path", "type": "string", "required": true, "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias." }, "id": { "location": "path", "type": "string", "required": true, "description": "Identifier of the student submission." }, "courseWorkId": { "description": "Identifier of the course work.", "required": true, "location": "path", "type": "string" } }, "httpMethod": "POST", "request": { "$ref": "ModifyAttachmentsRequest" } }, "patch": { "response": { "$ref": "StudentSubmission" }, "id": "classroom.courses.courseWork.studentSubmissions.patch", "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}", "description": "Updates one or more fields of a student submission. See google.classroom.v1.StudentSubmission for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.", "parameterOrder": [ "courseId", "courseWorkId", "id" ], "scopes": [ "https://www.googleapis.com/auth/classroom.coursework.me", "https://www.googleapis.com/auth/classroom.coursework.students" ], "parameters": { "courseWorkId": { "location": "path", "type": "string", "required": true, "description": "Identifier of the course work." }, "updateMask": { "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: * `draft_grade` * `assigned_grade`", "location": "query", "type": "string", "format": "google-fieldmask" }, "courseId": { "location": "path", "type": "string", "required": true, "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias." }, "id": { "description": "Identifier of the student submission.", "location": "path", "type": "string", "required": true } }, "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}", "request": { "$ref": "StudentSubmission" }, "httpMethod": "PATCH" }, "turnIn": { "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn", "parameters": { "courseId": { "location": "path", "type": "string", "required": true, "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias." }, "id": { "description": "Identifier of the student submission.", "required": true, "location": "path", "type": "string" }, "courseWorkId": { "description": "Identifier of the course work.", "required": true, "location": "path", "type": "string" } }, "httpMethod": "POST", "request": { "$ref": "TurnInStudentSubmissionRequest" }, "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn", "description": "Turns in a student submission. Turning in a student submission transfers ownership of attached Drive files to the teacher and may also update the submission state. This may only be called by the student that owns the specified student submission. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, turn in the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.", "id": "classroom.courses.courseWork.studentSubmissions.turnIn", "response": { "$ref": "Empty" }, "parameterOrder": [ "courseId", "courseWorkId", "id" ], "scopes": [ "https://www.googleapis.com/auth/classroom.coursework.me" ] }, "return": { "response": { "$ref": "Empty" }, "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return", "description": "Returns a student submission. Returning a student submission transfers ownership of attached Drive files to the student and may also update the submission state. Unlike the Classroom application, returning a student submission does not set assignedGrade to the draftGrade value. Only a teacher of the course that contains the requested student submission may call this method. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, return the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.", "id": "classroom.courses.courseWork.studentSubmissions.return", "parameterOrder": [ "courseId", "courseWorkId", "id" ], "scopes": [ "https://www.googleapis.com/auth/classroom.coursework.students" ], "parameters": { "courseWorkId": { "description": "Identifier of the course work.", "location": "path", "type": "string", "required": true }, "courseId": { "location": "path", "type": "string", "required": true, "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias." }, "id": { "description": "Identifier of the student submission.", "required": true, "location": "path", "type": "string" } }, "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return", "request": { "$ref": "ReturnStudentSubmissionRequest" }, "httpMethod": "POST" }, "list": { "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions", "parameters": { "pageToken": { "location": "query", "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." }, "late": { "location": "query", "type": "string", "enumDescriptions": [ "No restriction on submission late values specified.", "Return StudentSubmissions where late is true.", "Return StudentSubmissions where late is false." ], "enum": [ "LATE_VALUES_UNSPECIFIED", "LATE_ONLY", "NOT_LATE_ONLY" ], "description": "Requested lateness value. If specified, returned student submissions are restricted by the requested value. If unspecified, submissions are returned regardless of `late` value." }, "states": { "repeated": true, "enumDescriptions": [ "No state specified. This should never be returned.", "The student has never accessed this submission. Attachments are not returned and timestamps is not set.", "Has been created.", "Has been turned in to the teacher.", "Has been returned to the student.", "Student chose to \"unsubmit\" the assignment." ], "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.", "location": "query", "type": "string" }, "courseId": { "location": "path", "type": "string", "required": true, "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias." }, "courseWorkId": { "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.", "required": true, "location": "path", "type": "string" }, "userId": { "location": "query", "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" }, "pageSize": { "location": "query", "type": "integer", "format": "int32", "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." } }, "httpMethod": "GET", "id": "classroom.courses.courseWork.studentSubmissions.list", "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions", "description": "Returns a list of student submissions that the requester is permitted to view, factoring in the OAuth scopes of the request. A hyphen (`-`) may be specified as the `course_work_id` to include student submissions for multiple course work items. Course students may only view their own work. Course teachers and domain administrators may view all student submissions. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.", "response": { "$ref": "ListStudentSubmissionsResponse" }, "parameterOrder": [ "courseId", "courseWorkId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.coursework.me", "https://www.googleapis.com/auth/classroom.coursework.me.readonly", "https://www.googleapis.com/auth/classroom.coursework.students", "https://www.googleapis.com/auth/classroom.coursework.students.readonly", "https://www.googleapis.com/auth/classroom.student-submissions.me.readonly", "https://www.googleapis.com/auth/classroom.student-submissions.students.readonly" ] } } }, "addOnAttachments": { "methods": { "patch": { "request": { "$ref": "AddOnAttachment" }, "httpMethod": "PATCH", "parameters": { "itemId": { "required": true, "location": "path", "type": "string", "description": "Identifier of the post under which the attachment is attached." }, "attachmentId": { "description": "Required. Identifier of the attachment.", "location": "path", "type": "string", "required": true }, "postId": { "location": "query", "type": "string", "description": "Required. Identifier of the post under which the attachment is attached." }, "updateMask": { "location": "query", "type": "string", "format": "google-fieldmask", "description": "Required. Mask that identifies which fields on the attachment to 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 `AddOnAttachment` object. If a field that does not support empty values is included in the update mask and not set in the `AddOnAttachment` object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `teacher_view_uri` * `student_view_uri` * `student_work_review_uri` * `due_date` * `due_time` * `max_points`" }, "courseId": { "description": "Required. Identifier of the course.", "required": true, "location": "path", "type": "string" } }, "path": "v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}", "parameterOrder": [ "courseId", "itemId", "attachmentId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.addons.teacher" ], "response": { "$ref": "AddOnAttachment" }, "id": "classroom.courses.courseWork.addOnAttachments.patch", "flatPath": "v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}", "description": "Updates an add-on attachment. Requires the add-on to have been the original creator of the attachment. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist." }, "list": { "parameterOrder": [ "courseId", "itemId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.addons.student", "https://www.googleapis.com/auth/classroom.addons.teacher" ], "flatPath": "v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments", "description": "Returns all attachments created by an add-on under the post. Requires the add-on to have active attachments on the post or have permission to create new attachments on the post. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.", "id": "classroom.courses.courseWork.addOnAttachments.list", "response": { "$ref": "ListAddOnAttachmentsResponse" }, "httpMethod": "GET", "path": "v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments", "parameters": { "postId": { "deprecated": true, "description": "Optional. Identifier of the post under the course whose attachments to enumerate. Deprecated, use `item_id` instead.", "location": "query", "type": "string" }, "pageSize": { "location": "query", "type": "integer", "format": "int32", "description": "The maximum number of attachments to return. The service may return fewer than this value. If unspecified, at most 20 attachments will be returned. The maximum value is 20; values above 20 will be coerced to 20." }, "courseId": { "required": true, "location": "path", "type": "string", "description": "Required. Identifier of the course." }, "itemId": { "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` whose attachments should be enumerated. This field is required, but is not marked as such while we are migrating from post_id.", "location": "path", "type": "string", "required": true }, "pageToken": { "description": "A page token, received from a previous `ListAddOnAttachments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAddOnAttachments` must match the call that provided the page token.", "location": "query", "type": "string" } } }, "create": { "request": { "$ref": "AddOnAttachment" }, "httpMethod": "POST", "parameters": { "courseId": { "description": "Required. Identifier of the course.", "required": true, "location": "path", "type": "string" }, "itemId": { "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which to create the attachment. This field is required, but is not marked as such while we are migrating from post_id.", "required": true, "location": "path", "type": "string" }, "postId": { "location": "query", "type": "string", "description": "Optional. Deprecated, use `item_id` instead.", "deprecated": true }, "addOnToken": { "description": "Optional. Token that authorizes the request. The token is passed as a query parameter when the user is redirected from Classroom to the add-on's URL. This authorization token is required for in-Classroom attachment creation but optional for partner-first attachment creation. Returns an error if not provided for partner-first attachment creation and the developer projects that created the attachment and its parent stream item do not match.", "location": "query", "type": "string" } }, "path": "v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments", "parameterOrder": [ "courseId", "itemId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.addons.teacher" ], "response": { "$ref": "AddOnAttachment" }, "flatPath": "v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments", "description": "Creates an add-on attachment under a post. Requires the add-on to have permission to create new attachments on the post. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.", "id": "classroom.courses.courseWork.addOnAttachments.create" }, "get": { "parameters": { "courseId": { "description": "Required. Identifier of the course.", "required": true, "location": "path", "type": "string" }, "itemId": { "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.", "required": true, "location": "path", "type": "string" }, "attachmentId": { "description": "Required. Identifier of the attachment.", "location": "path", "type": "string", "required": true }, "postId": { "location": "query", "type": "string", "description": "Optional. Deprecated, use `item_id` instead.", "deprecated": true } }, "path": "v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}", "httpMethod": "GET", "response": { "$ref": "AddOnAttachment" }, "id": "classroom.courses.courseWork.addOnAttachments.get", "flatPath": "v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}", "description": "Returns an add-on attachment. Requires the add-on requesting the attachment to be the original creator of the attachment. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.", "parameterOrder": [ "courseId", "itemId", "attachmentId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.addons.student", "https://www.googleapis.com/auth/classroom.addons.teacher" ] }, "delete": { "parameterOrder": [ "courseId", "itemId", "attachmentId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.addons.teacher" ], "response": { "$ref": "Empty" }, "flatPath": "v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}", "description": "Deletes an add-on attachment. Requires the add-on to have been the original creator of the attachment. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.", "id": "classroom.courses.courseWork.addOnAttachments.delete", "httpMethod": "DELETE", "parameters": { "itemId": { "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.", "required": true, "location": "path", "type": "string" }, "attachmentId": { "description": "Required. Identifier of the attachment.", "required": true, "location": "path", "type": "string" }, "postId": { "deprecated": true, "description": "Optional. Deprecated, use `item_id` instead.", "location": "query", "type": "string" }, "courseId": { "required": true, "location": "path", "type": "string", "description": "Required. Identifier of the course." } }, "path": "v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}" } }, "resources": { "studentSubmissions": { "methods": { "patch": { "parameterOrder": [ "courseId", "itemId", "attachmentId", "submissionId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.addons.teacher" ], "response": { "$ref": "AddOnAttachmentStudentSubmission" }, "id": "classroom.courses.courseWork.addOnAttachments.studentSubmissions.patch", "flatPath": "v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}", "description": "Updates data associated with an add-on attachment submission. Requires the add-on to have been the original creator of the attachment and the attachment to have a positive `max_points` value set. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.", "request": { "$ref": "AddOnAttachmentStudentSubmission" }, "httpMethod": "PATCH", "parameters": { "submissionId": { "description": "Required. Identifier of the student's submission.", "required": true, "location": "path", "type": "string" }, "itemId": { "required": true, "location": "path", "type": "string", "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id." }, "attachmentId": { "description": "Required. Identifier of the attachment.", "required": true, "location": "path", "type": "string" }, "courseId": { "location": "path", "type": "string", "required": true, "description": "Required. Identifier of the course." }, "updateMask": { "description": "Required. Mask that identifies which fields on the attachment to 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 `AddOnAttachmentStudentSubmission` object. The following fields may be specified by teachers: * `points_earned`", "location": "query", "type": "string", "format": "google-fieldmask" }, "postId": { "deprecated": true, "description": "Optional. Deprecated, use `item_id` instead.", "location": "query", "type": "string" } }, "path": "v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}" }, "get": { "parameterOrder": [ "courseId", "itemId", "attachmentId", "submissionId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.addons.student", "https://www.googleapis.com/auth/classroom.addons.teacher", "https://www.googleapis.com/auth/classroom.student-submissions.students.readonly" ], "response": { "$ref": "AddOnAttachmentStudentSubmission" }, "flatPath": "v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}", "description": "Returns a student submission for an add-on attachment. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.", "id": "classroom.courses.courseWork.addOnAttachments.studentSubmissions.get", "httpMethod": "GET", "parameters": { "submissionId": { "description": "Required. Identifier of the student’s submission.", "location": "path", "type": "string", "required": true }, "itemId": { "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.", "required": true, "location": "path", "type": "string" }, "attachmentId": { "required": true, "location": "path", "type": "string", "description": "Required. Identifier of the attachment." }, "postId": { "location": "query", "type": "string", "deprecated": true, "description": "Optional. Deprecated, use `item_id` instead." }, "courseId": { "description": "Required. Identifier of the course.", "required": true, "location": "path", "type": "string" } }, "path": "v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}" } } } } } } }, "announcements": { "methods": { "create": { "id": "classroom.courses.announcements.create", "flatPath": "v1/courses/{courseId}/announcements", "description": "Creates an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create announcements in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible", "response": { "$ref": "Announcement" }, "parameterOrder": [ "courseId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.announcements" ], "path": "v1/courses/{courseId}/announcements", "parameters": { "courseId": { "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "type": "string", "required": true } }, "httpMethod": "POST", "request": { "$ref": "Announcement" } }, "list": { "parameterOrder": [ "courseId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.announcements", "https://www.googleapis.com/auth/classroom.announcements.readonly" ], "id": "classroom.courses.announcements.list", "flatPath": "v1/courses/{courseId}/announcements", "description": "Returns a list of announcements that the requester is permitted to view. Course students may only view `PUBLISHED` announcements. Course teachers and domain administrators may view all announcements. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.", "response": { "$ref": "ListAnnouncementsResponse" }, "httpMethod": "GET", "path": "v1/courses/{courseId}/announcements", "parameters": { "courseId": { "location": "path", "type": "string", "required": true, "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias." }, "orderBy": { "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`", "location": "query", "type": "string" }, "pageSize": { "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.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "location": "query", "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." }, "announcementStates": { "location": "query", "type": "string", "enumDescriptions": [ "No state specified. This is never returned.", "Status for announcement that has been published. This is the default state.", "Status for an announcement that is not yet published. Announcement in this state is visible only to course teachers and domain administrators.", "Status for announcement that was published but is now deleted. Announcement in this state is visible only to course teachers and domain administrators. Announcement in this state is deleted after some time." ], "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`.", "repeated": true } } }, "getAddOnContext": { "id": "classroom.courses.announcements.getAddOnContext", "flatPath": "v1/courses/{courseId}/announcements/{itemId}/addOnContext", "description": "Gets metadata for Classroom add-ons in the context of a specific post. To maintain the integrity of its own data and permissions model, an add-on should call this to validate query parameters and the requesting user's role whenever the add-on is opened in an [iframe](https://developers.google.com/workspace/classroom/add-ons/get-started/iframes/iframes-overview). This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.", "response": { "$ref": "AddOnContext" }, "parameterOrder": [ "courseId", "itemId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.addons.student", "https://www.googleapis.com/auth/classroom.addons.teacher" ], "path": "v1/courses/{courseId}/announcements/{itemId}/addOnContext", "parameters": { "courseId": { "location": "path", "type": "string", "required": true, "description": "Required. Identifier of the course." }, "postId": { "location": "query", "type": "string", "deprecated": true, "description": "Optional. Deprecated, use `item_id` instead." }, "addOnToken": { "description": "Optional. Token that authorizes the request. The token is passed as a query parameter when the user is redirected from Classroom to the add-on's URL. The authorization token is required when neither of the following is true: * The add-on has attachments on the post. * The developer project issuing the request is the same project that created the post.", "location": "query", "type": "string" }, "itemId": { "required": true, "location": "path", "type": "string", "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id." }, "attachmentId": { "location": "query", "type": "string", "description": "Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/workspace/classroom/add-ons/get-started/iframes/attachment-discovery-iframe)." } }, "httpMethod": "GET" }, "modifyAssignees": { "request": { "$ref": "ModifyAnnouncementAssigneesRequest" }, "httpMethod": "POST", "parameters": { "courseId": { "required": true, "location": "path", "type": "string", "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias." }, "id": { "description": "Identifier of the announcement.", "required": true, "location": "path", "type": "string" } }, "path": "v1/courses/{courseId}/announcements/{id}:modifyAssignees", "parameterOrder": [ "courseId", "id" ], "scopes": [ "https://www.googleapis.com/auth/classroom.announcements" ], "response": { "$ref": "Announcement" }, "flatPath": "v1/courses/{courseId}/announcements/{id}:modifyAssignees", "description": "Modifies assignee mode and options of an announcement. Only a teacher of the course that contains the announcement may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist. * `FAILED_PRECONDITION` for the following request error: * EmptyAssignees", "id": "classroom.courses.announcements.modifyAssignees" }, "patch": { "parameterOrder": [ "courseId", "id" ], "scopes": [ "https://www.googleapis.com/auth/classroom.announcements" ], "flatPath": "v1/courses/{courseId}/announcements/{id}", "description": "Updates one or more fields of an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding announcement or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested announcement has already been deleted. * `NOT_FOUND` if the requested course or announcement does not exist", "id": "classroom.courses.announcements.patch", "response": { "$ref": "Announcement" }, "httpMethod": "PATCH", "request": { "$ref": "Announcement" }, "path": "v1/courses/{courseId}/announcements/{id}", "parameters": { "courseId": { "location": "path", "type": "string", "required": true, "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias." }, "id": { "description": "Identifier of the announcement.", "required": true, "location": "path", "type": "string" }, "updateMask": { "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` * `scheduled_time`", "location": "query", "type": "string", "format": "google-fieldmask" } } }, "delete": { "id": "classroom.courses.announcements.delete", "flatPath": "v1/courses/{courseId}/announcements/{id}", "description": "Deletes an announcement. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding announcement item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding announcement, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested announcement has already been deleted. * `NOT_FOUND` if no course exists with the requested ID.", "response": { "$ref": "Empty" }, "parameterOrder": [ "courseId", "id" ], "scopes": [ "https://www.googleapis.com/auth/classroom.announcements" ], "path": "v1/courses/{courseId}/announcements/{id}", "parameters": { "courseId": { "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "type": "string", "required": true }, "id": { "location": "path", "type": "string", "required": true, "description": "Identifier of the announcement to delete. This identifier is a Classroom-assigned identifier." } }, "httpMethod": "DELETE" }, "get": { "httpMethod": "GET", "parameters": { "courseId": { "location": "path", "type": "string", "required": true, "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias." }, "id": { "required": true, "location": "path", "type": "string", "description": "Identifier of the announcement." } }, "path": "v1/courses/{courseId}/announcements/{id}", "parameterOrder": [ "courseId", "id" ], "scopes": [ "https://www.googleapis.com/auth/classroom.announcements", "https://www.googleapis.com/auth/classroom.announcements.readonly" ], "response": { "$ref": "Announcement" }, "flatPath": "v1/courses/{courseId}/announcements/{id}", "description": "Returns an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or announcement, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or announcement does not exist.", "id": "classroom.courses.announcements.get" } }, "resources": { "addOnAttachments": { "methods": { "get": { "parameters": { "courseId": { "description": "Required. Identifier of the course.", "location": "path", "type": "string", "required": true }, "itemId": { "required": true, "location": "path", "type": "string", "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id." }, "attachmentId": { "description": "Required. Identifier of the attachment.", "required": true, "location": "path", "type": "string" }, "postId": { "description": "Optional. Deprecated, use `item_id` instead.", "deprecated": true, "location": "query", "type": "string" } }, "path": "v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}", "httpMethod": "GET", "response": { "$ref": "AddOnAttachment" }, "flatPath": "v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}", "description": "Returns an add-on attachment. Requires the add-on requesting the attachment to be the original creator of the attachment. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.", "id": "classroom.courses.announcements.addOnAttachments.get", "parameterOrder": [ "courseId", "itemId", "attachmentId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.addons.student", "https://www.googleapis.com/auth/classroom.addons.teacher" ] }, "delete": { "path": "v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}", "parameters": { "courseId": { "description": "Required. Identifier of the course.", "required": true, "location": "path", "type": "string" }, "itemId": { "required": true, "location": "path", "type": "string", "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id." }, "attachmentId": { "description": "Required. Identifier of the attachment.", "location": "path", "type": "string", "required": true }, "postId": { "deprecated": true, "description": "Optional. Deprecated, use `item_id` instead.", "location": "query", "type": "string" } }, "httpMethod": "DELETE", "id": "classroom.courses.announcements.addOnAttachments.delete", "flatPath": "v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}", "description": "Deletes an add-on attachment. Requires the add-on to have been the original creator of the attachment. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.", "response": { "$ref": "Empty" }, "parameterOrder": [ "courseId", "itemId", "attachmentId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.addons.teacher" ] }, "patch": { "parameterOrder": [ "courseId", "itemId", "attachmentId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.addons.teacher" ], "response": { "$ref": "AddOnAttachment" }, "flatPath": "v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}", "description": "Updates an add-on attachment. Requires the add-on to have been the original creator of the attachment. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.", "id": "classroom.courses.announcements.addOnAttachments.patch", "request": { "$ref": "AddOnAttachment" }, "httpMethod": "PATCH", "parameters": { "courseId": { "location": "path", "type": "string", "required": true, "description": "Required. Identifier of the course." }, "updateMask": { "location": "query", "type": "string", "format": "google-fieldmask", "description": "Required. Mask that identifies which fields on the attachment to 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 `AddOnAttachment` object. If a field that does not support empty values is included in the update mask and not set in the `AddOnAttachment` object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `teacher_view_uri` * `student_view_uri` * `student_work_review_uri` * `due_date` * `due_time` * `max_points`" }, "postId": { "location": "query", "type": "string", "description": "Required. Identifier of the post under which the attachment is attached." }, "itemId": { "description": "Identifier of the post under which the attachment is attached.", "required": true, "location": "path", "type": "string" }, "attachmentId": { "required": true, "location": "path", "type": "string", "description": "Required. Identifier of the attachment." } }, "path": "v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}" }, "list": { "parameters": { "itemId": { "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` whose attachments should be enumerated. This field is required, but is not marked as such while we are migrating from post_id.", "required": true, "location": "path", "type": "string" }, "pageToken": { "description": "A page token, received from a previous `ListAddOnAttachments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAddOnAttachments` must match the call that provided the page token.", "location": "query", "type": "string" }, "postId": { "description": "Optional. Identifier of the post under the course whose attachments to enumerate. Deprecated, use `item_id` instead.", "deprecated": true, "location": "query", "type": "string" }, "pageSize": { "description": "The maximum number of attachments to return. The service may return fewer than this value. If unspecified, at most 20 attachments will be returned. The maximum value is 20; values above 20 will be coerced to 20.", "location": "query", "type": "integer", "format": "int32" }, "courseId": { "description": "Required. Identifier of the course.", "required": true, "location": "path", "type": "string" } }, "path": "v1/courses/{courseId}/announcements/{itemId}/addOnAttachments", "httpMethod": "GET", "response": { "$ref": "ListAddOnAttachmentsResponse" }, "id": "classroom.courses.announcements.addOnAttachments.list", "flatPath": "v1/courses/{courseId}/announcements/{itemId}/addOnAttachments", "description": "Returns all attachments created by an add-on under the post. Requires the add-on to have active attachments on the post or have permission to create new attachments on the post. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.", "parameterOrder": [ "courseId", "itemId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.addons.student", "https://www.googleapis.com/auth/classroom.addons.teacher" ] }, "create": { "parameters": { "courseId": { "description": "Required. Identifier of the course.", "required": true, "location": "path", "type": "string" }, "itemId": { "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which to create the attachment. This field is required, but is not marked as such while we are migrating from post_id.", "location": "path", "type": "string", "required": true }, "postId": { "location": "query", "type": "string", "deprecated": true, "description": "Optional. Deprecated, use `item_id` instead." }, "addOnToken": { "description": "Optional. Token that authorizes the request. The token is passed as a query parameter when the user is redirected from Classroom to the add-on's URL. This authorization token is required for in-Classroom attachment creation but optional for partner-first attachment creation. Returns an error if not provided for partner-first attachment creation and the developer projects that created the attachment and its parent stream item do not match.", "location": "query", "type": "string" } }, "path": "v1/courses/{courseId}/announcements/{itemId}/addOnAttachments", "request": { "$ref": "AddOnAttachment" }, "httpMethod": "POST", "response": { "$ref": "AddOnAttachment" }, "flatPath": "v1/courses/{courseId}/announcements/{itemId}/addOnAttachments", "description": "Creates an add-on attachment under a post. Requires the add-on to have permission to create new attachments on the post. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.", "id": "classroom.courses.announcements.addOnAttachments.create", "parameterOrder": [ "courseId", "itemId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.addons.teacher" ] } } } } }, "posts": { "methods": { "getAddOnContext": { "response": { "$ref": "AddOnContext" }, "flatPath": "v1/courses/{courseId}/posts/{postId}/addOnContext", "description": "Gets metadata for Classroom add-ons in the context of a specific post. To maintain the integrity of its own data and permissions model, an add-on should call this to validate query parameters and the requesting user's role whenever the add-on is opened in an [iframe](https://developers.google.com/workspace/classroom/add-ons/get-started/iframes/iframes-overview). This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.", "id": "classroom.courses.posts.getAddOnContext", "parameterOrder": [ "courseId", "postId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.addons.student", "https://www.googleapis.com/auth/classroom.addons.teacher" ], "parameters": { "postId": { "description": "Optional. Deprecated, use `item_id` instead.", "required": true, "location": "path", "type": "string" }, "addOnToken": { "location": "query", "type": "string", "description": "Optional. Token that authorizes the request. The token is passed as a query parameter when the user is redirected from Classroom to the add-on's URL. The authorization token is required when neither of the following is true: * The add-on has attachments on the post. * The developer project issuing the request is the same project that created the post." }, "courseId": { "description": "Required. Identifier of the course.", "required": true, "location": "path", "type": "string" }, "itemId": { "location": "query", "type": "string", "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id." }, "attachmentId": { "location": "query", "type": "string", "description": "Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/workspace/classroom/add-ons/get-started/iframes/attachment-discovery-iframe)." } }, "path": "v1/courses/{courseId}/posts/{postId}/addOnContext", "httpMethod": "GET" } }, "resources": { "addOnAttachments": { "methods": { "patch": { "parameterOrder": [ "courseId", "postId", "attachmentId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.addons.teacher" ], "flatPath": "v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}", "description": "Updates an add-on attachment. Requires the add-on to have been the original creator of the attachment. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.", "id": "classroom.courses.posts.addOnAttachments.patch", "response": { "$ref": "AddOnAttachment" }, "httpMethod": "PATCH", "request": { "$ref": "AddOnAttachment" }, "path": "v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}", "parameters": { "courseId": { "description": "Required. Identifier of the course.", "location": "path", "type": "string", "required": true }, "postId": { "location": "path", "type": "string", "required": true, "description": "Required. Identifier of the post under which the attachment is attached." }, "updateMask": { "description": "Required. Mask that identifies which fields on the attachment to 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 `AddOnAttachment` object. If a field that does not support empty values is included in the update mask and not set in the `AddOnAttachment` object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `teacher_view_uri` * `student_view_uri` * `student_work_review_uri` * `due_date` * `due_time` * `max_points`", "location": "query", "type": "string", "format": "google-fieldmask" }, "attachmentId": { "description": "Required. Identifier of the attachment.", "location": "path", "type": "string", "required": true }, "itemId": { "description": "Identifier of the post under which the attachment is attached.", "location": "query", "type": "string" } } }, "list": { "response": { "$ref": "ListAddOnAttachmentsResponse" }, "id": "classroom.courses.posts.addOnAttachments.list", "flatPath": "v1/courses/{courseId}/posts/{postId}/addOnAttachments", "description": "Returns all attachments created by an add-on under the post. Requires the add-on to have active attachments on the post or have permission to create new attachments on the post. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.", "parameterOrder": [ "courseId", "postId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.addons.student", "https://www.googleapis.com/auth/classroom.addons.teacher" ], "parameters": { "pageToken": { "description": "A page token, received from a previous `ListAddOnAttachments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAddOnAttachments` must match the call that provided the page token.", "location": "query", "type": "string" }, "itemId": { "location": "query", "type": "string", "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` whose attachments should be enumerated. This field is required, but is not marked as such while we are migrating from post_id." }, "courseId": { "description": "Required. Identifier of the course.", "required": true, "location": "path", "type": "string" }, "postId": { "description": "Optional. Identifier of the post under the course whose attachments to enumerate. Deprecated, use `item_id` instead.", "required": true, "location": "path", "type": "string" }, "pageSize": { "location": "query", "type": "integer", "format": "int32", "description": "The maximum number of attachments to return. The service may return fewer than this value. If unspecified, at most 20 attachments will be returned. The maximum value is 20; values above 20 will be coerced to 20." } }, "path": "v1/courses/{courseId}/posts/{postId}/addOnAttachments", "httpMethod": "GET" }, "create": { "parameterOrder": [ "courseId", "postId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.addons.teacher" ], "response": { "$ref": "AddOnAttachment" }, "id": "classroom.courses.posts.addOnAttachments.create", "flatPath": "v1/courses/{courseId}/posts/{postId}/addOnAttachments", "description": "Creates an add-on attachment under a post. Requires the add-on to have permission to create new attachments on the post. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.", "request": { "$ref": "AddOnAttachment" }, "httpMethod": "POST", "parameters": { "courseId": { "required": true, "location": "path", "type": "string", "description": "Required. Identifier of the course." }, "postId": { "required": true, "location": "path", "type": "string", "description": "Optional. Deprecated, use `item_id` instead." }, "itemId": { "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which to create the attachment. This field is required, but is not marked as such while we are migrating from post_id.", "location": "query", "type": "string" }, "addOnToken": { "location": "query", "type": "string", "description": "Optional. Token that authorizes the request. The token is passed as a query parameter when the user is redirected from Classroom to the add-on's URL. This authorization token is required for in-Classroom attachment creation but optional for partner-first attachment creation. Returns an error if not provided for partner-first attachment creation and the developer projects that created the attachment and its parent stream item do not match." } }, "path": "v1/courses/{courseId}/posts/{postId}/addOnAttachments" }, "get": { "httpMethod": "GET", "path": "v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}", "parameters": { "postId": { "description": "Optional. Deprecated, use `item_id` instead.", "required": true, "location": "path", "type": "string" }, "attachmentId": { "description": "Required. Identifier of the attachment.", "required": true, "location": "path", "type": "string" }, "itemId": { "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.", "location": "query", "type": "string" }, "courseId": { "description": "Required. Identifier of the course.", "location": "path", "type": "string", "required": true } }, "parameterOrder": [ "courseId", "postId", "attachmentId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.addons.student", "https://www.googleapis.com/auth/classroom.addons.teacher" ], "flatPath": "v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}", "description": "Returns an add-on attachment. Requires the add-on requesting the attachment to be the original creator of the attachment. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.", "id": "classroom.courses.posts.addOnAttachments.get", "response": { "$ref": "AddOnAttachment" } }, "delete": { "httpMethod": "DELETE", "path": "v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}", "parameters": { "courseId": { "description": "Required. Identifier of the course.", "location": "path", "type": "string", "required": true }, "postId": { "required": true, "location": "path", "type": "string", "description": "Optional. Deprecated, use `item_id` instead." }, "attachmentId": { "description": "Required. Identifier of the attachment.", "required": true, "location": "path", "type": "string" }, "itemId": { "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.", "location": "query", "type": "string" } }, "parameterOrder": [ "courseId", "postId", "attachmentId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.addons.teacher" ], "flatPath": "v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}", "description": "Deletes an add-on attachment. Requires the add-on to have been the original creator of the attachment. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.", "id": "classroom.courses.posts.addOnAttachments.delete", "response": { "$ref": "Empty" } } }, "resources": { "studentSubmissions": { "methods": { "patch": { "parameterOrder": [ "courseId", "postId", "attachmentId", "submissionId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.addons.teacher" ], "flatPath": "v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}", "description": "Updates data associated with an add-on attachment submission. Requires the add-on to have been the original creator of the attachment and the attachment to have a positive `max_points` value set. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.", "id": "classroom.courses.posts.addOnAttachments.studentSubmissions.patch", "response": { "$ref": "AddOnAttachmentStudentSubmission" }, "httpMethod": "PATCH", "request": { "$ref": "AddOnAttachmentStudentSubmission" }, "path": "v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}", "parameters": { "submissionId": { "required": true, "location": "path", "type": "string", "description": "Required. Identifier of the student's submission." }, "attachmentId": { "description": "Required. Identifier of the attachment.", "required": true, "location": "path", "type": "string" }, "itemId": { "location": "query", "type": "string", "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id." }, "courseId": { "location": "path", "type": "string", "required": true, "description": "Required. Identifier of the course." }, "updateMask": { "location": "query", "type": "string", "format": "google-fieldmask", "description": "Required. Mask that identifies which fields on the attachment to 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 `AddOnAttachmentStudentSubmission` object. The following fields may be specified by teachers: * `points_earned`" }, "postId": { "location": "path", "type": "string", "required": true, "description": "Optional. Deprecated, use `item_id` instead." } } }, "get": { "httpMethod": "GET", "path": "v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}", "parameters": { "attachmentId": { "description": "Required. Identifier of the attachment.", "required": true, "location": "path", "type": "string" }, "itemId": { "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.", "location": "query", "type": "string" }, "submissionId": { "required": true, "location": "path", "type": "string", "description": "Required. Identifier of the student’s submission." }, "postId": { "description": "Optional. Deprecated, use `item_id` instead.", "location": "path", "type": "string", "required": true }, "courseId": { "description": "Required. Identifier of the course.", "location": "path", "type": "string", "required": true } }, "parameterOrder": [ "courseId", "postId", "attachmentId", "submissionId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.addons.student", "https://www.googleapis.com/auth/classroom.addons.teacher", "https://www.googleapis.com/auth/classroom.student-submissions.students.readonly" ], "flatPath": "v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}", "description": "Returns a student submission for an add-on attachment. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.", "id": "classroom.courses.posts.addOnAttachments.studentSubmissions.get", "response": { "$ref": "AddOnAttachmentStudentSubmission" } } } } } } } } } }, "userProfiles": { "methods": { "get": { "id": "classroom.userProfiles.get", "flatPath": "v1/userProfiles/{userId}", "description": "Returns a user profile. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access this user profile, if no profile exists with the requested ID, or for access errors.", "response": { "$ref": "UserProfile" }, "parameterOrder": [ "userId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.profile.emails", "https://www.googleapis.com/auth/classroom.profile.photos", "https://www.googleapis.com/auth/classroom.rosters", "https://www.googleapis.com/auth/classroom.rosters.readonly" ], "path": "v1/userProfiles/{userId}", "parameters": { "userId": { "required": true, "location": "path", "type": "string", "description": "Identifier of the profile to return. 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" } }, "httpMethod": "GET" } }, "resources": { "guardians": { "methods": { "list": { "response": { "$ref": "ListGuardiansResponse" }, "flatPath": "v1/userProfiles/{studentId}/guardians", "description": "Returns a list of guardians that the requesting user is permitted to view, restricted to those that match the request. To list guardians for any student that the requesting user may view guardians for, use the literal character `-` for the student ID. This method returns the following error codes: * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting user is not permitted to view guardian information for that student, if `\"-\"` is specified as the `student_id` and the user is not a domain administrator, if guardians are not enabled for the domain in question, if the `invited_email_address` filter is set by a user who is not a domain administrator, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). May also be returned if an invalid `page_token` is provided. * `NOT_FOUND` if a `student_id` is specified, and its format can be recognized, but Classroom has no record of that student.", "id": "classroom.userProfiles.guardians.list", "parameterOrder": [ "studentId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly", "https://www.googleapis.com/auth/classroom.guardianlinks.students", "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly" ], "parameters": { "pageToken": { "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.", "location": "query", "type": "string" }, "studentId": { "description": "Filter results by the student who the guardian is linked to. 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 * the string literal `\"-\"`, indicating that results should be returned for all students that the requesting user has access to view.", "location": "path", "type": "string", "required": true }, "invitedEmailAddress": { "location": "query", "type": "string", "description": "Filter results by the email address that the original invitation was sent to, resulting in this guardian link. This filter can only be used by domain administrators." }, "pageSize": { "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.", "location": "query", "type": "integer", "format": "int32" } }, "path": "v1/userProfiles/{studentId}/guardians", "httpMethod": "GET" }, "get": { "parameterOrder": [ "studentId", "guardianId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly", "https://www.googleapis.com/auth/classroom.guardianlinks.students", "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly" ], "response": { "$ref": "Guardian" }, "id": "classroom.userProfiles.guardians.get", "flatPath": "v1/userProfiles/{studentId}/guardians/{guardianId}", "description": "Returns a specific guardian. This method returns the following error codes: * `PERMISSION_DENIED` if no user that matches the provided `student_id` is visible to the requesting user, if the requesting user is not permitted to view guardian information for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). * `NOT_FOUND` if the requesting user is permitted to view guardians for the requested `student_id`, but no `Guardian` record exists for that student that matches the provided `guardian_id`.", "httpMethod": "GET", "parameters": { "studentId": { "description": "The student whose guardian is being requested. One of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user", "required": true, "location": "path", "type": "string" }, "guardianId": { "location": "path", "type": "string", "required": true, "description": "The `id` field from a `Guardian`." } }, "path": "v1/userProfiles/{studentId}/guardians/{guardianId}" }, "delete": { "parameterOrder": [ "studentId", "guardianId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.guardianlinks.students" ], "response": { "$ref": "Empty" }, "flatPath": "v1/userProfiles/{studentId}/guardians/{guardianId}", "description": "Deletes a guardian. The guardian will no longer receive guardian notifications and the guardian will no longer be accessible via the API. This method returns the following error codes: * `PERMISSION_DENIED` if no user that matches the provided `student_id` is visible to the requesting user, if the requesting user is not permitted to manage guardians for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API). * `NOT_FOUND` if the requesting user is permitted to modify guardians for the requested `student_id`, but no `Guardian` record exists for that student with the provided `guardian_id`.", "id": "classroom.userProfiles.guardians.delete", "httpMethod": "DELETE", "parameters": { "guardianId": { "description": "The `id` field from a `Guardian`.", "location": "path", "type": "string", "required": true }, "studentId": { "required": true, "location": "path", "type": "string", "description": "The student whose guardian is to be deleted. One of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user" } }, "path": "v1/userProfiles/{studentId}/guardians/{guardianId}" } } }, "guardianInvitations": { "methods": { "list": { "response": { "$ref": "ListGuardianInvitationsResponse" }, "id": "classroom.userProfiles.guardianInvitations.list", "flatPath": "v1/userProfiles/{studentId}/guardianInvitations", "description": "Returns a list of guardian invitations that the requesting user is permitted to view, filtered by the parameters provided. This method returns the following error codes: * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting user is not permitted to view guardian invitations for that student, if `\"-\"` is specified as the `student_id` and the user is not a domain administrator, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). May also be returned if an invalid `page_token` or `state` is provided. * `NOT_FOUND` if a `student_id` is specified, and its format can be recognized, but Classroom has no record of that student.", "parameterOrder": [ "studentId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.guardianlinks.students", "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly" ], "parameters": { "pageToken": { "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.", "location": "query", "type": "string" }, "states": { "repeated": true, "description": "If specified, only results with the specified `state` values are returned. Otherwise, results with a `state` of `PENDING` are returned.", "enumDescriptions": [ "Should never be returned.", "The invitation is active and awaiting a response.", "The invitation is no longer active. It may have been accepted, declined, withdrawn or it may have expired." ], "enum": [ "GUARDIAN_INVITATION_STATE_UNSPECIFIED", "PENDING", "COMPLETE" ], "location": "query", "type": "string" }, "studentId": { "description": "The ID of the student whose guardian invitations are to be returned. 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 * the string literal `\"-\"`, indicating that results should be returned for all students that the requesting user is permitted to view guardian invitations.", "required": true, "location": "path", "type": "string" }, "invitedEmailAddress": { "description": "If specified, only results with the specified `invited_email_address` are returned.", "location": "query", "type": "string" }, "pageSize": { "location": "query", "type": "integer", "format": "int32", "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." } }, "path": "v1/userProfiles/{studentId}/guardianInvitations", "httpMethod": "GET" }, "create": { "parameters": { "studentId": { "description": "ID of the student (in standard format)", "required": true, "location": "path", "type": "string" } }, "path": "v1/userProfiles/{studentId}/guardianInvitations", "request": { "$ref": "GuardianInvitation" }, "httpMethod": "POST", "response": { "$ref": "GuardianInvitation" }, "flatPath": "v1/userProfiles/{studentId}/guardianInvitations", "description": "Creates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student's guardian. Once the guardian accepts the invitation, their `state` will change to `COMPLETED` and they will start receiving guardian notifications. A `Guardian` resource will also be created to represent the active guardian. The request object must have the `student_id` and `invited_email_address` fields set. Failing to set these fields, or setting any other fields in the request, will result in an error. This method returns the following error codes: * `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if the guardian in question has already rejected too many requests for that student, if guardians are not enabled for the domain in question, or for other access errors. * `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian link limit. * `INVALID_ARGUMENT` if the guardian email address is not valid (for example, if it is too long), or if the format of the student ID provided cannot be recognized (it is not an email address, nor a `user_id` from this API). This error will also be returned if read-only fields are set, or if the `state` field is set to to a value other than `PENDING`. * `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student. * `ALREADY_EXISTS` if there is already a pending guardian invitation for the student and `invited_email_address` provided, or if the provided `invited_email_address` matches the Google account of an existing `Guardian` for this user.", "id": "classroom.userProfiles.guardianInvitations.create", "parameterOrder": [ "studentId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.guardianlinks.students" ] }, "get": { "httpMethod": "GET", "parameters": { "studentId": { "location": "path", "type": "string", "required": true, "description": "The ID of the student whose guardian invitation is being requested." }, "invitationId": { "location": "path", "type": "string", "required": true, "description": "The `id` field of the `GuardianInvitation` being requested." } }, "path": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}", "parameterOrder": [ "studentId", "invitationId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.guardianlinks.students", "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly" ], "response": { "$ref": "GuardianInvitation" }, "id": "classroom.userProfiles.guardianInvitations.get", "flatPath": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}", "description": "Returns a specific guardian invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view guardian invitations for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). * `NOT_FOUND` if Classroom cannot find any record of the given student or `invitation_id`. May also be returned if the student exists, but the requesting user does not have access to see that student." }, "patch": { "response": { "$ref": "GuardianInvitation" }, "flatPath": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}", "description": "Modifies a guardian invitation. Currently, the only valid modification is to change the `state` from `PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if guardians are not enabled for the domain in question or for other access errors. * `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state. * `INVALID_ARGUMENT` if the format of the student ID provided cannot be recognized (it is not an email address, nor a `user_id` from this API), or if the passed `GuardianInvitation` has a `state` other than `COMPLETE`, or if it modifies fields other than `state`. * `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student, or if the `id` field does not refer to a guardian invitation known to Classroom.", "id": "classroom.userProfiles.guardianInvitations.patch", "parameterOrder": [ "studentId", "invitationId" ], "scopes": [ "https://www.googleapis.com/auth/classroom.guardianlinks.students" ], "parameters": { "studentId": { "location": "path", "type": "string", "required": true, "description": "The ID of the student whose guardian invitation is to be modified." }, "updateMask": { "description": "Mask that identifies which fields on the course to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields are valid: * `state` When set in a query parameter, this field should be specified as `updateMask=,,...`", "location": "query", "type": "string", "format": "google-fieldmask" }, "invitationId": { "description": "The `id` field of the `GuardianInvitation` to be modified.", "location": "path", "type": "string", "required": true } }, "path": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}", "request": { "$ref": "GuardianInvitation" }, "httpMethod": "PATCH" } } } } } }, "protocol": "rest", "servicePath": "", "discoveryVersion": "v1", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "kind": "discovery#restDescription", "revision": "20260414", "rootUrl": "https://classroom.googleapis.com/", "id": "classroom:v1", "documentationLink": "https://developers.google.com/workspace/classroom/", "title": "Google Classroom API", "basePath": "", "mtlsRootUrl": "https://classroom.mtls.googleapis.com/" }