| Index: discovery/googleapis/classroom__v1.json
|
| diff --git a/discovery/googleapis/classroom__v1.json b/discovery/googleapis/classroom__v1.json
|
| index 14d7840aa4b41a0abe58ef9a5bdb0ad4e604dbaf..ce4231d8c488b2505543317c42745c6cc562366f 100644
|
| --- a/discovery/googleapis/classroom__v1.json
|
| +++ b/discovery/googleapis/classroom__v1.json
|
| @@ -2,6 +2,24 @@
|
| "auth": {
|
| "oauth2": {
|
| "scopes": {
|
| + "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.student-submissions.me.readonly": {
|
| + "description": "View your course work and grades in Google Classroom"
|
| + },
|
| + "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.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.guardianlinks.me.readonly": {
|
| + "description": "View your Google Classroom guardians"
|
| + },
|
| + "https://www.googleapis.com/auth/classroom.coursework.me.readonly": {
|
| + "description": "View your course work and grades in Google Classroom"
|
| + },
|
| "https://www.googleapis.com/auth/classroom.profile.emails": {
|
| "description": "View the email addresses of people in your classes"
|
| },
|
| @@ -28,24 +46,6 @@
|
| },
|
| "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.student-submissions.me.readonly": {
|
| - "description": "View your course work and grades in Google Classroom"
|
| - },
|
| - "https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly": {
|
| - "description": "View your Google Classroom guardians"
|
| - },
|
| - "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.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.coursework.me.readonly": {
|
| - "description": "View your course work and grades in Google Classroom"
|
| }
|
| }
|
| }
|
| @@ -66,37 +66,6 @@
|
| "ownerDomain": "google.com",
|
| "ownerName": "Google",
|
| "parameters": {
|
| - "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.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "access_token": {
|
| - "description": "OAuth access token.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "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.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "pp": {
|
| - "default": "true",
|
| - "description": "Pretty-print response.",
|
| - "location": "query",
|
| - "type": "boolean"
|
| - },
|
| - "oauth_token": {
|
| - "description": "OAuth 2.0 token for the current user.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "bearer_token": {
|
| - "description": "OAuth bearer token.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| "upload_protocol": {
|
| "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
|
| "location": "query",
|
| @@ -151,6 +120,37 @@
|
| ],
|
| "location": "query",
|
| "type": "string"
|
| + },
|
| + "access_token": {
|
| + "description": "OAuth access token.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "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.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "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.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "pp": {
|
| + "default": "true",
|
| + "description": "Pretty-print response.",
|
| + "location": "query",
|
| + "type": "boolean"
|
| + },
|
| + "oauth_token": {
|
| + "description": "OAuth 2.0 token for the current user.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "bearer_token": {
|
| + "description": "OAuth bearer token.",
|
| + "location": "query",
|
| + "type": "string"
|
| }
|
| },
|
| "protocol": "rest",
|
| @@ -285,6 +285,97 @@
|
| },
|
| "courses": {
|
| "methods": {
|
| + "delete": {
|
| + "description": "Deletes a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.",
|
| + "httpMethod": "DELETE",
|
| + "id": "classroom.courses.delete",
|
| + "parameterOrder": [
|
| + "id"
|
| + ],
|
| + "parameters": {
|
| + "id": {
|
| + "description": "Identifier of the course to delete.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "v1/courses/{id}",
|
| + "response": {
|
| + "$ref": "Empty"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/classroom.courses"
|
| + ]
|
| + },
|
| + "list": {
|
| + "description": "Returns a list of courses that the requesting user is permitted to view,\nrestricted to those that match the request.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` for access errors.\n* `INVALID_ARGUMENT` if the query argument is malformed.\n* `NOT_FOUND` if any users specified in the query arguments do not exist.",
|
| + "httpMethod": "GET",
|
| + "id": "classroom.courses.list",
|
| + "parameterOrder": [],
|
| + "parameters": {
|
| + "studentId": {
|
| + "description": "Restricts returned courses to those having a student with the specified\nidentifier. The identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "pageToken": {
|
| + "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request must be\notherwise 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\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
|
| + "format": "int32",
|
| + "location": "query",
|
| + "type": "integer"
|
| + },
|
| + "teacherId": {
|
| + "description": "Restricts returned courses to those having a teacher with the specified\nidentifier. The identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "courseStates": {
|
| + "description": "Restricts returned courses to those in one of the specified states\nThe default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED.",
|
| + "enum": [
|
| + "COURSE_STATE_UNSPECIFIED",
|
| + "ACTIVE",
|
| + "ARCHIVED",
|
| + "PROVISIONED",
|
| + "DECLINED",
|
| + "SUSPENDED"
|
| + ],
|
| + "location": "query",
|
| + "repeated": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "v1/courses",
|
| + "response": {
|
| + "$ref": "ListCoursesResponse"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/classroom.courses",
|
| + "https://www.googleapis.com/auth/classroom.courses.readonly"
|
| + ]
|
| + },
|
| + "create": {
|
| + "description": "Creates a course.\n\nThe user specified in `ownerId` is the owner of the created course\nand added as a teacher.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\ncourses or for access errors.\n* `NOT_FOUND` if the primary teacher is not a valid user.\n* `FAILED_PRECONDITION` if the course owner's account is disabled or for\nthe following request errors:\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if an alias was specified in the `id` and\nalready exists.",
|
| + "httpMethod": "POST",
|
| + "id": "classroom.courses.create",
|
| + "parameterOrder": [],
|
| + "parameters": {},
|
| + "path": "v1/courses",
|
| + "request": {
|
| + "$ref": "Course"
|
| + },
|
| + "response": {
|
| + "$ref": "Course"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/classroom.courses"
|
| + ]
|
| + },
|
| "get": {
|
| "description": "Returns a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.",
|
| "httpMethod": "GET",
|
| @@ -366,132 +457,143 @@
|
| "scopes": [
|
| "https://www.googleapis.com/auth/classroom.courses"
|
| ]
|
| - },
|
| - "delete": {
|
| - "description": "Deletes a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.",
|
| - "httpMethod": "DELETE",
|
| - "id": "classroom.courses.delete",
|
| - "parameterOrder": [
|
| - "id"
|
| - ],
|
| - "parameters": {
|
| - "id": {
|
| - "description": "Identifier of the course to delete.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - }
|
| - },
|
| - "path": "v1/courses/{id}",
|
| - "response": {
|
| - "$ref": "Empty"
|
| - },
|
| - "scopes": [
|
| - "https://www.googleapis.com/auth/classroom.courses"
|
| - ]
|
| - },
|
| - "list": {
|
| - "description": "Returns a list of courses that the requesting user is permitted to view,\nrestricted to those that match the request.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` for access errors.\n* `INVALID_ARGUMENT` if the query argument is malformed.\n* `NOT_FOUND` if any users specified in the query arguments do not exist.",
|
| - "httpMethod": "GET",
|
| - "id": "classroom.courses.list",
|
| - "parameterOrder": [],
|
| - "parameters": {
|
| - "teacherId": {
|
| - "description": "Restricts returned courses to those having a teacher with the specified\nidentifier. The identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "courseStates": {
|
| - "description": "Restricts returned courses to those in one of the specified states\nThe default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED.",
|
| - "enum": [
|
| - "COURSE_STATE_UNSPECIFIED",
|
| - "ACTIVE",
|
| - "ARCHIVED",
|
| - "PROVISIONED",
|
| - "DECLINED",
|
| - "SUSPENDED"
|
| + }
|
| + },
|
| + "resources": {
|
| + "teachers": {
|
| + "methods": {
|
| + "get": {
|
| + "description": "Returns a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view\nteachers of this course or for access errors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if the\ncourse does not exist.",
|
| + "httpMethod": "GET",
|
| + "id": "classroom.courses.teachers.get",
|
| + "parameterOrder": [
|
| + "courseId",
|
| + "userId"
|
| ],
|
| - "location": "query",
|
| - "repeated": true,
|
| - "type": "string"
|
| - },
|
| - "studentId": {
|
| - "description": "Restricts returned courses to those having a student with the specified\nidentifier. The identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "pageToken": {
|
| - "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.",
|
| - "location": "query",
|
| - "type": "string"
|
| + "parameters": {
|
| + "courseId": {
|
| + "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "userId": {
|
| + "description": "Identifier of the teacher to return. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "v1/courses/{courseId}/teachers/{userId}",
|
| + "response": {
|
| + "$ref": "Teacher"
|
| + },
|
| + "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"
|
| + ]
|
| + },
|
| + "list": {
|
| + "description": "Returns a list of teachers of this course that the requester\nis permitted to view.\n\nThis method returns the following error codes:\n\n* `NOT_FOUND` if the course does not exist.\n* `PERMISSION_DENIED` for access errors.",
|
| + "httpMethod": "GET",
|
| + "id": "classroom.courses.teachers.list",
|
| + "parameterOrder": [
|
| + "courseId"
|
| + ],
|
| + "parameters": {
|
| + "pageToken": {
|
| + "description": "nextPageToken\nvalue returned from a previous\nlist call, indicating that\nthe subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "pageSize": {
|
| + "description": "Maximum number of items to return. Zero means no maximum.\n\nThe server may return fewer than the specified number of results.",
|
| + "format": "int32",
|
| + "location": "query",
|
| + "type": "integer"
|
| + },
|
| + "courseId": {
|
| + "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "v1/courses/{courseId}/teachers",
|
| + "response": {
|
| + "$ref": "ListTeachersResponse"
|
| + },
|
| + "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"
|
| + ]
|
| + },
|
| + "create": {
|
| + "description": "Creates a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\nteachers in this course or for access errors.\n* `NOT_FOUND` if the requested course ID does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled,\nfor the following request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * CourseTeacherLimitReached\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if the user is already a teacher or student in the\ncourse.",
|
| + "httpMethod": "POST",
|
| + "id": "classroom.courses.teachers.create",
|
| + "parameterOrder": [
|
| + "courseId"
|
| + ],
|
| + "parameters": {
|
| + "courseId": {
|
| + "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "v1/courses/{courseId}/teachers",
|
| + "request": {
|
| + "$ref": "Teacher"
|
| + },
|
| + "response": {
|
| + "$ref": "Teacher"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/classroom.profile.emails",
|
| + "https://www.googleapis.com/auth/classroom.profile.photos",
|
| + "https://www.googleapis.com/auth/classroom.rosters"
|
| + ]
|
| },
|
| - "pageSize": {
|
| - "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
|
| - "format": "int32",
|
| - "location": "query",
|
| - "type": "integer"
|
| - }
|
| - },
|
| - "path": "v1/courses",
|
| - "response": {
|
| - "$ref": "ListCoursesResponse"
|
| - },
|
| - "scopes": [
|
| - "https://www.googleapis.com/auth/classroom.courses",
|
| - "https://www.googleapis.com/auth/classroom.courses.readonly"
|
| - ]
|
| - },
|
| - "create": {
|
| - "description": "Creates a course.\n\nThe user specified in `ownerId` is the owner of the created course\nand added as a teacher.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\ncourses or for access errors.\n* `NOT_FOUND` if the primary teacher is not a valid user.\n* `FAILED_PRECONDITION` if the course owner's account is disabled or for\nthe following request errors:\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if an alias was specified in the `id` and\nalready exists.",
|
| - "httpMethod": "POST",
|
| - "id": "classroom.courses.create",
|
| - "parameterOrder": [],
|
| - "parameters": {},
|
| - "path": "v1/courses",
|
| - "request": {
|
| - "$ref": "Course"
|
| - },
|
| - "response": {
|
| - "$ref": "Course"
|
| - },
|
| - "scopes": [
|
| - "https://www.googleapis.com/auth/classroom.courses"
|
| - ]
|
| - }
|
| - },
|
| - "resources": {
|
| - "aliases": {
|
| - "methods": {
|
| "delete": {
|
| - "description": "Deletes an alias of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to remove the\nalias or for access errors.\n* `NOT_FOUND` if the alias does not exist.\n* `FAILED_PRECONDITION` if the alias requested does not make sense for the\n requesting user or course (for example, if a user not in a domain\n attempts to delete a domain-scoped alias).",
|
| + "description": "Deletes a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete\nteachers of this course or for access errors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if the\ncourse does not exist.\n* `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher\nof this course.",
|
| "httpMethod": "DELETE",
|
| - "id": "classroom.courses.aliases.delete",
|
| + "id": "classroom.courses.teachers.delete",
|
| "parameterOrder": [
|
| "courseId",
|
| - "alias"
|
| + "userId"
|
| ],
|
| "parameters": {
|
| - "courseId": {
|
| - "description": "Identifier of the course whose alias should be deleted.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| + "userId": {
|
| + "description": "Identifier of the teacher to delete. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "alias": {
|
| - "description": "Alias to delete.\nThis may not be the Classroom-assigned identifier.",
|
| + "courseId": {
|
| + "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/courses/{courseId}/aliases/{alias}",
|
| + "path": "v1/courses/{courseId}/teachers/{userId}",
|
| "response": {
|
| "$ref": "Empty"
|
| },
|
| "scopes": [
|
| - "https://www.googleapis.com/auth/classroom.courses"
|
| + "https://www.googleapis.com/auth/classroom.rosters"
|
| ]
|
| - },
|
| + }
|
| + }
|
| + },
|
| + "aliases": {
|
| + "methods": {
|
| "list": {
|
| "description": "Returns a list of aliases for a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\ncourse or for access errors.\n* `NOT_FOUND` if the course does not exist.",
|
| "httpMethod": "GET",
|
| @@ -552,6 +654,36 @@
|
| "scopes": [
|
| "https://www.googleapis.com/auth/classroom.courses"
|
| ]
|
| + },
|
| + "delete": {
|
| + "description": "Deletes an alias of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to remove the\nalias or for access errors.\n* `NOT_FOUND` if the alias does not exist.\n* `FAILED_PRECONDITION` if the alias requested does not make sense for the\n requesting user or course (for example, if a user not in a domain\n attempts to delete a domain-scoped alias).",
|
| + "httpMethod": "DELETE",
|
| + "id": "classroom.courses.aliases.delete",
|
| + "parameterOrder": [
|
| + "courseId",
|
| + "alias"
|
| + ],
|
| + "parameters": {
|
| + "alias": {
|
| + "description": "Alias to delete.\nThis may not be the Classroom-assigned identifier.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "courseId": {
|
| + "description": "Identifier of the course whose alias should be deleted.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "v1/courses/{courseId}/aliases/{alias}",
|
| + "response": {
|
| + "$ref": "Empty"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/classroom.courses"
|
| + ]
|
| }
|
| }
|
| },
|
| @@ -566,14 +698,14 @@
|
| "userId"
|
| ],
|
| "parameters": {
|
| - "courseId": {
|
| - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| + "userId": {
|
| + "description": "Identifier of the student to delete. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "userId": {
|
| - "description": "Identifier of the student to delete. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
|
| + "courseId": {
|
| + "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| @@ -733,12 +865,6 @@
|
| "id"
|
| ],
|
| "parameters": {
|
| - "updateMask": {
|
| - "description": "Mask that identifies which fields on the course work to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified. If a field supports empty values, it can be cleared\nby specifying it in the update mask and not in the CourseWork object. If a\nfield that does not support empty values is included in the update mask and\nnot set in the CourseWork object, an `INVALID_ARGUMENT` error will be\nreturned.\n\nThe following fields may be specified by teachers:\n* `title`\n* `description`\n* `state`\n* `due_date`\n* `due_time`\n* `max_points`\n* `submission_modification_mode`",
|
| - "format": "google-fieldmask",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| "courseId": {
|
| "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| "location": "path",
|
| @@ -750,6 +876,12 @@
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| + },
|
| + "updateMask": {
|
| + "description": "Mask that identifies which fields on the course work to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified. If a field supports empty values, it can be cleared\nby specifying it in the update mask and not in the CourseWork object. If a\nfield that does not support empty values is included in the update mask and\nnot set in the CourseWork object, an `INVALID_ARGUMENT` error will be\nreturned.\n\nThe following fields may be specified by teachers:\n* `title`\n* `description`\n* `state`\n* `due_date`\n* `due_time`\n* `max_points`\n* `submission_modification_mode`",
|
| + "format": "google-fieldmask",
|
| + "location": "query",
|
| + "type": "string"
|
| }
|
| },
|
| "path": "v1/courses/{courseId}/courseWork/{id}",
|
| @@ -880,10 +1012,10 @@
|
| "resources": {
|
| "studentSubmissions": {
|
| "methods": {
|
| - "get": {
|
| - "description": "Returns a student submission.\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course, course work, or student submission or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
|
| - "httpMethod": "GET",
|
| - "id": "classroom.courses.courseWork.studentSubmissions.get",
|
| + "turnIn": {
|
| + "description": "Turns in a student submission.\n\nTurning in a student submission transfers ownership of attached Drive\nfiles to the teacher and may also update the submission state.\n\nThis may only be called by the student that owns the specified student\nsubmission.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, turn in the requested student submission,\nor for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
|
| + "httpMethod": "POST",
|
| + "id": "classroom.courses.courseWork.studentSubmissions.turnIn",
|
| "parameterOrder": [
|
| "courseId",
|
| "courseWorkId",
|
| @@ -909,23 +1041,21 @@
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
|
| + "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn",
|
| + "request": {
|
| + "$ref": "TurnInStudentSubmissionRequest"
|
| + },
|
| "response": {
|
| - "$ref": "StudentSubmission"
|
| + "$ref": "Empty"
|
| },
|
| "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"
|
| + "https://www.googleapis.com/auth/classroom.coursework.me"
|
| ]
|
| },
|
| - "patch": {
|
| - "description": "Updates one or more fields of a student submission.\n\nSee google.classroom.v1.StudentSubmission for details\nof which fields may be updated and who may change them.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding course work, if the user is not permitted to make the\nrequested modification to the student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
|
| - "httpMethod": "PATCH",
|
| - "id": "classroom.courses.courseWork.studentSubmissions.patch",
|
| + "modifyAttachments": {
|
| + "description": "Modifies attachments of student submission.\n\nAttachments may only be added to student submissions belonging to course\nwork objects with a `workType` of `ASSIGNMENT`.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, if the user is not permitted to modify\nattachments on the requested student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
|
| + "httpMethod": "POST",
|
| + "id": "classroom.courses.courseWork.studentSubmissions.modifyAttachments",
|
| "parameterOrder": [
|
| "courseId",
|
| "courseWorkId",
|
| @@ -949,17 +1079,11 @@
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| - },
|
| - "updateMask": {
|
| - "description": "Mask that identifies which fields on the student submission to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified.\n\nThe following fields may be specified by teachers:\n* `draft_grade`\n* `assigned_grade`",
|
| - "format": "google-fieldmask",
|
| - "location": "query",
|
| - "type": "string"
|
| }
|
| },
|
| - "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
|
| + "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments",
|
| "request": {
|
| - "$ref": "StudentSubmission"
|
| + "$ref": "ModifyAttachmentsRequest"
|
| },
|
| "response": {
|
| "$ref": "StudentSubmission"
|
| @@ -969,18 +1093,17 @@
|
| "https://www.googleapis.com/auth/classroom.coursework.students"
|
| ]
|
| },
|
| - "return": {
|
| - "description": "Returns a student submission.\n\nReturning a student submission transfers ownership of attached Drive\nfiles to the student and may also update the submission state.\nUnlike the Classroom application, returning a student submission does not\nset assignedGrade to the draftGrade value.\n\nOnly a teacher of the course that contains the requested student submission\nmay call this method.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, return the requested student submission,\nor for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
|
| - "httpMethod": "POST",
|
| - "id": "classroom.courses.courseWork.studentSubmissions.return",
|
| + "list": {
|
| + "description": "Returns a list of student submissions that the requester is permitted to\nview, factoring in the OAuth scopes of the request.\n`-` may be specified as the `course_work_id` to include student\nsubmissions for multiple course work items.\n\nCourse students may only view their own work. Course teachers\nand domain administrators may view all student submissions.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.",
|
| + "httpMethod": "GET",
|
| + "id": "classroom.courses.courseWork.studentSubmissions.list",
|
| "parameterOrder": [
|
| "courseId",
|
| - "courseWorkId",
|
| - "id"
|
| + "courseWorkId"
|
| ],
|
| "parameters": {
|
| "courseWorkId": {
|
| - "description": "Identifier of the course work.",
|
| + "description": "Identifer of the student work to request.\nThis may be set to the string literal `\"-\"` to request student work for\nall course work in the specified course.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| @@ -991,28 +1114,64 @@
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "id": {
|
| - "description": "Identifier of the student submission.",
|
| - "location": "path",
|
| - "required": true,
|
| + "late": {
|
| + "description": "Requested lateness value. If specified, returned student submissions are\nrestricted by the requested value.\nIf unspecified, submissions are returned regardless of `late` value.",
|
| + "enum": [
|
| + "LATE_VALUES_UNSPECIFIED",
|
| + "LATE_ONLY",
|
| + "NOT_LATE_ONLY"
|
| + ],
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "pageToken": {
|
| + "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust 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\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
|
| + "format": "int32",
|
| + "location": "query",
|
| + "type": "integer"
|
| + },
|
| + "states": {
|
| + "description": "Requested submission states. If specified, returned student submissions\nmatch one of the specified submission states.",
|
| + "enum": [
|
| + "SUBMISSION_STATE_UNSPECIFIED",
|
| + "NEW",
|
| + "CREATED",
|
| + "TURNED_IN",
|
| + "RETURNED",
|
| + "RECLAIMED_BY_STUDENT"
|
| + ],
|
| + "location": "query",
|
| + "repeated": true,
|
| + "type": "string"
|
| + },
|
| + "userId": {
|
| + "description": "Optional argument to restrict returned student work to those owned by the\nstudent with the specified identifier. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
|
| + "location": "query",
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return",
|
| - "request": {
|
| - "$ref": "ReturnStudentSubmissionRequest"
|
| - },
|
| + "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions",
|
| "response": {
|
| - "$ref": "Empty"
|
| + "$ref": "ListStudentSubmissionsResponse"
|
| },
|
| "scopes": [
|
| - "https://www.googleapis.com/auth/classroom.coursework.students"
|
| + "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"
|
| ]
|
| },
|
| - "reclaim": {
|
| - "description": "Reclaims a student submission on behalf of the student that owns it.\n\nReclaiming a student submission transfers ownership of attached Drive\nfiles to the student and update the submission state.\n\nOnly the student that owns the requested student submission may call this\nmethod, and only for a student submission that has been turned in.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, unsubmit the requested student submission,\nor for access errors.\n* `FAILED_PRECONDITION` if the student submission has not been turned in.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
|
| - "httpMethod": "POST",
|
| - "id": "classroom.courses.courseWork.studentSubmissions.reclaim",
|
| + "patch": {
|
| + "description": "Updates one or more fields of a student submission.\n\nSee google.classroom.v1.StudentSubmission for details\nof which fields may be updated and who may change them.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding course work, if the user is not permitted to make the\nrequested modification to the student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
|
| + "httpMethod": "PATCH",
|
| + "id": "classroom.courses.courseWork.studentSubmissions.patch",
|
| "parameterOrder": [
|
| "courseId",
|
| "courseWorkId",
|
| @@ -1036,95 +1195,80 @@
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| + },
|
| + "updateMask": {
|
| + "description": "Mask that identifies which fields on the student submission to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified.\n\nThe following fields may be specified by teachers:\n* `draft_grade`\n* `assigned_grade`",
|
| + "format": "google-fieldmask",
|
| + "location": "query",
|
| + "type": "string"
|
| }
|
| },
|
| - "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim",
|
| + "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
|
| "request": {
|
| - "$ref": "ReclaimStudentSubmissionRequest"
|
| + "$ref": "StudentSubmission"
|
| },
|
| "response": {
|
| - "$ref": "Empty"
|
| + "$ref": "StudentSubmission"
|
| },
|
| "scopes": [
|
| - "https://www.googleapis.com/auth/classroom.coursework.me"
|
| + "https://www.googleapis.com/auth/classroom.coursework.me",
|
| + "https://www.googleapis.com/auth/classroom.coursework.students"
|
| ]
|
| },
|
| - "turnIn": {
|
| - "description": "Turns in a student submission.\n\nTurning in a student submission transfers ownership of attached Drive\nfiles to the teacher and may also update the submission state.\n\nThis may only be called by the student that owns the specified student\nsubmission.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, turn in the requested student submission,\nor for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
|
| - "httpMethod": "POST",
|
| - "id": "classroom.courses.courseWork.studentSubmissions.turnIn",
|
| + "get": {
|
| + "description": "Returns a student submission.\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course, course work, or student submission or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
|
| + "httpMethod": "GET",
|
| + "id": "classroom.courses.courseWork.studentSubmissions.get",
|
| "parameterOrder": [
|
| "courseId",
|
| "courseWorkId",
|
| "id"
|
| ],
|
| "parameters": {
|
| - "courseId": {
|
| - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| + "courseWorkId": {
|
| + "description": "Identifier of the course work.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "id": {
|
| - "description": "Identifier of the student submission.",
|
| + "courseId": {
|
| + "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "courseWorkId": {
|
| - "description": "Identifier of the course work.",
|
| + "id": {
|
| + "description": "Identifier of the student submission.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn",
|
| - "request": {
|
| - "$ref": "TurnInStudentSubmissionRequest"
|
| - },
|
| + "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
|
| "response": {
|
| - "$ref": "Empty"
|
| + "$ref": "StudentSubmission"
|
| },
|
| "scopes": [
|
| - "https://www.googleapis.com/auth/classroom.coursework.me"
|
| + "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"
|
| ]
|
| },
|
| - "list": {
|
| - "description": "Returns a list of student submissions that the requester is permitted to\nview, factoring in the OAuth scopes of the request.\n`-` may be specified as the `course_work_id` to include student\nsubmissions for multiple course work items.\n\nCourse students may only view their own work. Course teachers\nand domain administrators may view all student submissions.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.",
|
| - "httpMethod": "GET",
|
| - "id": "classroom.courses.courseWork.studentSubmissions.list",
|
| + "return": {
|
| + "description": "Returns a student submission.\n\nReturning a student submission transfers ownership of attached Drive\nfiles to the student and may also update the submission state.\nUnlike the Classroom application, returning a student submission does not\nset assignedGrade to the draftGrade value.\n\nOnly a teacher of the course that contains the requested student submission\nmay call this method.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, return the requested student submission,\nor for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
|
| + "httpMethod": "POST",
|
| + "id": "classroom.courses.courseWork.studentSubmissions.return",
|
| "parameterOrder": [
|
| "courseId",
|
| - "courseWorkId"
|
| + "courseWorkId",
|
| + "id"
|
| ],
|
| "parameters": {
|
| - "pageSize": {
|
| - "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
|
| - "format": "int32",
|
| - "location": "query",
|
| - "type": "integer"
|
| - },
|
| - "states": {
|
| - "description": "Requested submission states. If specified, returned student submissions\nmatch one of the specified submission states.",
|
| - "enum": [
|
| - "SUBMISSION_STATE_UNSPECIFIED",
|
| - "NEW",
|
| - "CREATED",
|
| - "TURNED_IN",
|
| - "RETURNED",
|
| - "RECLAIMED_BY_STUDENT"
|
| - ],
|
| - "location": "query",
|
| - "repeated": true,
|
| - "type": "string"
|
| - },
|
| - "userId": {
|
| - "description": "Optional argument to restrict returned student work to those owned by the\nstudent with the specified identifier. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| "courseWorkId": {
|
| - "description": "Identifer of the student work to request.\nThis may be set to the string literal `\"-\"` to request student work for\nall course work in the specified course.",
|
| + "description": "Identifier of the course work.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| @@ -1135,39 +1279,28 @@
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "late": {
|
| - "description": "Requested lateness value. If specified, returned student submissions are\nrestricted by the requested value.\nIf unspecified, submissions are returned regardless of `late` value.",
|
| - "enum": [
|
| - "LATE_VALUES_UNSPECIFIED",
|
| - "LATE_ONLY",
|
| - "NOT_LATE_ONLY"
|
| - ],
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "pageToken": {
|
| - "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
|
| - "location": "query",
|
| + "id": {
|
| + "description": "Identifier of the student submission.",
|
| + "location": "path",
|
| + "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions",
|
| + "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return",
|
| + "request": {
|
| + "$ref": "ReturnStudentSubmissionRequest"
|
| + },
|
| "response": {
|
| - "$ref": "ListStudentSubmissionsResponse"
|
| + "$ref": "Empty"
|
| },
|
| "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"
|
| + "https://www.googleapis.com/auth/classroom.coursework.students"
|
| ]
|
| },
|
| - "modifyAttachments": {
|
| - "description": "Modifies attachments of student submission.\n\nAttachments may only be added to student submissions belonging to course\nwork objects with a `workType` of `ASSIGNMENT`.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, if the user is not permitted to modify\nattachments on the requested student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
|
| + "reclaim": {
|
| + "description": "Reclaims a student submission on behalf of the student that owns it.\n\nReclaiming a student submission transfers ownership of attached Drive\nfiles to the student and update the submission state.\n\nOnly the student that owns the requested student submission may call this\nmethod, and only for a student submission that has been turned in.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, unsubmit the requested student submission,\nor for access errors.\n* `FAILED_PRECONDITION` if the student submission has not been turned in.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
|
| "httpMethod": "POST",
|
| - "id": "classroom.courses.courseWork.studentSubmissions.modifyAttachments",
|
| + "id": "classroom.courses.courseWork.studentSubmissions.reclaim",
|
| "parameterOrder": [
|
| "courseId",
|
| "courseWorkId",
|
| @@ -1193,196 +1326,74 @@
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments",
|
| + "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim",
|
| "request": {
|
| - "$ref": "ModifyAttachmentsRequest"
|
| + "$ref": "ReclaimStudentSubmissionRequest"
|
| },
|
| "response": {
|
| - "$ref": "StudentSubmission"
|
| + "$ref": "Empty"
|
| },
|
| "scopes": [
|
| - "https://www.googleapis.com/auth/classroom.coursework.me",
|
| - "https://www.googleapis.com/auth/classroom.coursework.students"
|
| + "https://www.googleapis.com/auth/classroom.coursework.me"
|
| ]
|
| }
|
| }
|
| }
|
| }
|
| - },
|
| - "teachers": {
|
| + }
|
| + }
|
| + },
|
| + "userProfiles": {
|
| + "methods": {
|
| + "get": {
|
| + "description": "Returns a user profile.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access\nthis user profile, if no profile exists with the requested ID, or for\naccess errors.",
|
| + "httpMethod": "GET",
|
| + "id": "classroom.userProfiles.get",
|
| + "parameterOrder": [
|
| + "userId"
|
| + ],
|
| + "parameters": {
|
| + "userId": {
|
| + "description": "Identifier of the profile to return. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "v1/userProfiles/{userId}",
|
| + "response": {
|
| + "$ref": "UserProfile"
|
| + },
|
| + "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"
|
| + ]
|
| + }
|
| + },
|
| + "resources": {
|
| + "guardianInvitations": {
|
| "methods": {
|
| - "create": {
|
| - "description": "Creates a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\nteachers in this course or for access errors.\n* `NOT_FOUND` if the requested course ID does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled,\nfor the following request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * CourseTeacherLimitReached\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if the user is already a teacher or student in the\ncourse.",
|
| - "httpMethod": "POST",
|
| - "id": "classroom.courses.teachers.create",
|
| + "list": {
|
| + "description": "Returns a list of guardian invitations that the requesting user is\npermitted to view, filtered by the parameters provided.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if a `student_id` is specified, and the requesting\n user is not permitted to view guardian invitations for that student, if\n `\"-\"` is specified as the `student_id` and the user is not a domain\n administrator, if guardians are not enabled for the domain in question,\n or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`). May also be returned if an invalid\n `page_token` or `state` is provided.\n* `NOT_FOUND` if a `student_id` is specified, and its format can be\n recognized, but Classroom has no record of that student.",
|
| + "httpMethod": "GET",
|
| + "id": "classroom.userProfiles.guardianInvitations.list",
|
| "parameterOrder": [
|
| - "courseId"
|
| + "studentId"
|
| ],
|
| "parameters": {
|
| - "courseId": {
|
| - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - }
|
| - },
|
| - "path": "v1/courses/{courseId}/teachers",
|
| - "request": {
|
| - "$ref": "Teacher"
|
| - },
|
| - "response": {
|
| - "$ref": "Teacher"
|
| - },
|
| - "scopes": [
|
| - "https://www.googleapis.com/auth/classroom.profile.emails",
|
| - "https://www.googleapis.com/auth/classroom.profile.photos",
|
| - "https://www.googleapis.com/auth/classroom.rosters"
|
| - ]
|
| - },
|
| - "delete": {
|
| - "description": "Deletes a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete\nteachers of this course or for access errors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if the\ncourse does not exist.\n* `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher\nof this course.",
|
| - "httpMethod": "DELETE",
|
| - "id": "classroom.courses.teachers.delete",
|
| - "parameterOrder": [
|
| - "courseId",
|
| - "userId"
|
| - ],
|
| - "parameters": {
|
| - "courseId": {
|
| - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - },
|
| - "userId": {
|
| - "description": "Identifier of the teacher to delete. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - }
|
| - },
|
| - "path": "v1/courses/{courseId}/teachers/{userId}",
|
| - "response": {
|
| - "$ref": "Empty"
|
| - },
|
| - "scopes": [
|
| - "https://www.googleapis.com/auth/classroom.rosters"
|
| - ]
|
| - },
|
| - "get": {
|
| - "description": "Returns a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view\nteachers of this course or for access errors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if the\ncourse does not exist.",
|
| - "httpMethod": "GET",
|
| - "id": "classroom.courses.teachers.get",
|
| - "parameterOrder": [
|
| - "courseId",
|
| - "userId"
|
| - ],
|
| - "parameters": {
|
| - "courseId": {
|
| - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - },
|
| - "userId": {
|
| - "description": "Identifier of the teacher to return. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - }
|
| - },
|
| - "path": "v1/courses/{courseId}/teachers/{userId}",
|
| - "response": {
|
| - "$ref": "Teacher"
|
| - },
|
| - "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"
|
| - ]
|
| - },
|
| - "list": {
|
| - "description": "Returns a list of teachers of this course that the requester\nis permitted to view.\n\nThis method returns the following error codes:\n\n* `NOT_FOUND` if the course does not exist.\n* `PERMISSION_DENIED` for access errors.",
|
| - "httpMethod": "GET",
|
| - "id": "classroom.courses.teachers.list",
|
| - "parameterOrder": [
|
| - "courseId"
|
| - ],
|
| - "parameters": {
|
| - "courseId": {
|
| - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| + "studentId": {
|
| + "description": "The ID of the student whose guardian invitations are to be returned.\nThe identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user\n* the string literal `\"-\"`, indicating that results should be returned for\n all students that the requesting user is permitted to view guardian\n invitations.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| "pageToken": {
|
| - "description": "nextPageToken\nvalue returned from a previous\nlist call, indicating that\nthe subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.",
|
| + "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
|
| "location": "query",
|
| "type": "string"
|
| },
|
| - "pageSize": {
|
| - "description": "Maximum number of items to return. Zero means no maximum.\n\nThe server may return fewer than the specified number of results.",
|
| - "format": "int32",
|
| - "location": "query",
|
| - "type": "integer"
|
| - }
|
| - },
|
| - "path": "v1/courses/{courseId}/teachers",
|
| - "response": {
|
| - "$ref": "ListTeachersResponse"
|
| - },
|
| - "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"
|
| - ]
|
| - }
|
| - }
|
| - }
|
| - }
|
| - },
|
| - "userProfiles": {
|
| - "methods": {
|
| - "get": {
|
| - "description": "Returns a user profile.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access\nthis user profile, if no profile exists with the requested ID, or for\naccess errors.",
|
| - "httpMethod": "GET",
|
| - "id": "classroom.userProfiles.get",
|
| - "parameterOrder": [
|
| - "userId"
|
| - ],
|
| - "parameters": {
|
| - "userId": {
|
| - "description": "Identifier of the profile to return. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - }
|
| - },
|
| - "path": "v1/userProfiles/{userId}",
|
| - "response": {
|
| - "$ref": "UserProfile"
|
| - },
|
| - "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"
|
| - ]
|
| - }
|
| - },
|
| - "resources": {
|
| - "guardianInvitations": {
|
| - "methods": {
|
| - "list": {
|
| - "description": "Returns a list of guardian invitations that the requesting user is\npermitted to view, filtered by the parameters provided.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if a `student_id` is specified, and the requesting\n user is not permitted to view guardian invitations for that student, if\n `\"-\"` is specified as the `student_id` and the user is not a domain\n administrator, if guardians are not enabled for the domain in question,\n or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`). May also be returned if an invalid\n `page_token` or `state` is provided.\n* `NOT_FOUND` if a `student_id` is specified, and its format can be\n recognized, but Classroom has no record of that student.",
|
| - "httpMethod": "GET",
|
| - "id": "classroom.userProfiles.guardianInvitations.list",
|
| - "parameterOrder": [
|
| - "studentId"
|
| - ],
|
| - "parameters": {
|
| "invitedEmailAddress": {
|
| "description": "If specified, only results with the specified `invited_email_address`\nwill be returned.",
|
| "location": "query",
|
| @@ -1404,17 +1415,6 @@
|
| "format": "int32",
|
| "location": "query",
|
| "type": "integer"
|
| - },
|
| - "studentId": {
|
| - "description": "The ID of the student whose guardian invitations are to be returned.\nThe identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user\n* the string literal `\"-\"`, indicating that results should be returned for\n all students that the requesting user is permitted to view guardian\n invitations.",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - },
|
| - "pageToken": {
|
| - "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
|
| - "location": "query",
|
| - "type": "string"
|
| }
|
| },
|
| "path": "v1/userProfiles/{studentId}/guardianInvitations",
|
| @@ -1435,14 +1435,14 @@
|
| "invitationId"
|
| ],
|
| "parameters": {
|
| - "studentId": {
|
| - "description": "The ID of the student whose guardian invitation is being requested.",
|
| + "invitationId": {
|
| + "description": "The `id` field of the `GuardianInvitation` being requested.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "invitationId": {
|
| - "description": "The `id` field of the `GuardianInvitation` being requested.",
|
| + "studentId": {
|
| + "description": "The ID of the student whose guardian invitation is being requested.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| @@ -1634,942 +1634,952 @@
|
| }
|
| }
|
| },
|
| - "revision": "20170520",
|
| + "revision": "20170606",
|
| "rootUrl": "https://classroom.googleapis.com/",
|
| "schemas": {
|
| - "Name": {
|
| - "description": "Details of the user's name.",
|
| - "id": "Name",
|
| - "properties": {
|
| - "givenName": {
|
| - "description": "The user's first name.\n\nRead-only.",
|
| - "type": "string"
|
| - },
|
| - "familyName": {
|
| - "description": "The user's last name.\n\nRead-only.",
|
| - "type": "string"
|
| - },
|
| - "fullName": {
|
| - "description": "The user's full name formed by concatenating the first and last name\nvalues.\n\nRead-only.",
|
| - "type": "string"
|
| - }
|
| - },
|
| + "TurnInStudentSubmissionRequest": {
|
| + "description": "Request to turn in a student submission.",
|
| + "id": "TurnInStudentSubmissionRequest",
|
| + "properties": {},
|
| "type": "object"
|
| },
|
| - "CourseMaterial": {
|
| - "description": "A material attached to a course as part of a material set.",
|
| - "id": "CourseMaterial",
|
| + "ListStudentSubmissionsResponse": {
|
| + "description": "Response when listing student submissions.",
|
| + "id": "ListStudentSubmissionsResponse",
|
| "properties": {
|
| - "driveFile": {
|
| - "$ref": "DriveFile",
|
| - "description": "Google Drive file attachment."
|
| - },
|
| - "youTubeVideo": {
|
| - "$ref": "YouTubeVideo",
|
| - "description": "Youtube video attachment."
|
| - },
|
| - "form": {
|
| - "$ref": "Form",
|
| - "description": "Google Forms attachment."
|
| + "nextPageToken": {
|
| + "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
|
| + "type": "string"
|
| },
|
| - "link": {
|
| - "$ref": "Link",
|
| - "description": "Link atatchment."
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "Assignment": {
|
| - "description": "Additional details for assignments.",
|
| - "id": "Assignment",
|
| - "properties": {
|
| - "studentWorkFolder": {
|
| - "$ref": "DriveFolder",
|
| - "description": "Drive folder where attachments from student submissions are placed.\nThis is only populated for course teachers."
|
| + "studentSubmissions": {
|
| + "description": "Student work that matches the request.",
|
| + "items": {
|
| + "$ref": "StudentSubmission"
|
| + },
|
| + "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "SharedDriveFile": {
|
| - "description": "Drive file that is used as material for course work.",
|
| - "id": "SharedDriveFile",
|
| + "StudentSubmission": {
|
| + "description": "Student submission for course work.\n\nStudentSubmission items are generated when a CourseWork item is created.\n\nStudentSubmissions that have never been accessed (i.e. with `state` = NEW)\nmay not have a creation time or update time.",
|
| + "id": "StudentSubmission",
|
| "properties": {
|
| - "driveFile": {
|
| - "$ref": "DriveFile",
|
| - "description": "Drive file details."
|
| + "creationTime": {
|
| + "description": "Creation time of this submission.\nThis may be unset if the student has not accessed this item.\n\nRead-only.",
|
| + "format": "google-datetime",
|
| + "type": "string"
|
| },
|
| - "shareMode": {
|
| - "description": "Mechanism by which students access the Drive item.",
|
| + "state": {
|
| + "description": "State of this submission.\n\nRead-only.",
|
| "enum": [
|
| - "UNKNOWN_SHARE_MODE",
|
| - "VIEW",
|
| - "EDIT",
|
| - "STUDENT_COPY"
|
| + "SUBMISSION_STATE_UNSPECIFIED",
|
| + "NEW",
|
| + "CREATED",
|
| + "TURNED_IN",
|
| + "RETURNED",
|
| + "RECLAIMED_BY_STUDENT"
|
| ],
|
| "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."
|
| + "No state specified. This should never be returned.",
|
| + "The student has never accessed this submission. Attachments are not\nreturned 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."
|
| ],
|
| "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "Empty": {
|
| - "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
|
| - "id": "Empty",
|
| - "properties": {},
|
| - "type": "object"
|
| - },
|
| - "MultipleChoiceQuestion": {
|
| - "description": "Additional details for multiple-choice questions.",
|
| - "id": "MultipleChoiceQuestion",
|
| - "properties": {
|
| - "choices": {
|
| - "description": "Possible choices.",
|
| - "items": {
|
| - "type": "string"
|
| - },
|
| - "type": "array"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "Course": {
|
| - "description": "A Course in Classroom.",
|
| - "id": "Course",
|
| - "properties": {
|
| - "updateTime": {
|
| - "description": "Time of the most recent update to this course.\nSpecifying this field in a course update mask results in an error.\n\nRead-only.",
|
| - "format": "google-datetime",
|
| - "type": "string"
|
| - },
|
| - "alternateLink": {
|
| - "description": "Absolute link to this course in the Classroom web UI.\n\nRead-only.",
|
| - "type": "string"
|
| - },
|
| - "guardiansEnabled": {
|
| - "description": "Whether or not guardian notifications are enabled for this course.\n\nRead-only.",
|
| - "type": "boolean"
|
| },
|
| - "courseState": {
|
| - "description": "State of the course.\nIf unspecified, the default state is `PROVISIONED`.",
|
| - "enum": [
|
| - "COURSE_STATE_UNSPECIFIED",
|
| - "ACTIVE",
|
| - "ARCHIVED",
|
| - "PROVISIONED",
|
| - "DECLINED",
|
| - "SUSPENDED"
|
| - ],
|
| - "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\nto a different state.",
|
| - "The course has been created, but not yet activated. It is accessible by\nthe primary teacher and domain administrators, who may modify it or\nchange it to the `ACTIVE` or `DECLINED` states.\nA course may only be changed to `PROVISIONED` if it is in the `DECLINED`\nstate.",
|
| - "The course has been created, but declined. It is accessible by the\ncourse owner and domain administrators, though it will not be\ndisplayed in the web UI. You cannot modify the course except to change it\nto the `PROVISIONED` state.\nA course may only be changed to `DECLINED` if it is in the `PROVISIONED`\nstate.",
|
| - "The course has been suspended. You cannot modify the course, and only the\nuser identified by the `owner_id` can view the course.\nA course may be placed in this state if it potentially violates the\nTerms of Service."
|
| - ],
|
| + "userId": {
|
| + "description": "Identifier for the student that owns this submission.\n\nRead-only.",
|
| "type": "string"
|
| },
|
| - "ownerId": {
|
| - "description": "The identifier of the owner of a course.\n\nWhen specified as a parameter of a\ncreate course request, this\nfield is required.\nThe identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user\n\nThis must be set in a create request. Specifying this field in a course\nupdate mask results in an `INVALID_ARGUMENT` error.",
|
| + "courseWorkId": {
|
| + "description": "Identifier for the course work this corresponds to.\n\nRead-only.",
|
| "type": "string"
|
| },
|
| - "description": {
|
| - "description": "Optional description.\nFor example, \"We'll be learning about the structure of living\ncreatures from a combination of textbooks, guest lectures, and lab work.\nExpect to be excited!\"\nIf set, this field must be a valid UTF-8 string and no longer than 30,000\ncharacters.",
|
| + "courseId": {
|
| + "description": "Identifier of the course.\n\nRead-only.",
|
| "type": "string"
|
| },
|
| - "teacherGroupEmail": {
|
| - "description": "The email address of a Google group containing all teachers of the course.\nThis group does not accept email and can only be used for permissions.\n\nRead-only.",
|
| + "id": {
|
| + "description": "Classroom-assigned Identifier for the student submission.\nThis is unique among submissions for the relevant course work.\n\nRead-only.",
|
| "type": "string"
|
| },
|
| - "creationTime": {
|
| - "description": "Creation time of the course.\nSpecifying this field in a course update mask results in an error.\n\nRead-only.",
|
| - "format": "google-datetime",
|
| - "type": "string"
|
| + "assignedGrade": {
|
| + "description": "Optional grade. If unset, no grade was set.\nThis must be a non-negative integer value.\n\nThis may be modified only by course teachers.",
|
| + "format": "double",
|
| + "type": "number"
|
| },
|
| - "name": {
|
| - "description": "Name of the course.\nFor example, \"10th Grade Biology\".\nThe name is required. It must be between 1 and 750 characters and a valid\nUTF-8 string.",
|
| - "type": "string"
|
| + "multipleChoiceSubmission": {
|
| + "$ref": "MultipleChoiceSubmission",
|
| + "description": "Submission content when course_work_type is MULTIPLE_CHOICE_QUESTION."
|
| },
|
| - "teacherFolder": {
|
| - "$ref": "DriveFolder",
|
| - "description": "Information about a Drive Folder that is shared with all teachers of the\ncourse.\n\nThis field will only be set for teachers of the course and domain administrators.\n\nRead-only."
|
| + "assignmentSubmission": {
|
| + "$ref": "AssignmentSubmission",
|
| + "description": "Submission content when course_work_type is ASSIGNMENT ."
|
| },
|
| - "section": {
|
| - "description": "Section of the course.\nFor example, \"Period 2\".\nIf set, this field must be a valid UTF-8 string and no longer than 2800\ncharacters.",
|
| - "type": "string"
|
| + "associatedWithDeveloper": {
|
| + "description": "Whether this student submission is associated with the Developer Console\nproject making the request.\n\nSee google.classroom.Work.CreateCourseWork for more\ndetails.\n\nRead-only.",
|
| + "type": "boolean"
|
| },
|
| - "id": {
|
| - "description": "Identifier for this course assigned by Classroom.\n\nWhen\ncreating a course,\nyou may optionally set this identifier to an\nalias string in the\nrequest to create a corresponding alias. The `id` is still assigned by\nClassroom and cannot be updated after the course is created.\n\nSpecifying this field in a course update mask results in an error.",
|
| - "type": "string"
|
| + "shortAnswerSubmission": {
|
| + "$ref": "ShortAnswerSubmission",
|
| + "description": "Submission content when course_work_type is SHORT_ANSWER_QUESTION."
|
| },
|
| - "room": {
|
| - "description": "Optional room location.\nFor example, \"301\".\nIf set, this field must be a valid UTF-8 string and no longer than 650\ncharacters.",
|
| + "updateTime": {
|
| + "description": "Last update time of this submission.\nThis may be unset if the student has not accessed this item.\n\nRead-only.",
|
| + "format": "google-datetime",
|
| "type": "string"
|
| },
|
| - "courseGroupEmail": {
|
| - "description": "The email address of a Google group containing all members of the course.\nThis group does not accept email and can only be used for permissions.\n\nRead-only.",
|
| + "alternateLink": {
|
| + "description": "Absolute link to the submission in the Classroom web UI.\n\nRead-only.",
|
| "type": "string"
|
| },
|
| - "courseMaterialSets": {
|
| - "description": "Sets of materials that appear on the \"about\" page of this course.\n\nRead-only.",
|
| - "items": {
|
| - "$ref": "CourseMaterialSet"
|
| - },
|
| - "type": "array"
|
| + "late": {
|
| + "description": "Whether this submission is late.\n\nRead-only.",
|
| + "type": "boolean"
|
| },
|
| - "enrollmentCode": {
|
| - "description": "Enrollment code to use when joining this course.\nSpecifying this field in a course update mask results in an error.\n\nRead-only.",
|
| - "type": "string"
|
| + "draftGrade": {
|
| + "description": "Optional pending grade. If unset, no grade was set.\nThis must be a non-negative integer value.\n\nThis is only visible to and modifiable by course teachers.",
|
| + "format": "double",
|
| + "type": "number"
|
| },
|
| - "descriptionHeading": {
|
| - "description": "Optional heading for the description.\nFor example, \"Welcome to 10th Grade Biology.\"\nIf set, this field must be a valid UTF-8 string and no longer than 3600\ncharacters.",
|
| + "courseWorkType": {
|
| + "description": "Type of course work this submission is for.\n\nRead-only.",
|
| + "enum": [
|
| + "COURSE_WORK_TYPE_UNSPECIFIED",
|
| + "ASSIGNMENT",
|
| + "SHORT_ANSWER_QUESTION",
|
| + "MULTIPLE_CHOICE_QUESTION"
|
| + ],
|
| + "enumDescriptions": [
|
| + "No work type specified. This is never returned.",
|
| + "An assignment.",
|
| + "A short answer question.",
|
| + "A multiple-choice question."
|
| + ],
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "DriveFile": {
|
| - "description": "Representation of a Google Drive file.",
|
| - "id": "DriveFile",
|
| + "ModifyAttachmentsRequest": {
|
| + "description": "Request to modify the attachments of a student submission.",
|
| + "id": "ModifyAttachmentsRequest",
|
| "properties": {
|
| - "thumbnailUrl": {
|
| - "description": "URL of a thumbnail image of the Drive item.\n\nRead-only.",
|
| - "type": "string"
|
| - },
|
| - "id": {
|
| - "description": "Drive API resource ID.",
|
| - "type": "string"
|
| - },
|
| - "title": {
|
| - "description": "Title of the Drive item.\n\nRead-only.",
|
| - "type": "string"
|
| - },
|
| - "alternateLink": {
|
| - "description": "URL that can be used to access the Drive item.\n\nRead-only.",
|
| - "type": "string"
|
| + "addAttachments": {
|
| + "description": "Attachments to add.\nA student submission may not have more than 20 attachments.\n\nForm attachments are not supported.",
|
| + "items": {
|
| + "$ref": "Attachment"
|
| + },
|
| + "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "GlobalPermission": {
|
| - "description": "Global user permission description.",
|
| - "id": "GlobalPermission",
|
| + "ListCourseWorkResponse": {
|
| + "description": "Response when listing course work.",
|
| + "id": "ListCourseWorkResponse",
|
| "properties": {
|
| - "permission": {
|
| - "description": "Permission value.",
|
| - "enum": [
|
| - "PERMISSION_UNSPECIFIED",
|
| - "CREATE_COURSE"
|
| - ],
|
| - "enumDescriptions": [
|
| - "No permission is specified. This is not returned and is not a\nvalid value.",
|
| - "User is permitted to create a course."
|
| - ],
|
| + "nextPageToken": {
|
| + "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
|
| "type": "string"
|
| + },
|
| + "courseWork": {
|
| + "description": "Course work items that match the request.",
|
| + "items": {
|
| + "$ref": "CourseWork"
|
| + },
|
| + "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ReturnStudentSubmissionRequest": {
|
| - "description": "Request to return a student submission.",
|
| - "id": "ReturnStudentSubmissionRequest",
|
| - "properties": {},
|
| - "type": "object"
|
| - },
|
| - "Teacher": {
|
| - "description": "Teacher of a course.",
|
| - "id": "Teacher",
|
| + "YouTubeVideo": {
|
| + "description": "YouTube video item.",
|
| + "id": "YouTubeVideo",
|
| "properties": {
|
| - "courseId": {
|
| - "description": "Identifier of the course.\n\nRead-only.",
|
| + "title": {
|
| + "description": "Title of the YouTube video.\n\nRead-only.",
|
| "type": "string"
|
| },
|
| - "profile": {
|
| - "$ref": "UserProfile",
|
| - "description": "Global user information for the teacher.\n\nRead-only."
|
| + "alternateLink": {
|
| + "description": "URL that can be used to view the YouTube video.\n\nRead-only.",
|
| + "type": "string"
|
| },
|
| - "userId": {
|
| - "description": "Identifier of the user.\n\nWhen specified as a parameter of a request, this identifier can be one of\nthe following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
|
| + "thumbnailUrl": {
|
| + "description": "URL of a thumbnail image of the YouTube video.\n\nRead-only.",
|
| + "type": "string"
|
| + },
|
| + "id": {
|
| + "description": "YouTube API resource ID.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ReclaimStudentSubmissionRequest": {
|
| - "description": "Request to reclaim a student submission.",
|
| - "id": "ReclaimStudentSubmissionRequest",
|
| - "properties": {},
|
| - "type": "object"
|
| - },
|
| - "AssignmentSubmission": {
|
| - "description": "Student work for an assignment.",
|
| - "id": "AssignmentSubmission",
|
| + "ListInvitationsResponse": {
|
| + "description": "Response when listing invitations.",
|
| + "id": "ListInvitationsResponse",
|
| "properties": {
|
| - "attachments": {
|
| - "description": "Attachments added by the student.\nDrive files that correspond to materials with a share mode of\nSTUDENT_COPY may not exist yet if the student has not accessed the\nassignment in Classroom.\n\nSome attachment metadata is only populated if the requesting user has\npermission to access it. Identifier and alternate_link fields are always\navailable, but others (e.g. title) may not be.",
|
| + "nextPageToken": {
|
| + "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
|
| + "type": "string"
|
| + },
|
| + "invitations": {
|
| + "description": "Invitations that match the list request.",
|
| "items": {
|
| - "$ref": "Attachment"
|
| + "$ref": "Invitation"
|
| },
|
| "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Material": {
|
| - "description": "Material attached to course work.\n\nWhen creating attachments, setting the `form` field is not supported.",
|
| - "id": "Material",
|
| - "properties": {
|
| - "youtubeVideo": {
|
| - "$ref": "YouTubeVideo",
|
| - "description": "YouTube video material."
|
| - },
|
| - "driveFile": {
|
| - "$ref": "SharedDriveFile",
|
| - "description": "Google Drive file material."
|
| - },
|
| - "form": {
|
| - "$ref": "Form",
|
| - "description": "Google Forms material."
|
| - },
|
| - "link": {
|
| - "$ref": "Link",
|
| - "description": "Link material. On creation, will be upgraded to a more appropriate type\nif possible, and this will be reflected in the response."
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "CourseWork": {
|
| - "description": "Course work created by a teacher for students of the course.",
|
| - "id": "CourseWork",
|
| + "GuardianInvitation": {
|
| + "description": "An invitation to become the guardian of a specified user, sent to a specified\nemail address.",
|
| + "id": "GuardianInvitation",
|
| "properties": {
|
| - "description": {
|
| - "description": "Optional description of this course work.\nIf set, the description must be a valid UTF-8 string containing no more\nthan 30,000 characters.",
|
| + "invitedEmailAddress": {
|
| + "description": "Email address that the invitation was sent to.\nThis field is only visible to domain administrators.",
|
| "type": "string"
|
| },
|
| "creationTime": {
|
| - "description": "Timestamp when this course work was created.\n\nRead-only.",
|
| + "description": "The time that this invitation was created.\n\nRead-only.",
|
| "format": "google-datetime",
|
| "type": "string"
|
| },
|
| - "dueDate": {
|
| - "$ref": "Date",
|
| - "description": "Optional date, in UTC, that submissions for this this course work are due.\nThis must be specified if `due_time` is specified."
|
| + "invitationId": {
|
| + "description": "Unique identifier for this invitation.\n\nRead-only.",
|
| + "type": "string"
|
| },
|
| - "submissionModificationMode": {
|
| - "description": "Setting to determine when students are allowed to modify submissions.\nIf unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.",
|
| - "enum": [
|
| - "SUBMISSION_MODIFICATION_MODE_UNSPECIFIED",
|
| - "MODIFIABLE_UNTIL_TURNED_IN",
|
| - "MODIFIABLE"
|
| - ],
|
| - "enumDescriptions": [
|
| - "No modification mode specified. This is never returned.",
|
| - "Submisisons can be modified before being turned in.",
|
| - "Submisisons can be modified at any time."
|
| - ],
|
| + "studentId": {
|
| + "description": "ID of the student (in standard format)",
|
| "type": "string"
|
| },
|
| "state": {
|
| - "description": "Status of this course work.\nIf unspecified, the default state is `DRAFT`.",
|
| + "description": "The state that this invitation is in.",
|
| "enum": [
|
| - "COURSE_WORK_STATE_UNSPECIFIED",
|
| - "PUBLISHED",
|
| - "DRAFT",
|
| - "DELETED"
|
| + "GUARDIAN_INVITATION_STATE_UNSPECIFIED",
|
| + "PENDING",
|
| + "COMPLETE"
|
| ],
|
| "enumDescriptions": [
|
| - "No state specified. This is never returned.",
|
| - "Status for work that has been published.\nThis is the default state.",
|
| - "Status for work that is not yet published.\nWork in this state is visible only to course teachers and domain\nadministrators.",
|
| - "Status for work that was published but is now deleted.\nWork in this state is visible only to course teachers and domain\nadministrators.\nWork in this state is deleted after some time."
|
| + "Should never be returned.",
|
| + "The invitation is active and awaiting a response.",
|
| + "The invitation is no longer active. It may have been accepted, declined,\nwithdrawn or it may have expired."
|
| ],
|
| "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "Attachment": {
|
| + "description": "Attachment added to student assignment work.\n\nWhen creating attachments, setting the `form` field is not supported.",
|
| + "id": "Attachment",
|
| + "properties": {
|
| + "driveFile": {
|
| + "$ref": "DriveFile",
|
| + "description": "Google Drive file attachment."
|
| },
|
| - "courseId": {
|
| - "description": "Identifier of the course.\n\nRead-only.",
|
| - "type": "string"
|
| - },
|
| - "id": {
|
| - "description": "Classroom-assigned identifier of this course work, unique per course.\n\nRead-only.",
|
| - "type": "string"
|
| + "youTubeVideo": {
|
| + "$ref": "YouTubeVideo",
|
| + "description": "Youtube video attachment."
|
| },
|
| - "dueTime": {
|
| - "$ref": "TimeOfDay",
|
| - "description": "Optional time of day, in UTC, that submissions for this this course work\nare due.\nThis must be specified if `due_date` is specified."
|
| + "form": {
|
| + "$ref": "Form",
|
| + "description": "Google Forms attachment."
|
| },
|
| + "link": {
|
| + "$ref": "Link",
|
| + "description": "Link attachment."
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "CourseMaterialSet": {
|
| + "description": "A set of materials that appears on the \"About\" page of the course.\nThese materials might include a syllabus, schedule, or other background\ninformation relating to the course as a whole.",
|
| + "id": "CourseMaterialSet",
|
| + "properties": {
|
| "title": {
|
| - "description": "Title of this course work.\nThe title must be a valid UTF-8 string containing between 1 and 3000\ncharacters.",
|
| + "description": "Title for this set.",
|
| "type": "string"
|
| },
|
| "materials": {
|
| - "description": "Additional materials.\n\nCourseWork must have no more than 20 material items.",
|
| + "description": "Materials attached to this set.",
|
| "items": {
|
| - "$ref": "Material"
|
| + "$ref": "CourseMaterial"
|
| },
|
| "type": "array"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "TimeOfDay": {
|
| + "description": "Represents a time of day. The date and time zone are either not significant\nor are specified elsewhere. An API may choose to allow leap seconds. Related\ntypes are google.type.Date and `google.protobuf.Timestamp`.",
|
| + "id": "TimeOfDay",
|
| + "properties": {
|
| + "nanos": {
|
| + "description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| },
|
| - "associatedWithDeveloper": {
|
| - "description": "Whether this course work item is associated with the Developer Console\nproject making the request.\n\nSee google.classroom.Work.CreateCourseWork for more\ndetails.\n\nRead-only.",
|
| - "type": "boolean"
|
| + "seconds": {
|
| + "description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may\nallow the value 60 if it allows leap-seconds.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| },
|
| - "updateTime": {
|
| - "description": "Timestamp of the most recent change to this course work.\n\nRead-only.",
|
| - "format": "google-datetime",
|
| + "minutes": {
|
| + "description": "Minutes of hour of day. Must be from 0 to 59.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "hours": {
|
| + "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose\nto allow the value \"24:00:00\" for scenarios like business closing time.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "ListCoursesResponse": {
|
| + "description": "Response when listing courses.",
|
| + "id": "ListCoursesResponse",
|
| + "properties": {
|
| + "nextPageToken": {
|
| + "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
|
| "type": "string"
|
| },
|
| - "alternateLink": {
|
| - "description": "Absolute link to this course work in the Classroom web UI.\nThis is only populated if `state` is `PUBLISHED`.\n\nRead-only.",
|
| + "courses": {
|
| + "description": "Courses that match the list request.",
|
| + "items": {
|
| + "$ref": "Course"
|
| + },
|
| + "type": "array"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "Form": {
|
| + "description": "Google Forms item.",
|
| + "id": "Form",
|
| + "properties": {
|
| + "thumbnailUrl": {
|
| + "description": "URL of a thumbnail image of the Form.\n\nRead-only.",
|
| "type": "string"
|
| },
|
| - "maxPoints": {
|
| - "description": "Maximum grade for this course work.\nIf zero or unspecified, this assignment is considered ungraded.\nThis must be a non-negative integer value.",
|
| - "format": "double",
|
| - "type": "number"
|
| + "responseUrl": {
|
| + "description": "URL of the form responses document.\nOnly set if respsonses have been recorded and only when the\nrequesting user is an editor of the form.\n\nRead-only.",
|
| + "type": "string"
|
| },
|
| - "assignment": {
|
| - "$ref": "Assignment",
|
| - "description": "Assignment details.\nThis is populated only when `work_type` is `ASSIGNMENT`.\n\nRead-only."
|
| + "formUrl": {
|
| + "description": "URL of the form.",
|
| + "type": "string"
|
| },
|
| - "workType": {
|
| - "description": "Type of this course work.\n\nThe type is set when the course work is created and cannot be changed.",
|
| - "enum": [
|
| - "COURSE_WORK_TYPE_UNSPECIFIED",
|
| - "ASSIGNMENT",
|
| - "SHORT_ANSWER_QUESTION",
|
| - "MULTIPLE_CHOICE_QUESTION"
|
| - ],
|
| - "enumDescriptions": [
|
| - "No work type specified. This is never returned.",
|
| - "An assignment.",
|
| - "A short answer question.",
|
| - "A multiple-choice question."
|
| - ],
|
| + "title": {
|
| + "description": "Title of the Form.\n\nRead-only.",
|
| "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "ListTeachersResponse": {
|
| + "description": "Response when listing teachers.",
|
| + "id": "ListTeachersResponse",
|
| + "properties": {
|
| + "teachers": {
|
| + "description": "Teachers who match the list request.",
|
| + "items": {
|
| + "$ref": "Teacher"
|
| + },
|
| + "type": "array"
|
| },
|
| - "multipleChoiceQuestion": {
|
| - "$ref": "MultipleChoiceQuestion",
|
| - "description": "Multiple choice question details.\nFor read operations, this field is populated only when `work_type` is\n`MULTIPLE_CHOICE_QUESTION`.\nFor write operations, this field must be specified when creating course\nwork with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be\nset otherwise."
|
| + "nextPageToken": {
|
| + "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Guardian": {
|
| - "description": "Association between a student and a guardian of that student. The guardian\nmay receive information about the student's course work.",
|
| - "id": "Guardian",
|
| + "Link": {
|
| + "description": "URL item.",
|
| + "id": "Link",
|
| "properties": {
|
| - "guardianId": {
|
| - "description": "Identifier for the guardian.",
|
| + "title": {
|
| + "description": "Title of the target of the URL.\n\nRead-only.",
|
| "type": "string"
|
| },
|
| - "invitedEmailAddress": {
|
| - "description": "The email address to which the initial guardian invitation was sent.\nThis field is only visible to domain administrators.",
|
| + "thumbnailUrl": {
|
| + "description": "URL of a thumbnail image of the target URL.\n\nRead-only.",
|
| "type": "string"
|
| },
|
| - "guardianProfile": {
|
| - "$ref": "UserProfile",
|
| - "description": "User profile for the guardian."
|
| - },
|
| - "studentId": {
|
| - "description": "Identifier for the student to whom the guardian relationship applies.",
|
| + "url": {
|
| + "description": "URL to link to.\nThis must be a valid UTF-8 string containing between 1 and 2024 characters.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "UserProfile": {
|
| - "description": "Global information for a user.",
|
| - "id": "UserProfile",
|
| + "ListGuardiansResponse": {
|
| + "description": "Response when listing guardians.",
|
| + "id": "ListGuardiansResponse",
|
| "properties": {
|
| - "id": {
|
| - "description": "Identifier of the user.\n\nRead-only.",
|
| - "type": "string"
|
| + "guardians": {
|
| + "description": "Guardians on this page of results that met the criteria specified in\nthe request.",
|
| + "items": {
|
| + "$ref": "Guardian"
|
| + },
|
| + "type": "array"
|
| },
|
| - "emailAddress": {
|
| - "description": "Email address of the user.\n\nRead-only.",
|
| + "nextPageToken": {
|
| + "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
|
| "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "ListGuardianInvitationsResponse": {
|
| + "description": "Response when listing guardian invitations.",
|
| + "id": "ListGuardianInvitationsResponse",
|
| + "properties": {
|
| + "guardianInvitations": {
|
| + "description": "Guardian invitations that matched the list request.",
|
| + "items": {
|
| + "$ref": "GuardianInvitation"
|
| + },
|
| + "type": "array"
|
| },
|
| - "photoUrl": {
|
| - "description": "URL of user's profile photo.\n\nRead-only.",
|
| + "nextPageToken": {
|
| + "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
|
| "type": "string"
|
| - },
|
| - "permissions": {
|
| - "description": "Global permissions of the user.\n\nRead-only.",
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "ListCourseAliasesResponse": {
|
| + "description": "Response when listing course aliases.",
|
| + "id": "ListCourseAliasesResponse",
|
| + "properties": {
|
| + "aliases": {
|
| + "description": "The course aliases.",
|
| "items": {
|
| - "$ref": "GlobalPermission"
|
| + "$ref": "CourseAlias"
|
| },
|
| "type": "array"
|
| },
|
| - "name": {
|
| - "$ref": "Name",
|
| - "description": "Name of the user.\n\nRead-only."
|
| + "nextPageToken": {
|
| + "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "CourseAlias": {
|
| + "description": "Alternative identifier for a course.\n\nAn alias uniquely identifies a course. It must be unique within one of the\nfollowing scopes:\n\n* domain: A domain-scoped alias is visible to all users within the alias\ncreator's domain and can be created only by a domain admin. A domain-scoped\nalias is often used when a course has an identifier external to Classroom.\n\n* project: A project-scoped alias is visible to any request from an\napplication using the Developer Console project ID that created the alias\nand can be created by any project. A project-scoped alias is often used when\nan application has alternative identifiers. A random value can also be used\nto avoid duplicate courses in the event of transmission failures, as retrying\na request will return `ALREADY_EXISTS` if a previous one has succeeded.",
|
| + "id": "CourseAlias",
|
| + "properties": {
|
| + "alias": {
|
| + "description": "Alias string. The format of the string indicates the desired alias scoping.\n\n* `d:<name>` indicates a domain-scoped alias.\n Example: `d:math_101`\n* `p:<name>` indicates a project-scoped alias.\n Example: `p:abc123`\n\nThis field has a maximum length of 256 characters.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "Date": {
|
| + "description": "Represents a whole calendar date, e.g. date of birth. The time of day and\ntime zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. The day may be 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independent\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.",
|
| + "id": "Date",
|
| + "properties": {
|
| + "year": {
|
| + "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "day": {
|
| + "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not significant.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "month": {
|
| + "description": "Month of year. Must be from 1 to 12.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "MultipleChoiceSubmission": {
|
| + "description": "Student work for a multiple-choice question.",
|
| + "id": "MultipleChoiceSubmission",
|
| + "properties": {
|
| + "answer": {
|
| + "description": "Student's select choice.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "Name": {
|
| + "description": "Details of the user's name.",
|
| + "id": "Name",
|
| + "properties": {
|
| + "givenName": {
|
| + "description": "The user's first name.\n\nRead-only.",
|
| + "type": "string"
|
| + },
|
| + "familyName": {
|
| + "description": "The user's last name.\n\nRead-only.",
|
| + "type": "string"
|
| + },
|
| + "fullName": {
|
| + "description": "The user's full name formed by concatenating the first and last name\nvalues.\n\nRead-only.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ListStudentsResponse": {
|
| - "description": "Response when listing students.",
|
| - "id": "ListStudentsResponse",
|
| + "CourseMaterial": {
|
| + "description": "A material attached to a course as part of a material set.",
|
| + "id": "CourseMaterial",
|
| "properties": {
|
| - "students": {
|
| - "description": "Students who match the list request.",
|
| - "items": {
|
| - "$ref": "Student"
|
| - },
|
| - "type": "array"
|
| + "driveFile": {
|
| + "$ref": "DriveFile",
|
| + "description": "Google Drive file attachment."
|
| },
|
| - "nextPageToken": {
|
| - "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
|
| - "type": "string"
|
| + "youTubeVideo": {
|
| + "$ref": "YouTubeVideo",
|
| + "description": "Youtube video attachment."
|
| + },
|
| + "form": {
|
| + "$ref": "Form",
|
| + "description": "Google Forms attachment."
|
| + },
|
| + "link": {
|
| + "$ref": "Link",
|
| + "description": "Link atatchment."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Student": {
|
| - "description": "Student in a course.",
|
| - "id": "Student",
|
| + "Assignment": {
|
| + "description": "Additional details for assignments.",
|
| + "id": "Assignment",
|
| "properties": {
|
| - "profile": {
|
| - "$ref": "UserProfile",
|
| - "description": "Global user information for the student.\n\nRead-only."
|
| - },
|
| "studentWorkFolder": {
|
| "$ref": "DriveFolder",
|
| - "description": "Information about a Drive Folder for this student's work in this course.\nOnly visible to the student and domain administrators.\n\nRead-only."
|
| - },
|
| - "userId": {
|
| - "description": "Identifier of the user.\n\nWhen specified as a parameter of a request, this identifier can be one of\nthe following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
|
| - "type": "string"
|
| - },
|
| - "courseId": {
|
| - "description": "Identifier of the course.\n\nRead-only.",
|
| - "type": "string"
|
| + "description": "Drive folder where attachments from student submissions are placed.\nThis is only populated for course teachers."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Invitation": {
|
| - "description": "An invitation to join a course.",
|
| - "id": "Invitation",
|
| + "SharedDriveFile": {
|
| + "description": "Drive file that is used as material for course work.",
|
| + "id": "SharedDriveFile",
|
| "properties": {
|
| - "courseId": {
|
| - "description": "Identifier of the course to invite the user to.",
|
| - "type": "string"
|
| - },
|
| - "id": {
|
| - "description": "Identifier assigned by Classroom.\n\nRead-only.",
|
| - "type": "string"
|
| + "driveFile": {
|
| + "$ref": "DriveFile",
|
| + "description": "Drive file details."
|
| },
|
| - "role": {
|
| - "description": "Role to invite the user to have.\nMust not be `COURSE_ROLE_UNSPECIFIED`.",
|
| + "shareMode": {
|
| + "description": "Mechanism by which students access the Drive item.",
|
| "enum": [
|
| - "COURSE_ROLE_UNSPECIFIED",
|
| - "STUDENT",
|
| - "TEACHER"
|
| + "UNKNOWN_SHARE_MODE",
|
| + "VIEW",
|
| + "EDIT",
|
| + "STUDENT_COPY"
|
| ],
|
| "enumDescriptions": [
|
| - "No course role.",
|
| - "Student in the course.",
|
| - "Teacher of the course."
|
| + "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."
|
| ],
|
| "type": "string"
|
| - },
|
| - "userId": {
|
| - "description": "Identifier of the invited user.\n\nWhen specified as a parameter of a request, this identifier can be set to\none of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
|
| - "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "DriveFolder": {
|
| - "description": "Representation of a Google Drive folder.",
|
| - "id": "DriveFolder",
|
| - "properties": {
|
| - "alternateLink": {
|
| - "description": "URL that can be used to access the Drive folder.\n\nRead-only.",
|
| - "type": "string"
|
| - },
|
| - "id": {
|
| - "description": "Drive API resource ID.",
|
| - "type": "string"
|
| - },
|
| - "title": {
|
| - "description": "Title of the Drive folder.\n\nRead-only.",
|
| - "type": "string"
|
| - }
|
| - },
|
| + "Empty": {
|
| + "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
|
| + "id": "Empty",
|
| + "properties": {},
|
| "type": "object"
|
| },
|
| - "ShortAnswerSubmission": {
|
| - "description": "Student work for a short answer question.",
|
| - "id": "ShortAnswerSubmission",
|
| + "MultipleChoiceQuestion": {
|
| + "description": "Additional details for multiple-choice questions.",
|
| + "id": "MultipleChoiceQuestion",
|
| "properties": {
|
| - "answer": {
|
| - "description": "Student response to a short-answer question.",
|
| - "type": "string"
|
| + "choices": {
|
| + "description": "Possible choices.",
|
| + "items": {
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "StudentSubmission": {
|
| - "description": "Student submission for course work.\n\nStudentSubmission items are generated when a CourseWork item is created.\n\nStudentSubmissions that have never been accessed (i.e. with `state` = NEW)\nmay not have a creation time or update time.",
|
| - "id": "StudentSubmission",
|
| + "Course": {
|
| + "description": "A Course in Classroom.",
|
| + "id": "Course",
|
| "properties": {
|
| - "late": {
|
| - "description": "Whether this submission is late.\n\nRead-only.",
|
| - "type": "boolean"
|
| - },
|
| - "draftGrade": {
|
| - "description": "Optional pending grade. If unset, no grade was set.\nThis must be a non-negative integer value.\n\nThis is only visible to and modifiable by course teachers.",
|
| - "format": "double",
|
| - "type": "number"
|
| + "updateTime": {
|
| + "description": "Time of the most recent update to this course.\nSpecifying this field in a course update mask results in an error.\n\nRead-only.",
|
| + "format": "google-datetime",
|
| + "type": "string"
|
| },
|
| - "courseWorkType": {
|
| - "description": "Type of course work this submission is for.\n\nRead-only.",
|
| - "enum": [
|
| - "COURSE_WORK_TYPE_UNSPECIFIED",
|
| - "ASSIGNMENT",
|
| - "SHORT_ANSWER_QUESTION",
|
| - "MULTIPLE_CHOICE_QUESTION"
|
| - ],
|
| - "enumDescriptions": [
|
| - "No work type specified. This is never returned.",
|
| - "An assignment.",
|
| - "A short answer question.",
|
| - "A multiple-choice question."
|
| - ],
|
| + "calendarId": {
|
| + "description": "The Calendar ID for a calendar that all course members can see, to which\nClassroom adds events for course work and announcements in the course.\n\nRead-only.",
|
| "type": "string"
|
| },
|
| - "creationTime": {
|
| - "description": "Creation time of this submission.\nThis may be unset if the student has not accessed this item.\n\nRead-only.",
|
| - "format": "google-datetime",
|
| + "alternateLink": {
|
| + "description": "Absolute link to this course in the Classroom web UI.\n\nRead-only.",
|
| "type": "string"
|
| },
|
| - "state": {
|
| - "description": "State of this submission.\n\nRead-only.",
|
| + "guardiansEnabled": {
|
| + "description": "Whether or not guardian notifications are enabled for this course.\n\nRead-only.",
|
| + "type": "boolean"
|
| + },
|
| + "courseState": {
|
| + "description": "State of the course.\nIf unspecified, the default state is `PROVISIONED`.",
|
| "enum": [
|
| - "SUBMISSION_STATE_UNSPECIFIED",
|
| - "NEW",
|
| - "CREATED",
|
| - "TURNED_IN",
|
| - "RETURNED",
|
| - "RECLAIMED_BY_STUDENT"
|
| + "COURSE_STATE_UNSPECIFIED",
|
| + "ACTIVE",
|
| + "ARCHIVED",
|
| + "PROVISIONED",
|
| + "DECLINED",
|
| + "SUSPENDED"
|
| ],
|
| "enumDescriptions": [
|
| - "No state specified. This should never be returned.",
|
| - "The student has never accessed this submission. Attachments are not\nreturned 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."
|
| + "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\nto a different state.",
|
| + "The course has been created, but not yet activated. It is accessible by\nthe primary teacher and domain administrators, who may modify it or\nchange it to the `ACTIVE` or `DECLINED` states.\nA course may only be changed to `PROVISIONED` if it is in the `DECLINED`\nstate.",
|
| + "The course has been created, but declined. It is accessible by the\ncourse owner and domain administrators, though it will not be\ndisplayed in the web UI. You cannot modify the course except to change it\nto the `PROVISIONED` state.\nA course may only be changed to `DECLINED` if it is in the `PROVISIONED`\nstate.",
|
| + "The course has been suspended. You cannot modify the course, and only the\nuser identified by the `owner_id` can view the course.\nA course may be placed in this state if it potentially violates the\nTerms of Service."
|
| ],
|
| "type": "string"
|
| },
|
| - "userId": {
|
| - "description": "Identifier for the student that owns this submission.\n\nRead-only.",
|
| + "ownerId": {
|
| + "description": "The identifier of the owner of a course.\n\nWhen specified as a parameter of a\ncreate course request, this\nfield is required.\nThe identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user\n\nThis must be set in a create request. Specifying this field in a course\nupdate mask results in an `INVALID_ARGUMENT` error.",
|
| "type": "string"
|
| },
|
| - "courseWorkId": {
|
| - "description": "Identifier for the course work this corresponds to.\n\nRead-only.",
|
| + "description": {
|
| + "description": "Optional description.\nFor example, \"We'll be learning about the structure of living\ncreatures from a combination of textbooks, guest lectures, and lab work.\nExpect to be excited!\"\nIf set, this field must be a valid UTF-8 string and no longer than 30,000\ncharacters.",
|
| "type": "string"
|
| },
|
| - "courseId": {
|
| - "description": "Identifier of the course.\n\nRead-only.",
|
| + "teacherGroupEmail": {
|
| + "description": "The email address of a Google group containing all teachers of the course.\nThis group does not accept email and can only be used for permissions.\n\nRead-only.",
|
| "type": "string"
|
| },
|
| - "id": {
|
| - "description": "Classroom-assigned Identifier for the student submission.\nThis is unique among submissions for the relevant course work.\n\nRead-only.",
|
| + "creationTime": {
|
| + "description": "Creation time of the course.\nSpecifying this field in a course update mask results in an error.\n\nRead-only.",
|
| + "format": "google-datetime",
|
| "type": "string"
|
| },
|
| - "assignedGrade": {
|
| - "description": "Optional grade. If unset, no grade was set.\nThis must be a non-negative integer value.\n\nThis may be modified only by course teachers.",
|
| - "format": "double",
|
| - "type": "number"
|
| + "name": {
|
| + "description": "Name of the course.\nFor example, \"10th Grade Biology\".\nThe name is required. It must be between 1 and 750 characters and a valid\nUTF-8 string.",
|
| + "type": "string"
|
| },
|
| - "multipleChoiceSubmission": {
|
| - "$ref": "MultipleChoiceSubmission",
|
| - "description": "Submission content when course_work_type is MULTIPLE_CHOICE_QUESTION."
|
| + "teacherFolder": {
|
| + "$ref": "DriveFolder",
|
| + "description": "Information about a Drive Folder that is shared with all teachers of the\ncourse.\n\nThis field will only be set for teachers of the course and domain administrators.\n\nRead-only."
|
| },
|
| - "assignmentSubmission": {
|
| - "$ref": "AssignmentSubmission",
|
| - "description": "Submission content when course_work_type is ASSIGNMENT ."
|
| + "section": {
|
| + "description": "Section of the course.\nFor example, \"Period 2\".\nIf set, this field must be a valid UTF-8 string and no longer than 2800\ncharacters.",
|
| + "type": "string"
|
| },
|
| - "shortAnswerSubmission": {
|
| - "$ref": "ShortAnswerSubmission",
|
| - "description": "Submission content when course_work_type is SHORT_ANSWER_QUESTION."
|
| + "id": {
|
| + "description": "Identifier for this course assigned by Classroom.\n\nWhen\ncreating a course,\nyou may optionally set this identifier to an\nalias string in the\nrequest to create a corresponding alias. The `id` is still assigned by\nClassroom and cannot be updated after the course is created.\n\nSpecifying this field in a course update mask results in an error.",
|
| + "type": "string"
|
| },
|
| - "associatedWithDeveloper": {
|
| - "description": "Whether this student submission is associated with the Developer Console\nproject making the request.\n\nSee google.classroom.Work.CreateCourseWork for more\ndetails.\n\nRead-only.",
|
| - "type": "boolean"
|
| + "room": {
|
| + "description": "Optional room location.\nFor example, \"301\".\nIf set, this field must be a valid UTF-8 string and no longer than 650\ncharacters.",
|
| + "type": "string"
|
| },
|
| - "updateTime": {
|
| - "description": "Last update time of this submission.\nThis may be unset if the student has not accessed this item.\n\nRead-only.",
|
| - "format": "google-datetime",
|
| + "courseGroupEmail": {
|
| + "description": "The email address of a Google group containing all members of the course.\nThis group does not accept email and can only be used for permissions.\n\nRead-only.",
|
| + "type": "string"
|
| + },
|
| + "courseMaterialSets": {
|
| + "description": "Sets of materials that appear on the \"about\" page of this course.\n\nRead-only.",
|
| + "items": {
|
| + "$ref": "CourseMaterialSet"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "enrollmentCode": {
|
| + "description": "Enrollment code to use when joining this course.\nSpecifying this field in a course update mask results in an error.\n\nRead-only.",
|
| "type": "string"
|
| },
|
| - "alternateLink": {
|
| - "description": "Absolute link to the submission in the Classroom web UI.\n\nRead-only.",
|
| + "descriptionHeading": {
|
| + "description": "Optional heading for the description.\nFor example, \"Welcome to 10th Grade Biology.\"\nIf set, this field must be a valid UTF-8 string and no longer than 3600\ncharacters.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ListStudentSubmissionsResponse": {
|
| - "description": "Response when listing student submissions.",
|
| - "id": "ListStudentSubmissionsResponse",
|
| + "DriveFile": {
|
| + "description": "Representation of a Google Drive file.",
|
| + "id": "DriveFile",
|
| "properties": {
|
| - "nextPageToken": {
|
| - "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
|
| + "thumbnailUrl": {
|
| + "description": "URL of a thumbnail image of the Drive item.\n\nRead-only.",
|
| "type": "string"
|
| },
|
| - "studentSubmissions": {
|
| - "description": "Student work that matches the request.",
|
| - "items": {
|
| - "$ref": "StudentSubmission"
|
| - },
|
| - "type": "array"
|
| + "id": {
|
| + "description": "Drive API resource ID.",
|
| + "type": "string"
|
| + },
|
| + "title": {
|
| + "description": "Title of the Drive item.\n\nRead-only.",
|
| + "type": "string"
|
| + },
|
| + "alternateLink": {
|
| + "description": "URL that can be used to access the Drive item.\n\nRead-only.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "TurnInStudentSubmissionRequest": {
|
| - "description": "Request to turn in a student submission.",
|
| - "id": "TurnInStudentSubmissionRequest",
|
| + "ReturnStudentSubmissionRequest": {
|
| + "description": "Request to return a student submission.",
|
| + "id": "ReturnStudentSubmissionRequest",
|
| "properties": {},
|
| "type": "object"
|
| },
|
| - "ModifyAttachmentsRequest": {
|
| - "description": "Request to modify the attachments of a student submission.",
|
| - "id": "ModifyAttachmentsRequest",
|
| + "GlobalPermission": {
|
| + "description": "Global user permission description.",
|
| + "id": "GlobalPermission",
|
| "properties": {
|
| - "addAttachments": {
|
| - "description": "Attachments to add.\nA student submission may not have more than 20 attachments.\n\nForm attachments are not supported.",
|
| - "items": {
|
| - "$ref": "Attachment"
|
| - },
|
| - "type": "array"
|
| + "permission": {
|
| + "description": "Permission value.",
|
| + "enum": [
|
| + "PERMISSION_UNSPECIFIED",
|
| + "CREATE_COURSE"
|
| + ],
|
| + "enumDescriptions": [
|
| + "No permission is specified. This is not returned and is not a\nvalid value.",
|
| + "User is permitted to create a course."
|
| + ],
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ListCourseWorkResponse": {
|
| - "description": "Response when listing course work.",
|
| - "id": "ListCourseWorkResponse",
|
| + "Teacher": {
|
| + "description": "Teacher of a course.",
|
| + "id": "Teacher",
|
| "properties": {
|
| - "nextPageToken": {
|
| - "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
|
| + "profile": {
|
| + "$ref": "UserProfile",
|
| + "description": "Global user information for the teacher.\n\nRead-only."
|
| + },
|
| + "userId": {
|
| + "description": "Identifier of the user.\n\nWhen specified as a parameter of a request, this identifier can be one of\nthe following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
|
| "type": "string"
|
| },
|
| - "courseWork": {
|
| - "description": "Course work items that match the request.",
|
| + "courseId": {
|
| + "description": "Identifier of the course.\n\nRead-only.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "ReclaimStudentSubmissionRequest": {
|
| + "description": "Request to reclaim a student submission.",
|
| + "id": "ReclaimStudentSubmissionRequest",
|
| + "properties": {},
|
| + "type": "object"
|
| + },
|
| + "AssignmentSubmission": {
|
| + "description": "Student work for an assignment.",
|
| + "id": "AssignmentSubmission",
|
| + "properties": {
|
| + "attachments": {
|
| + "description": "Attachments added by the student.\nDrive files that correspond to materials with a share mode of\nSTUDENT_COPY may not exist yet if the student has not accessed the\nassignment in Classroom.\n\nSome attachment metadata is only populated if the requesting user has\npermission to access it. Identifier and alternate_link fields are always\navailable, but others (e.g. title) may not be.",
|
| "items": {
|
| - "$ref": "CourseWork"
|
| + "$ref": "Attachment"
|
| },
|
| "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "YouTubeVideo": {
|
| - "description": "YouTube video item.",
|
| - "id": "YouTubeVideo",
|
| + "Material": {
|
| + "description": "Material attached to course work.\n\nWhen creating attachments, setting the `form` field is not supported.",
|
| + "id": "Material",
|
| "properties": {
|
| - "alternateLink": {
|
| - "description": "URL that can be used to view the YouTube video.\n\nRead-only.",
|
| - "type": "string"
|
| + "driveFile": {
|
| + "$ref": "SharedDriveFile",
|
| + "description": "Google Drive file material."
|
| },
|
| - "thumbnailUrl": {
|
| - "description": "URL of a thumbnail image of the YouTube video.\n\nRead-only.",
|
| - "type": "string"
|
| + "form": {
|
| + "$ref": "Form",
|
| + "description": "Google Forms material."
|
| },
|
| - "id": {
|
| - "description": "YouTube API resource ID.",
|
| - "type": "string"
|
| + "link": {
|
| + "$ref": "Link",
|
| + "description": "Link material. On creation, will be upgraded to a more appropriate type\nif possible, and this will be reflected in the response."
|
| },
|
| - "title": {
|
| - "description": "Title of the YouTube video.\n\nRead-only.",
|
| - "type": "string"
|
| + "youtubeVideo": {
|
| + "$ref": "YouTubeVideo",
|
| + "description": "YouTube video material."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ListInvitationsResponse": {
|
| - "description": "Response when listing invitations.",
|
| - "id": "ListInvitationsResponse",
|
| + "CourseWork": {
|
| + "description": "Course work created by a teacher for students of the course.",
|
| + "id": "CourseWork",
|
| "properties": {
|
| - "nextPageToken": {
|
| - "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
|
| - "type": "string"
|
| - },
|
| - "invitations": {
|
| - "description": "Invitations that match the list request.",
|
| + "materials": {
|
| + "description": "Additional materials.\n\nCourseWork must have no more than 20 material items.",
|
| "items": {
|
| - "$ref": "Invitation"
|
| + "$ref": "Material"
|
| },
|
| "type": "array"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "GuardianInvitation": {
|
| - "description": "An invitation to become the guardian of a specified user, sent to a specified\nemail address.",
|
| - "id": "GuardianInvitation",
|
| - "properties": {
|
| - "studentId": {
|
| - "description": "ID of the student (in standard format)",
|
| + },
|
| + "associatedWithDeveloper": {
|
| + "description": "Whether this course work item is associated with the Developer Console\nproject making the request.\n\nSee google.classroom.Work.CreateCourseWork for more\ndetails.\n\nRead-only.",
|
| + "type": "boolean"
|
| + },
|
| + "updateTime": {
|
| + "description": "Timestamp of the most recent change to this course work.\n\nRead-only.",
|
| + "format": "google-datetime",
|
| "type": "string"
|
| },
|
| - "state": {
|
| - "description": "The state that this invitation is in.",
|
| + "alternateLink": {
|
| + "description": "Absolute link to this course work in the Classroom web UI.\nThis is only populated if `state` is `PUBLISHED`.\n\nRead-only.",
|
| + "type": "string"
|
| + },
|
| + "maxPoints": {
|
| + "description": "Maximum grade for this course work.\nIf zero or unspecified, this assignment is considered ungraded.\nThis must be a non-negative integer value.",
|
| + "format": "double",
|
| + "type": "number"
|
| + },
|
| + "workType": {
|
| + "description": "Type of this course work.\n\nThe type is set when the course work is created and cannot be changed.",
|
| "enum": [
|
| - "GUARDIAN_INVITATION_STATE_UNSPECIFIED",
|
| - "PENDING",
|
| - "COMPLETE"
|
| + "COURSE_WORK_TYPE_UNSPECIFIED",
|
| + "ASSIGNMENT",
|
| + "SHORT_ANSWER_QUESTION",
|
| + "MULTIPLE_CHOICE_QUESTION"
|
| ],
|
| "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,\nwithdrawn or it may have expired."
|
| + "No work type specified. This is never returned.",
|
| + "An assignment.",
|
| + "A short answer question.",
|
| + "A multiple-choice question."
|
| ],
|
| "type": "string"
|
| },
|
| - "invitedEmailAddress": {
|
| - "description": "Email address that the invitation was sent to.\nThis field is only visible to domain administrators.",
|
| + "assignment": {
|
| + "$ref": "Assignment",
|
| + "description": "Assignment details.\nThis is populated only when `work_type` is `ASSIGNMENT`.\n\nRead-only."
|
| + },
|
| + "multipleChoiceQuestion": {
|
| + "$ref": "MultipleChoiceQuestion",
|
| + "description": "Multiple choice question details.\nFor read operations, this field is populated only when `work_type` is\n`MULTIPLE_CHOICE_QUESTION`.\nFor write operations, this field must be specified when creating course\nwork with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be\nset otherwise."
|
| + },
|
| + "description": {
|
| + "description": "Optional description of this course work.\nIf set, the description must be a valid UTF-8 string containing no more\nthan 30,000 characters.",
|
| "type": "string"
|
| },
|
| - "creationTime": {
|
| - "description": "The time that this invitation was created.\n\nRead-only.",
|
| + "scheduledTime": {
|
| + "description": "Optional timestamp when this course work is scheduled to be published.",
|
| "format": "google-datetime",
|
| "type": "string"
|
| },
|
| - "invitationId": {
|
| - "description": "Unique identifier for this invitation.\n\nRead-only.",
|
| + "creationTime": {
|
| + "description": "Timestamp when this course work was created.\n\nRead-only.",
|
| + "format": "google-datetime",
|
| "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "Attachment": {
|
| - "description": "Attachment added to student assignment work.\n\nWhen creating attachments, setting the `form` field is not supported.",
|
| - "id": "Attachment",
|
| - "properties": {
|
| - "driveFile": {
|
| - "$ref": "DriveFile",
|
| - "description": "Google Drive file attachment."
|
| },
|
| - "youTubeVideo": {
|
| - "$ref": "YouTubeVideo",
|
| - "description": "Youtube video attachment."
|
| + "dueDate": {
|
| + "$ref": "Date",
|
| + "description": "Optional date, in UTC, that submissions for this this course work are due.\nThis must be specified if `due_time` is specified."
|
| },
|
| - "form": {
|
| - "$ref": "Form",
|
| - "description": "Google Forms attachment."
|
| + "submissionModificationMode": {
|
| + "description": "Setting to determine when students are allowed to modify submissions.\nIf unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.",
|
| + "enum": [
|
| + "SUBMISSION_MODIFICATION_MODE_UNSPECIFIED",
|
| + "MODIFIABLE_UNTIL_TURNED_IN",
|
| + "MODIFIABLE"
|
| + ],
|
| + "enumDescriptions": [
|
| + "No modification mode specified. This is never returned.",
|
| + "Submisisons can be modified before being turned in.",
|
| + "Submisisons can be modified at any time."
|
| + ],
|
| + "type": "string"
|
| },
|
| - "link": {
|
| - "$ref": "Link",
|
| - "description": "Link attachment."
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "CourseMaterialSet": {
|
| - "description": "A set of materials that appears on the \"About\" page of the course.\nThese materials might include a syllabus, schedule, or other background\ninformation relating to the course as a whole.",
|
| - "id": "CourseMaterialSet",
|
| - "properties": {
|
| - "title": {
|
| - "description": "Title for this set.",
|
| + "state": {
|
| + "description": "Status of this course work.\nIf unspecified, the default state is `DRAFT`.",
|
| + "enum": [
|
| + "COURSE_WORK_STATE_UNSPECIFIED",
|
| + "PUBLISHED",
|
| + "DRAFT",
|
| + "DELETED"
|
| + ],
|
| + "enumDescriptions": [
|
| + "No state specified. This is never returned.",
|
| + "Status for work that has been published.\nThis is the default state.",
|
| + "Status for work that is not yet published.\nWork in this state is visible only to course teachers and domain\nadministrators.",
|
| + "Status for work that was published but is now deleted.\nWork in this state is visible only to course teachers and domain\nadministrators.\nWork in this state is deleted after some time."
|
| + ],
|
| "type": "string"
|
| },
|
| - "materials": {
|
| - "description": "Materials attached to this set.",
|
| - "items": {
|
| - "$ref": "CourseMaterial"
|
| - },
|
| - "type": "array"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "TimeOfDay": {
|
| - "description": "Represents a time of day. The date and time zone are either not significant\nor are specified elsewhere. An API may choose to allow leap seconds. Related\ntypes are google.type.Date and `google.protobuf.Timestamp`.",
|
| - "id": "TimeOfDay",
|
| - "properties": {
|
| - "nanos": {
|
| - "description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| + "courseId": {
|
| + "description": "Identifier of the course.\n\nRead-only.",
|
| + "type": "string"
|
| },
|
| - "seconds": {
|
| - "description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may\nallow the value 60 if it allows leap-seconds.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| + "id": {
|
| + "description": "Classroom-assigned identifier of this course work, unique per course.\n\nRead-only.",
|
| + "type": "string"
|
| },
|
| - "minutes": {
|
| - "description": "Minutes of hour of day. Must be from 0 to 59.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| + "dueTime": {
|
| + "$ref": "TimeOfDay",
|
| + "description": "Optional time of day, in UTC, that submissions for this this course work\nare due.\nThis must be specified if `due_date` is specified."
|
| },
|
| - "hours": {
|
| - "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose\nto allow the value \"24:00:00\" for scenarios like business closing time.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "ListCoursesResponse": {
|
| - "description": "Response when listing courses.",
|
| - "id": "ListCoursesResponse",
|
| - "properties": {
|
| - "nextPageToken": {
|
| - "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
|
| + "title": {
|
| + "description": "Title of this course work.\nThe title must be a valid UTF-8 string containing between 1 and 3000\ncharacters.",
|
| "type": "string"
|
| - },
|
| - "courses": {
|
| - "description": "Courses that match the list request.",
|
| - "items": {
|
| - "$ref": "Course"
|
| - },
|
| - "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Form": {
|
| - "description": "Google Forms item.",
|
| - "id": "Form",
|
| + "Guardian": {
|
| + "description": "Association between a student and a guardian of that student. The guardian\nmay receive information about the student's course work.",
|
| + "id": "Guardian",
|
| "properties": {
|
| - "formUrl": {
|
| - "description": "URL of the form.",
|
| + "guardianId": {
|
| + "description": "Identifier for the guardian.",
|
| "type": "string"
|
| },
|
| - "title": {
|
| - "description": "Title of the Form.\n\nRead-only.",
|
| + "invitedEmailAddress": {
|
| + "description": "The email address to which the initial guardian invitation was sent.\nThis field is only visible to domain administrators.",
|
| "type": "string"
|
| },
|
| - "thumbnailUrl": {
|
| - "description": "URL of a thumbnail image of the Form.\n\nRead-only.",
|
| - "type": "string"
|
| + "guardianProfile": {
|
| + "$ref": "UserProfile",
|
| + "description": "User profile for the guardian."
|
| },
|
| - "responseUrl": {
|
| - "description": "URL of the form responses document.\nOnly set if respsonses have been recorded and only when the\nrequesting user is an editor of the form.\n\nRead-only.",
|
| + "studentId": {
|
| + "description": "Identifier for the student to whom the guardian relationship applies.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ListTeachersResponse": {
|
| - "description": "Response when listing teachers.",
|
| - "id": "ListTeachersResponse",
|
| + "ListStudentsResponse": {
|
| + "description": "Response when listing students.",
|
| + "id": "ListStudentsResponse",
|
| "properties": {
|
| - "teachers": {
|
| - "description": "Teachers who match the list request.",
|
| + "students": {
|
| + "description": "Students who match the list request.",
|
| "items": {
|
| - "$ref": "Teacher"
|
| + "$ref": "Student"
|
| },
|
| "type": "array"
|
| },
|
| @@ -2580,118 +2590,121 @@
|
| },
|
| "type": "object"
|
| },
|
| - "Link": {
|
| - "description": "URL item.",
|
| - "id": "Link",
|
| + "UserProfile": {
|
| + "description": "Global information for a user.",
|
| + "id": "UserProfile",
|
| "properties": {
|
| - "thumbnailUrl": {
|
| - "description": "URL of a thumbnail image of the target URL.\n\nRead-only.",
|
| + "id": {
|
| + "description": "Identifier of the user.\n\nRead-only.",
|
| "type": "string"
|
| },
|
| - "url": {
|
| - "description": "URL to link to.\nThis must be a valid UTF-8 string containing between 1 and 2024 characters.",
|
| + "verifiedTeacher": {
|
| + "description": "Whether or not the user is a verified teacher\n\nRead-only",
|
| + "type": "boolean"
|
| + },
|
| + "emailAddress": {
|
| + "description": "Email address of the user.\n\nRead-only.",
|
| "type": "string"
|
| },
|
| - "title": {
|
| - "description": "Title of the target of the URL.\n\nRead-only.",
|
| + "photoUrl": {
|
| + "description": "URL of user's profile photo.\n\nRead-only.",
|
| "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "ListGuardiansResponse": {
|
| - "description": "Response when listing guardians.",
|
| - "id": "ListGuardiansResponse",
|
| - "properties": {
|
| - "guardians": {
|
| - "description": "Guardians on this page of results that met the criteria specified in\nthe request.",
|
| + },
|
| + "permissions": {
|
| + "description": "Global permissions of the user.\n\nRead-only.",
|
| "items": {
|
| - "$ref": "Guardian"
|
| + "$ref": "GlobalPermission"
|
| },
|
| "type": "array"
|
| },
|
| - "nextPageToken": {
|
| - "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
|
| - "type": "string"
|
| + "name": {
|
| + "$ref": "Name",
|
| + "description": "Name of the user.\n\nRead-only."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ListCourseAliasesResponse": {
|
| - "description": "Response when listing course aliases.",
|
| - "id": "ListCourseAliasesResponse",
|
| + "Student": {
|
| + "description": "Student in a course.",
|
| + "id": "Student",
|
| "properties": {
|
| - "aliases": {
|
| - "description": "The course aliases.",
|
| - "items": {
|
| - "$ref": "CourseAlias"
|
| - },
|
| - "type": "array"
|
| + "profile": {
|
| + "$ref": "UserProfile",
|
| + "description": "Global user information for the student.\n\nRead-only."
|
| },
|
| - "nextPageToken": {
|
| - "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
|
| + "studentWorkFolder": {
|
| + "$ref": "DriveFolder",
|
| + "description": "Information about a Drive Folder for this student's work in this course.\nOnly visible to the student and domain administrators.\n\nRead-only."
|
| + },
|
| + "userId": {
|
| + "description": "Identifier of the user.\n\nWhen specified as a parameter of a request, this identifier can be one of\nthe following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
|
| "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "CourseAlias": {
|
| - "description": "Alternative identifier for a course.\n\nAn alias uniquely identifies a course. It must be unique within one of the\nfollowing scopes:\n\n* domain: A domain-scoped alias is visible to all users within the alias\ncreator's domain and can be created only by a domain admin. A domain-scoped\nalias is often used when a course has an identifier external to Classroom.\n\n* project: A project-scoped alias is visible to any request from an\napplication using the Developer Console project ID that created the alias\nand can be created by any project. A project-scoped alias is often used when\nan application has alternative identifiers. A random value can also be used\nto avoid duplicate courses in the event of transmission failures, as retrying\na request will return `ALREADY_EXISTS` if a previous one has succeeded.",
|
| - "id": "CourseAlias",
|
| - "properties": {
|
| - "alias": {
|
| - "description": "Alias string. The format of the string indicates the desired alias scoping.\n\n* `d:<name>` indicates a domain-scoped alias.\n Example: `d:math_101`\n* `p:<name>` indicates a project-scoped alias.\n Example: `p:abc123`\n\nThis field has a maximum length of 256 characters.",
|
| + },
|
| + "courseId": {
|
| + "description": "Identifier of the course.\n\nRead-only.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ListGuardianInvitationsResponse": {
|
| - "description": "Response when listing guardian invitations.",
|
| - "id": "ListGuardianInvitationsResponse",
|
| + "Invitation": {
|
| + "description": "An invitation to join a course.",
|
| + "id": "Invitation",
|
| "properties": {
|
| - "nextPageToken": {
|
| - "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
|
| + "courseId": {
|
| + "description": "Identifier of the course to invite the user to.",
|
| "type": "string"
|
| },
|
| - "guardianInvitations": {
|
| - "description": "Guardian invitations that matched the list request.",
|
| - "items": {
|
| - "$ref": "GuardianInvitation"
|
| - },
|
| - "type": "array"
|
| + "id": {
|
| + "description": "Identifier assigned by Classroom.\n\nRead-only.",
|
| + "type": "string"
|
| + },
|
| + "role": {
|
| + "description": "Role to invite the user to have.\nMust not be `COURSE_ROLE_UNSPECIFIED`.",
|
| + "enum": [
|
| + "COURSE_ROLE_UNSPECIFIED",
|
| + "STUDENT",
|
| + "TEACHER"
|
| + ],
|
| + "enumDescriptions": [
|
| + "No course role.",
|
| + "Student in the course.",
|
| + "Teacher of the course."
|
| + ],
|
| + "type": "string"
|
| + },
|
| + "userId": {
|
| + "description": "Identifier of the invited user.\n\nWhen specified as a parameter of a request, this identifier can be set to\none of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Date": {
|
| - "description": "Represents a whole calendar date, e.g. date of birth. The time of day and\ntime zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. The day may be 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independent\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.",
|
| - "id": "Date",
|
| + "DriveFolder": {
|
| + "description": "Representation of a Google Drive folder.",
|
| + "id": "DriveFolder",
|
| "properties": {
|
| - "year": {
|
| - "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| + "title": {
|
| + "description": "Title of the Drive folder.\n\nRead-only.",
|
| + "type": "string"
|
| },
|
| - "day": {
|
| - "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not significant.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| + "alternateLink": {
|
| + "description": "URL that can be used to access the Drive folder.\n\nRead-only.",
|
| + "type": "string"
|
| },
|
| - "month": {
|
| - "description": "Month of year. Must be from 1 to 12.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| + "id": {
|
| + "description": "Drive API resource ID.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "MultipleChoiceSubmission": {
|
| - "description": "Student work for a multiple-choice question.",
|
| - "id": "MultipleChoiceSubmission",
|
| + "ShortAnswerSubmission": {
|
| + "description": "Student work for a short answer question.",
|
| + "id": "ShortAnswerSubmission",
|
| "properties": {
|
| "answer": {
|
| - "description": "Student's select choice.",
|
| + "description": "Student response to a short-answer question.",
|
| "type": "string"
|
| }
|
| },
|
|
|
Chromium Code Reviews
Issue 2936613002:
Api-Roll 50: 2017-06-12 (Closed)
