| Index: discovery/googleapis/classroom__v1.json
|
| diff --git a/discovery/googleapis/classroom__v1.json b/discovery/googleapis/classroom__v1.json
|
| index c149a72a73aed8d39c470c393b4533f181522a9d..77475a050598062c79e9f679c4feb0cb9c335b01 100644
|
| --- a/discovery/googleapis/classroom__v1.json
|
| +++ b/discovery/googleapis/classroom__v1.json
|
| @@ -2,21 +2,42 @@
|
| "auth": {
|
| "oauth2": {
|
| "scopes": {
|
| + "https://www.googleapis.com/auth/classroom.rosters": {
|
| + "description": "Manage your Google Classroom class rosters"
|
| + },
|
| + "https://www.googleapis.com/auth/classroom.student-submissions.students.readonly": {
|
| + "description": "View course work and grades for students in the Google Classroom classes you teach or administer"
|
| + },
|
| + "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly": {
|
| + "description": "View guardians for students in your Google Classroom classes"
|
| + },
|
| + "https://www.googleapis.com/auth/classroom.courses": {
|
| + "description": "Manage your Google Classroom classes"
|
| + },
|
| + "https://www.googleapis.com/auth/classroom.courses.readonly": {
|
| + "description": "View your Google Classroom classes"
|
| + },
|
| + "https://www.googleapis.com/auth/classroom.rosters.readonly": {
|
| + "description": "View your Google Classroom class rosters"
|
| + },
|
| + "https://www.googleapis.com/auth/classroom.profile.photos": {
|
| + "description": "View the profile photos of people in your classes"
|
| + },
|
| "https://www.googleapis.com/auth/classroom.guardianlinks.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": {
|
| "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"
|
| },
|
| @@ -25,27 +46,6 @@
|
| },
|
| "https://www.googleapis.com/auth/classroom.coursework.me": {
|
| "description": "Manage your course work and view your grades in Google Classroom"
|
| - },
|
| - "https://www.googleapis.com/auth/classroom.rosters": {
|
| - "description": "Manage your Google Classroom class rosters"
|
| - },
|
| - "https://www.googleapis.com/auth/classroom.student-submissions.students.readonly": {
|
| - "description": "View course work and grades for students in the Google Classroom classes you teach or administer"
|
| - },
|
| - "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly": {
|
| - "description": "View guardians for students in your Google Classroom classes"
|
| - },
|
| - "https://www.googleapis.com/auth/classroom.courses": {
|
| - "description": "Manage your Google Classroom classes"
|
| - },
|
| - "https://www.googleapis.com/auth/classroom.courses.readonly": {
|
| - "description": "View your Google Classroom classes"
|
| - },
|
| - "https://www.googleapis.com/auth/classroom.profile.photos": {
|
| - "description": "View the profile photos of people in your classes"
|
| - },
|
| - "https://www.googleapis.com/auth/classroom.rosters.readonly": {
|
| - "description": "View your Google Classroom class rosters"
|
| }
|
| }
|
| }
|
| @@ -77,13 +77,13 @@
|
| "location": "query",
|
| "type": "boolean"
|
| },
|
| - "fields": {
|
| - "description": "Selector specifying which fields to include in a partial response.",
|
| + "uploadType": {
|
| + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
| "location": "query",
|
| "type": "string"
|
| },
|
| - "uploadType": {
|
| - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
| + "fields": {
|
| + "description": "Selector specifying which fields to include in a partial response.",
|
| "location": "query",
|
| "type": "string"
|
| },
|
| @@ -121,13 +121,13 @@
|
| "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.",
|
| + "access_token": {
|
| + "description": "OAuth access token.",
|
| "location": "query",
|
| "type": "string"
|
| },
|
| - "access_token": {
|
| - "description": "OAuth access token.",
|
| + "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"
|
| },
|
| @@ -185,88 +185,80 @@
|
| }
|
| },
|
| "resources": {
|
| - "guardianInvitations": {
|
| + "guardians": {
|
| "methods": {
|
| - "patch": {
|
| - "description": "Modifies a guardian invitation.\n\nCurrently, the only valid modification is to change the `state` from\n`PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the current user does not have permission to\n manage guardians, if guardians are not enabled for the domain in question\n or for other access errors.\n* `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state.\n* `INVALID_ARGUMENT` if the format of the student ID provided\n cannot be recognized (it is not an email address, nor a `user_id` from\n this API), or if the passed `GuardianInvitation` has a `state` other than\n `COMPLETE`, or if it modifies fields other than `state`.\n* `NOT_FOUND` if the student ID provided is a valid student ID, but\n Classroom has no record of that student, or if the `id` field does not\n refer to a guardian invitation known to Classroom.",
|
| - "httpMethod": "PATCH",
|
| - "id": "classroom.userProfiles.guardianInvitations.patch",
|
| + "delete": {
|
| + "description": "Deletes a guardian.\n\nThe guardian will no longer receive guardian notifications and the guardian\nwill no longer be accessible via the API.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if no user that matches the provided `student_id`\n is visible to the requesting user, if the requesting user is not\n permitted to manage guardians for the student identified by the\n `student_id`, 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).\n* `NOT_FOUND` if the requesting user is permitted to modify guardians for\n the requested `student_id`, but no `Guardian` record exists for that\n student with the provided `guardian_id`.",
|
| + "httpMethod": "DELETE",
|
| + "id": "classroom.userProfiles.guardians.delete",
|
| "parameterOrder": [
|
| "studentId",
|
| - "invitationId"
|
| + "guardianId"
|
| ],
|
| "parameters": {
|
| - "updateMask": {
|
| - "description": "Mask that identifies which fields on the course to update.\nThis field is required to do an update. The update will fail if invalid\nfields are specified. The following fields are valid:\n\n* `state`\n\nWhen set in a query parameter, this field should be specified as\n\n`updateMask=<field1>,<field2>,...`",
|
| - "format": "google-fieldmask",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "invitationId": {
|
| - "description": "The `id` field of the `GuardianInvitation` to be modified.",
|
| + "studentId": {
|
| + "description": "The student whose guardian is to be deleted. 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": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "studentId": {
|
| - "description": "The ID of the student whose guardian invitation is to be modified.",
|
| + "guardianId": {
|
| + "description": "The `id` field from a `Guardian`.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}",
|
| - "request": {
|
| - "$ref": "GuardianInvitation"
|
| - },
|
| + "path": "v1/userProfiles/{studentId}/guardians/{guardianId}",
|
| "response": {
|
| - "$ref": "GuardianInvitation"
|
| + "$ref": "Empty"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/classroom.guardianlinks.students"
|
| ]
|
| },
|
| "get": {
|
| - "description": "Returns a specific guardian invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view\n guardian invitations for the student identified by the `student_id`, if\n guardians are not enabled for the domain in question, or for other\n 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`).\n* `NOT_FOUND` if Classroom cannot find any record of the given student or\n `invitation_id`. May also be returned if the student exists, but the\n requesting user does not have access to see that student.",
|
| + "description": "Returns a specific guardian.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if no user that matches the provided `student_id`\n is visible to the requesting user, if the requesting user is not\n permitted to view guardian information for the student identified by the\n `student_id`, 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`).\n* `NOT_FOUND` if the requesting user is permitted to view guardians for\n the requested `student_id`, but no `Guardian` record exists for that\n student that matches the provided `guardian_id`.",
|
| "httpMethod": "GET",
|
| - "id": "classroom.userProfiles.guardianInvitations.get",
|
| + "id": "classroom.userProfiles.guardians.get",
|
| "parameterOrder": [
|
| "studentId",
|
| - "invitationId"
|
| + "guardianId"
|
| ],
|
| "parameters": {
|
| - "invitationId": {
|
| - "description": "The `id` field of the `GuardianInvitation` being requested.",
|
| + "studentId": {
|
| + "description": "The student whose guardian is being requested. 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": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "studentId": {
|
| - "description": "The ID of the student whose guardian invitation is being requested.",
|
| + "guardianId": {
|
| + "description": "The `id` field from a `Guardian`.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}",
|
| + "path": "v1/userProfiles/{studentId}/guardians/{guardianId}",
|
| "response": {
|
| - "$ref": "GuardianInvitation"
|
| + "$ref": "Guardian"
|
| },
|
| "scopes": [
|
| + "https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly",
|
| "https://www.googleapis.com/auth/classroom.guardianlinks.students",
|
| "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"
|
| ]
|
| },
|
| "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.",
|
| + "description": "Returns a list of guardians that the requesting user is permitted to\nview, restricted to those that match the request.\n\nTo list guardians for any student that the requesting user may view\nguardians for, use the literal character `-` for the student ID.\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 information 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 if the `invited_email_address` filter is set by a user who is not a\n domain administrator, 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` 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",
|
| + "id": "classroom.userProfiles.guardians.list",
|
| "parameterOrder": [
|
| "studentId"
|
| ],
|
| "parameters": {
|
| "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.",
|
| + "description": "Filter results by the student who the guardian is linked to.\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 has access to view.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| @@ -282,164 +274,172 @@
|
| "location": "query",
|
| "type": "integer"
|
| },
|
| - "states": {
|
| - "description": "If specified, only results with the specified `state` values will be\nreturned. Otherwise, results with a `state` of `PENDING` will be returned.",
|
| - "enum": [
|
| - "GUARDIAN_INVITATION_STATE_UNSPECIFIED",
|
| - "PENDING",
|
| - "COMPLETE"
|
| - ],
|
| - "location": "query",
|
| - "repeated": true,
|
| - "type": "string"
|
| - },
|
| "invitedEmailAddress": {
|
| - "description": "If specified, only results with the specified `invited_email_address`\nwill be returned.",
|
| + "description": "Filter results by the email address that the original invitation was sent\nto, resulting in this guardian link.\nThis filter can only be used by domain administrators.",
|
| "location": "query",
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/userProfiles/{studentId}/guardianInvitations",
|
| + "path": "v1/userProfiles/{studentId}/guardians",
|
| "response": {
|
| - "$ref": "ListGuardianInvitationsResponse"
|
| + "$ref": "ListGuardiansResponse"
|
| },
|
| "scopes": [
|
| + "https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly",
|
| "https://www.googleapis.com/auth/classroom.guardianlinks.students",
|
| "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"
|
| ]
|
| - },
|
| - "create": {
|
| - "description": "Creates a guardian invitation, and sends an email to the guardian asking\nthem to confirm that they are the student's guardian.\n\nOnce the guardian accepts the invitation, their `state` will change to\n`COMPLETED` and they will start receiving guardian notifications. A\n`Guardian` resource will also be created to represent the active guardian.\n\nThe request object must have the `student_id` and\n`invited_email_address` fields set. Failing to set these fields, or\nsetting any other fields in the request, will result in an error.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the current user does not have permission to\n manage guardians, if the guardian in question has already rejected\n too many requests for that student, if guardians are not enabled for the\n domain in question, or for other access errors.\n* `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian\n link limit.\n* `INVALID_ARGUMENT` if the guardian email address is not valid (for\n example, if it is too long), or if the format of the student ID provided\n cannot be recognized (it is not an email address, nor a `user_id` from\n this API). This error will also be returned if read-only fields are set,\n or if the `state` field is set to to a value other than `PENDING`.\n* `NOT_FOUND` if the student ID provided is a valid student ID, but\n Classroom has no record of that student.\n* `ALREADY_EXISTS` if there is already a pending guardian invitation for\n the student and `invited_email_address` provided, or if the provided\n `invited_email_address` matches the Google account of an existing\n `Guardian` for this user.",
|
| - "httpMethod": "POST",
|
| - "id": "classroom.userProfiles.guardianInvitations.create",
|
| - "parameterOrder": [
|
| - "studentId"
|
| - ],
|
| - "parameters": {
|
| - "studentId": {
|
| - "description": "ID of the student (in standard format)",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - }
|
| - },
|
| - "path": "v1/userProfiles/{studentId}/guardianInvitations",
|
| - "request": {
|
| - "$ref": "GuardianInvitation"
|
| - },
|
| - "response": {
|
| - "$ref": "GuardianInvitation"
|
| - },
|
| - "scopes": [
|
| - "https://www.googleapis.com/auth/classroom.guardianlinks.students"
|
| - ]
|
| }
|
| }
|
| },
|
| - "guardians": {
|
| + "guardianInvitations": {
|
| "methods": {
|
| - "delete": {
|
| - "description": "Deletes a guardian.\n\nThe guardian will no longer receive guardian notifications and the guardian\nwill no longer be accessible via the API.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if no user that matches the provided `student_id`\n is visible to the requesting user, if the requesting user is not\n permitted to manage guardians for the student identified by the\n `student_id`, 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).\n* `NOT_FOUND` if the requesting user is permitted to modify guardians for\n the requested `student_id`, but no `Guardian` record exists for that\n student with the provided `guardian_id`.",
|
| - "httpMethod": "DELETE",
|
| - "id": "classroom.userProfiles.guardians.delete",
|
| + "patch": {
|
| + "description": "Modifies a guardian invitation.\n\nCurrently, the only valid modification is to change the `state` from\n`PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the current user does not have permission to\n manage guardians, if guardians are not enabled for the domain in question\n or for other access errors.\n* `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state.\n* `INVALID_ARGUMENT` if the format of the student ID provided\n cannot be recognized (it is not an email address, nor a `user_id` from\n this API), or if the passed `GuardianInvitation` has a `state` other than\n `COMPLETE`, or if it modifies fields other than `state`.\n* `NOT_FOUND` if the student ID provided is a valid student ID, but\n Classroom has no record of that student, or if the `id` field does not\n refer to a guardian invitation known to Classroom.",
|
| + "httpMethod": "PATCH",
|
| + "id": "classroom.userProfiles.guardianInvitations.patch",
|
| "parameterOrder": [
|
| "studentId",
|
| - "guardianId"
|
| + "invitationId"
|
| ],
|
| "parameters": {
|
| "studentId": {
|
| - "description": "The student whose guardian is to be deleted. 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",
|
| + "description": "The ID of the student whose guardian invitation is to be modified.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "guardianId": {
|
| - "description": "The `id` field from a `Guardian`.",
|
| + "updateMask": {
|
| + "description": "Mask that identifies which fields on the course to update.\nThis field is required to do an update. The update will fail if invalid\nfields are specified. The following fields are valid:\n\n* `state`\n\nWhen set in a query parameter, this field should be specified as\n\n`updateMask=<field1>,<field2>,...`",
|
| + "format": "google-fieldmask",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "invitationId": {
|
| + "description": "The `id` field of the `GuardianInvitation` to be modified.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/userProfiles/{studentId}/guardians/{guardianId}",
|
| + "path": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}",
|
| + "request": {
|
| + "$ref": "GuardianInvitation"
|
| + },
|
| "response": {
|
| - "$ref": "Empty"
|
| + "$ref": "GuardianInvitation"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/classroom.guardianlinks.students"
|
| ]
|
| },
|
| "get": {
|
| - "description": "Returns a specific guardian.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if no user that matches the provided `student_id`\n is visible to the requesting user, if the requesting user is not\n permitted to view guardian information for the student identified by the\n `student_id`, 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`).\n* `NOT_FOUND` if the requesting user is permitted to view guardians for\n the requested `student_id`, but no `Guardian` record exists for that\n student that matches the provided `guardian_id`.",
|
| + "description": "Returns a specific guardian invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view\n guardian invitations for the student identified by the `student_id`, if\n guardians are not enabled for the domain in question, or for other\n 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`).\n* `NOT_FOUND` if Classroom cannot find any record of the given student or\n `invitation_id`. May also be returned if the student exists, but the\n requesting user does not have access to see that student.",
|
| "httpMethod": "GET",
|
| - "id": "classroom.userProfiles.guardians.get",
|
| + "id": "classroom.userProfiles.guardianInvitations.get",
|
| "parameterOrder": [
|
| "studentId",
|
| - "guardianId"
|
| + "invitationId"
|
| ],
|
| "parameters": {
|
| - "studentId": {
|
| - "description": "The student whose guardian is being requested. 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",
|
| + "invitationId": {
|
| + "description": "The `id` field of the `GuardianInvitation` being requested.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "guardianId": {
|
| - "description": "The `id` field from a `Guardian`.",
|
| + "studentId": {
|
| + "description": "The ID of the student whose guardian invitation is being requested.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/userProfiles/{studentId}/guardians/{guardianId}",
|
| + "path": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}",
|
| "response": {
|
| - "$ref": "Guardian"
|
| + "$ref": "GuardianInvitation"
|
| },
|
| "scopes": [
|
| - "https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly",
|
| "https://www.googleapis.com/auth/classroom.guardianlinks.students",
|
| "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"
|
| ]
|
| },
|
| "list": {
|
| - "description": "Returns a list of guardians that the requesting user is permitted to\nview, restricted to those that match the request.\n\nTo list guardians for any student that the requesting user may view\nguardians for, use the literal character `-` for the student ID.\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 information 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 if the `invited_email_address` filter is set by a user who is not a\n domain administrator, 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` 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.",
|
| + "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.guardians.list",
|
| + "id": "classroom.userProfiles.guardianInvitations.list",
|
| "parameterOrder": [
|
| "studentId"
|
| ],
|
| "parameters": {
|
| - "studentId": {
|
| - "description": "Filter results by the student who the guardian is linked to.\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 has access to view.",
|
| - "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"
|
| - },
|
| "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": "If specified, only results with the specified `state` values will be\nreturned. Otherwise, results with a `state` of `PENDING` will be returned.",
|
| + "enum": [
|
| + "GUARDIAN_INVITATION_STATE_UNSPECIFIED",
|
| + "PENDING",
|
| + "COMPLETE"
|
| + ],
|
| + "location": "query",
|
| + "repeated": true,
|
| + "type": "string"
|
| + },
|
| "invitedEmailAddress": {
|
| - "description": "Filter results by the email address that the original invitation was sent\nto, resulting in this guardian link.\nThis filter can only be used by domain administrators.",
|
| + "description": "If specified, only results with the specified `invited_email_address`\nwill be returned.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "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}/guardians",
|
| + "path": "v1/userProfiles/{studentId}/guardianInvitations",
|
| "response": {
|
| - "$ref": "ListGuardiansResponse"
|
| + "$ref": "ListGuardianInvitationsResponse"
|
| },
|
| "scopes": [
|
| - "https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly",
|
| "https://www.googleapis.com/auth/classroom.guardianlinks.students",
|
| "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"
|
| ]
|
| + },
|
| + "create": {
|
| + "description": "Creates a guardian invitation, and sends an email to the guardian asking\nthem to confirm that they are the student's guardian.\n\nOnce the guardian accepts the invitation, their `state` will change to\n`COMPLETED` and they will start receiving guardian notifications. A\n`Guardian` resource will also be created to represent the active guardian.\n\nThe request object must have the `student_id` and\n`invited_email_address` fields set. Failing to set these fields, or\nsetting any other fields in the request, will result in an error.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the current user does not have permission to\n manage guardians, if the guardian in question has already rejected\n too many requests for that student, if guardians are not enabled for the\n domain in question, or for other access errors.\n* `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian\n link limit.\n* `INVALID_ARGUMENT` if the guardian email address is not valid (for\n example, if it is too long), or if the format of the student ID provided\n cannot be recognized (it is not an email address, nor a `user_id` from\n this API). This error will also be returned if read-only fields are set,\n or if the `state` field is set to to a value other than `PENDING`.\n* `NOT_FOUND` if the student ID provided is a valid student ID, but\n Classroom has no record of that student.\n* `ALREADY_EXISTS` if there is already a pending guardian invitation for\n the student and `invited_email_address` provided, or if the provided\n `invited_email_address` matches the Google account of an existing\n `Guardian` for this user.",
|
| + "httpMethod": "POST",
|
| + "id": "classroom.userProfiles.guardianInvitations.create",
|
| + "parameterOrder": [
|
| + "studentId"
|
| + ],
|
| + "parameters": {
|
| + "studentId": {
|
| + "description": "ID of the student (in standard format)",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "v1/userProfiles/{studentId}/guardianInvitations",
|
| + "request": {
|
| + "$ref": "GuardianInvitation"
|
| + },
|
| + "response": {
|
| + "$ref": "GuardianInvitation"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/classroom.guardianlinks.students"
|
| + ]
|
| }
|
| }
|
| }
|
| @@ -447,88 +447,6 @@
|
| },
|
| "courses": {
|
| "methods": {
|
| - "patch": {
|
| - "description": "Updates one or more fields in a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to modify the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.\n* `INVALID_ARGUMENT` if invalid fields are specified in the update mask or\nif no update mask is supplied.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseNotModifiable",
|
| - "httpMethod": "PATCH",
|
| - "id": "classroom.courses.patch",
|
| - "parameterOrder": [
|
| - "id"
|
| - ],
|
| - "parameters": {
|
| - "id": {
|
| - "description": "Identifier of the course to update.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - },
|
| - "updateMask": {
|
| - "description": "Mask that identifies which fields on the course to update.\nThis field is required to do an update. The update will fail if invalid\nfields are specified. The following fields are valid:\n\n* `name`\n* `section`\n* `descriptionHeading`\n* `description`\n* `room`\n* `courseState`\n\nWhen set in a query parameter, this field should be specified as\n\n`updateMask=<field1>,<field2>,...`",
|
| - "format": "google-fieldmask",
|
| - "location": "query",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "path": "v1/courses/{id}",
|
| - "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",
|
| - "id": "classroom.courses.get",
|
| - "parameterOrder": [
|
| - "id"
|
| - ],
|
| - "parameters": {
|
| - "id": {
|
| - "description": "Identifier of the course to return.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - }
|
| - },
|
| - "path": "v1/courses/{id}",
|
| - "response": {
|
| - "$ref": "Course"
|
| - },
|
| - "scopes": [
|
| - "https://www.googleapis.com/auth/classroom.courses",
|
| - "https://www.googleapis.com/auth/classroom.courses.readonly"
|
| - ]
|
| - },
|
| - "update": {
|
| - "description": "Updates a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to modify the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseNotModifiable",
|
| - "httpMethod": "PUT",
|
| - "id": "classroom.courses.update",
|
| - "parameterOrder": [
|
| - "id"
|
| - ],
|
| - "parameters": {
|
| - "id": {
|
| - "description": "Identifier of the course to update.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - }
|
| - },
|
| - "path": "v1/courses/{id}",
|
| - "request": {
|
| - "$ref": "Course"
|
| - },
|
| - "response": {
|
| - "$ref": "Course"
|
| - },
|
| - "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",
|
| @@ -553,17 +471,11 @@
|
| ]
|
| },
|
| "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.",
|
| + "description": "Returns a list of courses that the requesting user is permitted to view,\nrestricted to those that match the request. Returned courses are ordered by\ncreation time, with the most recently created coming first.\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": {
|
| - "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"
|
| - },
|
| "courseStates": {
|
| "description": "Restricts returned courses to those in one of the specified states\nThe default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED.",
|
| "enum": [
|
| @@ -592,6 +504,12 @@
|
| "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"
|
| }
|
| },
|
| "path": "v1/courses",
|
| @@ -619,6 +537,88 @@
|
| "scopes": [
|
| "https://www.googleapis.com/auth/classroom.courses"
|
| ]
|
| + },
|
| + "patch": {
|
| + "description": "Updates one or more fields in a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to modify the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.\n* `INVALID_ARGUMENT` if invalid fields are specified in the update mask or\nif no update mask is supplied.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseNotModifiable",
|
| + "httpMethod": "PATCH",
|
| + "id": "classroom.courses.patch",
|
| + "parameterOrder": [
|
| + "id"
|
| + ],
|
| + "parameters": {
|
| + "id": {
|
| + "description": "Identifier of the course to update.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "updateMask": {
|
| + "description": "Mask that identifies which fields on the course to update.\nThis field is required to do an update. The update will fail if invalid\nfields are specified. The following fields are valid:\n\n* `name`\n* `section`\n* `descriptionHeading`\n* `description`\n* `room`\n* `courseState`\n* `ownerId`\n\nNote: patches to ownerId are treated as being effective immediately, but in\npractice it may take some time for the ownership transfer of all affected\nresources to complete.\n\nWhen set in a query parameter, this field should be specified as\n\n`updateMask=<field1>,<field2>,...`",
|
| + "format": "google-fieldmask",
|
| + "location": "query",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "v1/courses/{id}",
|
| + "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",
|
| + "id": "classroom.courses.get",
|
| + "parameterOrder": [
|
| + "id"
|
| + ],
|
| + "parameters": {
|
| + "id": {
|
| + "description": "Identifier of the course to return.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "v1/courses/{id}",
|
| + "response": {
|
| + "$ref": "Course"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/classroom.courses",
|
| + "https://www.googleapis.com/auth/classroom.courses.readonly"
|
| + ]
|
| + },
|
| + "update": {
|
| + "description": "Updates a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to modify the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseNotModifiable",
|
| + "httpMethod": "PUT",
|
| + "id": "classroom.courses.update",
|
| + "parameterOrder": [
|
| + "id"
|
| + ],
|
| + "parameters": {
|
| + "id": {
|
| + "description": "Identifier of the course to update.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "v1/courses/{id}",
|
| + "request": {
|
| + "$ref": "Course"
|
| + },
|
| + "response": {
|
| + "$ref": "Course"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/classroom.courses"
|
| + ]
|
| }
|
| },
|
| "resources": {
|
| @@ -633,14 +633,14 @@
|
| "alias"
|
| ],
|
| "parameters": {
|
| - "courseId": {
|
| - "description": "Identifier of the course whose alias should be deleted.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| + "alias": {
|
| + "description": "Alias to delete.\nThis may not be the Classroom-assigned identifier.",
|
| "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 whose alias should be deleted.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| @@ -728,14 +728,14 @@
|
| "userId"
|
| ],
|
| "parameters": {
|
| - "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"
|
| },
|
| - "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"
|
| @@ -757,6 +757,11 @@
|
| "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",
|
| @@ -768,11 +773,6 @@
|
| "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.",
|
| - "location": "query",
|
| - "type": "string"
|
| }
|
| },
|
| "path": "v1/courses/{courseId}/students",
|
| @@ -865,14 +865,14 @@
|
| "id"
|
| ],
|
| "parameters": {
|
| - "courseId": {
|
| - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| + "id": {
|
| + "description": "Identifier of the course work to delete.\nThis identifier is a Classroom-assigned identifier.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "id": {
|
| - "description": "Identifier of the course work to delete.\nThis identifier is a 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"
|
| @@ -894,6 +894,16 @@
|
| "courseId"
|
| ],
|
| "parameters": {
|
| + "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"
|
| + },
|
| + "orderBy": {
|
| + "description": "Optional sort ordering for results. A comma-separated list of fields with\nan optional sort direction keyword. Supported fields are `updateTime`\nand `dueDate`. Supported direction keywords are `asc` and `desc`.\nIf not specified, `updateTime desc` is the default behavior.\nExamples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc`",
|
| + "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",
|
| @@ -917,16 +927,6 @@
|
| "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"
|
| - },
|
| - "orderBy": {
|
| - "description": "Optional sort ordering for results. A comma-separated list of fields with\nan optional sort direction keyword. Supported fields are `updateTime`\nand `dueDate`. Supported direction keywords are `asc` and `desc`.\nIf not specified, `updateTime desc` is the default behavior.\nExamples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc`",
|
| - "location": "query",
|
| - "type": "string"
|
| }
|
| },
|
| "path": "v1/courses/{courseId}/courseWork",
|
| @@ -949,14 +949,14 @@
|
| "id"
|
| ],
|
| "parameters": {
|
| - "courseId": {
|
| - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| + "id": {
|
| + "description": "Identifier of the course work.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "id": {
|
| - "description": "Identifier of the course work.",
|
| + "courseId": {
|
| + "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| @@ -982,12 +982,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* `scheduled_time`\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",
|
| @@ -999,6 +993,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* `scheduled_time`\n* `submission_modification_mode`",
|
| + "format": "google-fieldmask",
|
| + "location": "query",
|
| + "type": "string"
|
| }
|
| },
|
| "path": "v1/courses/{courseId}/courseWork/{id}",
|
| @@ -1052,20 +1052,20 @@
|
| "id"
|
| ],
|
| "parameters": {
|
| - "courseWorkId": {
|
| - "description": "Identifier of the course work.",
|
| + "id": {
|
| + "description": "Identifier of the student submission.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "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"
|
| @@ -1094,12 +1094,6 @@
|
| "id"
|
| ],
|
| "parameters": {
|
| - "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"
|
| - },
|
| "courseWorkId": {
|
| "description": "Identifier of the course work.",
|
| "location": "path",
|
| @@ -1117,6 +1111,12 @@
|
| "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}",
|
| @@ -1181,20 +1181,20 @@
|
| "id"
|
| ],
|
| "parameters": {
|
| - "courseWorkId": {
|
| - "description": "Identifier of the course work.",
|
| + "id": {
|
| + "description": "Identifier of the student submission.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "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"
|
| @@ -1251,47 +1251,6 @@
|
| "https://www.googleapis.com/auth/classroom.coursework.me"
|
| ]
|
| },
|
| - "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",
|
| - "id"
|
| - ],
|
| - "parameters": {
|
| - "courseWorkId": {
|
| - "description": "Identifier of the course work.",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - },
|
| - "courseId": {
|
| - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - },
|
| - "id": {
|
| - "description": "Identifier of the student submission.",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - }
|
| - },
|
| - "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments",
|
| - "request": {
|
| - "$ref": "ModifyAttachmentsRequest"
|
| - },
|
| - "response": {
|
| - "$ref": "StudentSubmission"
|
| - },
|
| - "scopes": [
|
| - "https://www.googleapis.com/auth/classroom.coursework.me",
|
| - "https://www.googleapis.com/auth/classroom.coursework.students"
|
| - ]
|
| - },
|
| "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",
|
| @@ -1342,7 +1301,7 @@
|
| "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 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"
|
| @@ -1366,6 +1325,47 @@
|
| "https://www.googleapis.com/auth/classroom.student-submissions.me.readonly",
|
| "https://www.googleapis.com/auth/classroom.student-submissions.students.readonly"
|
| ]
|
| + },
|
| + "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",
|
| + "id"
|
| + ],
|
| + "parameters": {
|
| + "courseWorkId": {
|
| + "description": "Identifier of the course work.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "courseId": {
|
| + "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "id": {
|
| + "description": "Identifier of the student submission.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments",
|
| + "request": {
|
| + "$ref": "ModifyAttachmentsRequest"
|
| + },
|
| + "response": {
|
| + "$ref": "StudentSubmission"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/classroom.coursework.me",
|
| + "https://www.googleapis.com/auth/classroom.coursework.students"
|
| + ]
|
| }
|
| }
|
| }
|
| @@ -1373,36 +1373,6 @@
|
| },
|
| "teachers": {
|
| "methods": {
|
| - "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"
|
| - ]
|
| - },
|
| "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",
|
| @@ -1449,14 +1419,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 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"
|
| },
|
| - "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",
|
| + "courseId": {
|
| + "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| @@ -1500,6 +1470,36 @@
|
| "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": {
|
| + "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"
|
| + },
|
| + "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/{userId}",
|
| + "response": {
|
| + "$ref": "Empty"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/classroom.rosters"
|
| + ]
|
| }
|
| }
|
| }
|
| @@ -1507,6 +1507,29 @@
|
| },
|
| "invitations": {
|
| "methods": {
|
| + "delete": {
|
| + "description": "Deletes an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete the\nrequested invitation or for access errors.\n* `NOT_FOUND` if no invitation exists with the requested ID.",
|
| + "httpMethod": "DELETE",
|
| + "id": "classroom.invitations.delete",
|
| + "parameterOrder": [
|
| + "id"
|
| + ],
|
| + "parameters": {
|
| + "id": {
|
| + "description": "Identifier of the invitation to delete.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "v1/invitations/{id}",
|
| + "response": {
|
| + "$ref": "Empty"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/classroom.rosters"
|
| + ]
|
| + },
|
| "list": {
|
| "description": "Returns a list of invitations that the requesting user is permitted to\nview, restricted to those that match the list request.\n\n*Note:* At least one of `user_id` or `course_id` must be supplied. Both\nfields can be supplied.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` for access errors.",
|
| "httpMethod": "GET",
|
| @@ -1607,229 +1630,61 @@
|
| "scopes": [
|
| "https://www.googleapis.com/auth/classroom.rosters"
|
| ]
|
| - },
|
| - "delete": {
|
| - "description": "Deletes an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete the\nrequested invitation or for access errors.\n* `NOT_FOUND` if no invitation exists with the requested ID.",
|
| - "httpMethod": "DELETE",
|
| - "id": "classroom.invitations.delete",
|
| - "parameterOrder": [
|
| - "id"
|
| - ],
|
| - "parameters": {
|
| - "id": {
|
| - "description": "Identifier of the invitation to delete.",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - }
|
| - },
|
| - "path": "v1/invitations/{id}",
|
| - "response": {
|
| - "$ref": "Empty"
|
| - },
|
| - "scopes": [
|
| - "https://www.googleapis.com/auth/classroom.rosters"
|
| - ]
|
| }
|
| }
|
| }
|
| },
|
| - "revision": "20170727",
|
| + "revision": "20170818",
|
| "rootUrl": "https://classroom.googleapis.com/",
|
| "schemas": {
|
| - "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",
|
| + "ReclaimStudentSubmissionRequest": {
|
| + "description": "Request to reclaim a student submission.",
|
| + "id": "ReclaimStudentSubmissionRequest",
|
| "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",
|
| + "GradeHistory": {
|
| + "description": "The history of each grade on this submission.",
|
| + "id": "GradeHistory",
|
| "properties": {
|
| - "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."
|
| - },
|
| - "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"
|
| - },
|
| - "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"
|
| - },
|
| - "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"
|
| - },
|
| - "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"
|
| - },
|
| - "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"
|
| - },
|
| - "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"
|
| - },
|
| - "courseMaterialSets": {
|
| - "description": "Sets of materials that appear on the \"about\" page of this course.\n\nRead-only.",
|
| - "items": {
|
| - "$ref": "CourseMaterialSet"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "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"
|
| - },
|
| - "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"
|
| - },
|
| - "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"
|
| - },
|
| - "alternateLink": {
|
| - "description": "Absolute link to this course in the Classroom web UI.\n\nRead-only.",
|
| + "actorUserId": {
|
| + "description": "The teacher who made the grade change.",
|
| "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`.",
|
| + "gradeChangeType": {
|
| + "description": "The type of grade change at this time in the submission grade history.",
|
| "enum": [
|
| - "COURSE_STATE_UNSPECIFIED",
|
| - "ACTIVE",
|
| - "ARCHIVED",
|
| - "PROVISIONED",
|
| - "DECLINED",
|
| - "SUSPENDED"
|
| + "UNKNOWN_GRADE_CHANGE_TYPE",
|
| + "DRAFT_GRADE_POINTS_EARNED_CHANGE",
|
| + "ASSIGNED_GRADE_POINTS_EARNED_CHANGE",
|
| + "MAX_POINTS_CHANGE"
|
| ],
|
| "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."
|
| + "No grade change type specified. This should never be returned.",
|
| + "A change in the numerator of the draft grade.",
|
| + "A change in the numerator of the assigned grade.",
|
| + "A change in the denominator of the grade."
|
| ],
|
| "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.",
|
| - "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.",
|
| - "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.",
|
| - "type": "string"
|
| - },
|
| - "creationTime": {
|
| - "description": "Creation time of the course.\nSpecifying this field in a course update mask results in an error.\n\nRead-only.",
|
| + "gradeTimestamp": {
|
| + "description": "When the grade of the submission was changed.",
|
| "format": "google-datetime",
|
| "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "DriveFile": {
|
| - "description": "Representation of a Google Drive file.",
|
| - "id": "DriveFile",
|
| - "properties": {
|
| - "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"
|
| - },
|
| - "thumbnailUrl": {
|
| - "description": "URL of a thumbnail image of the Drive item.\n\nRead-only.",
|
| - "type": "string"
|
| - },
|
| - "id": {
|
| - "description": "Drive API resource ID.",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "GlobalPermission": {
|
| - "description": "Global user permission description.",
|
| - "id": "GlobalPermission",
|
| - "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."
|
| - ],
|
| - "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "ReturnStudentSubmissionRequest": {
|
| - "description": "Request to return a student submission.",
|
| - "id": "ReturnStudentSubmissionRequest",
|
| - "properties": {},
|
| - "type": "object"
|
| - },
|
| - "Teacher": {
|
| - "description": "Teacher of a course.",
|
| - "id": "Teacher",
|
| - "properties": {
|
| - "courseId": {
|
| - "description": "Identifier of the course.\n\nRead-only.",
|
| - "type": "string"
|
| },
|
| - "profile": {
|
| - "$ref": "UserProfile",
|
| - "description": "Global user information for the teacher.\n\nRead-only."
|
| + "maxPoints": {
|
| + "description": "The denominator of the grade at this time in the submission grade\nhistory.",
|
| + "format": "double",
|
| + "type": "number"
|
| },
|
| - "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"
|
| + "pointsEarned": {
|
| + "description": "The numerator of the grade at this time in the submission grade history.",
|
| + "format": "double",
|
| + "type": "number"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ReclaimStudentSubmissionRequest": {
|
| - "description": "Request to reclaim a student submission.",
|
| - "id": "ReclaimStudentSubmissionRequest",
|
| - "properties": {},
|
| - "type": "object"
|
| - },
|
| "AssignmentSubmission": {
|
| "description": "Student work for an assignment.",
|
| "id": "AssignmentSubmission",
|
| @@ -1848,6 +1703,10 @@
|
| "description": "Material attached to course work.\n\nWhen creating attachments, setting the `form` field is not supported.",
|
| "id": "Material",
|
| "properties": {
|
| + "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."
|
| + },
|
| "youtubeVideo": {
|
| "$ref": "YouTubeVideo",
|
| "description": "YouTube video material."
|
| @@ -1859,10 +1718,6 @@
|
| "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"
|
| @@ -1871,10 +1726,6 @@
|
| "description": "Course work created by a teacher for students of the course.",
|
| "id": "CourseWork",
|
| "properties": {
|
| - "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"
|
| - },
|
| "materials": {
|
| "description": "Additional materials.\n\nCourseWork must have no more than 20 material items.",
|
| "items": {
|
| @@ -1882,6 +1733,10 @@
|
| },
|
| "type": "array"
|
| },
|
| + "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",
|
| @@ -1938,20 +1793,6 @@
|
| "$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."
|
| },
|
| - "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"
|
| - },
|
| "state": {
|
| "description": "Status of this course work.\nIf unspecified, the default state is `DRAFT`.",
|
| "enum": [
|
| @@ -1968,6 +1809,20 @@
|
| ],
|
| "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."
|
| + ],
|
| + "type": "string"
|
| + },
|
| "courseId": {
|
| "description": "Identifier of the course.\n\nRead-only.",
|
| "type": "string"
|
| @@ -1991,6 +1846,10 @@
|
| "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": {
|
| + "guardianProfile": {
|
| + "$ref": "UserProfile",
|
| + "description": "User profile for the guardian."
|
| + },
|
| "studentId": {
|
| "description": "Identifier for the student to whom the guardian relationship applies.",
|
| "type": "string"
|
| @@ -2002,10 +1861,6 @@
|
| "guardianId": {
|
| "description": "Identifier for the guardian.",
|
| "type": "string"
|
| - },
|
| - "guardianProfile": {
|
| - "$ref": "UserProfile",
|
| - "description": "User profile for the guardian."
|
| }
|
| },
|
| "type": "object"
|
| @@ -2014,6 +1869,14 @@
|
| "description": "Global information for a user.",
|
| "id": "UserProfile",
|
| "properties": {
|
| + "id": {
|
| + "description": "Identifier of the user.\n\nRead-only.",
|
| + "type": "string"
|
| + },
|
| + "verifiedTeacher": {
|
| + "description": "Represents whether a G Suite for Education user's domain administrator has\nexplicitly verified them as being a teacher. If the user is not a member of\na G Suite for Education domain, than this field will always be false.\n\nRead-only",
|
| + "type": "boolean"
|
| + },
|
| "emailAddress": {
|
| "description": "Email address of the user.\n\nRead-only.",
|
| "type": "string"
|
| @@ -2032,14 +1895,6 @@
|
| "name": {
|
| "$ref": "Name",
|
| "description": "Name of the user.\n\nRead-only."
|
| - },
|
| - "id": {
|
| - "description": "Identifier of the user.\n\nRead-only.",
|
| - "type": "string"
|
| - },
|
| - "verifiedTeacher": {
|
| - "description": "Represents whether a G Suite for Education user's domain administrator has\nexplicitly verified them as being a teacher. If the user is not a member of\na G Suite for Education domain, than this field will always be false.\n\nRead-only",
|
| - "type": "boolean"
|
| }
|
| },
|
| "type": "object"
|
| @@ -2102,12 +1957,14 @@
|
| "enum": [
|
| "COURSE_ROLE_UNSPECIFIED",
|
| "STUDENT",
|
| - "TEACHER"
|
| + "TEACHER",
|
| + "OWNER"
|
| ],
|
| "enumDescriptions": [
|
| "No course role.",
|
| "Student in the course.",
|
| - "Teacher of the course."
|
| + "Teacher of the course.",
|
| + "Owner of the course."
|
| ],
|
| "type": "string"
|
| },
|
| @@ -2137,6 +1994,21 @@
|
| },
|
| "type": "object"
|
| },
|
| + "SubmissionHistory": {
|
| + "description": "The history of the submission. This currently includes state and grade\nhistories.",
|
| + "id": "SubmissionHistory",
|
| + "properties": {
|
| + "stateHistory": {
|
| + "$ref": "StateHistory",
|
| + "description": "The state history information of the submission, if present."
|
| + },
|
| + "gradeHistory": {
|
| + "$ref": "GradeHistory",
|
| + "description": "The grade history information of the submission, if present."
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| "ShortAnswerSubmission": {
|
| "description": "Student work for a short answer question.",
|
| "id": "ShortAnswerSubmission",
|
| @@ -2152,10 +2024,57 @@
|
| "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": {
|
| - "state": {
|
| - "description": "State of this submission.\n\nRead-only.",
|
| - "enum": [
|
| - "SUBMISSION_STATE_UNSPECIFIED",
|
| + "shortAnswerSubmission": {
|
| + "$ref": "ShortAnswerSubmission",
|
| + "description": "Submission content when course_work_type is SHORT_ANSWER_QUESTION."
|
| + },
|
| + "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"
|
| + },
|
| + "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"
|
| + },
|
| + "alternateLink": {
|
| + "description": "Absolute link to the submission in the Classroom web UI.\n\nRead-only.",
|
| + "type": "string"
|
| + },
|
| + "draftGrade": {
|
| + "description": "Optional pending grade. If unset, no grade was set.\nThis value must be non-negative. Decimal (i.e. non-integer) values are\nallowed, but will be rounded to two decimal places.\n\nThis is only visible to and modifiable by course teachers.",
|
| + "format": "double",
|
| + "type": "number"
|
| + },
|
| + "late": {
|
| + "description": "Whether this submission is late.\n\nRead-only.",
|
| + "type": "boolean"
|
| + },
|
| + "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"
|
| + },
|
| + "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"
|
| + },
|
| + "state": {
|
| + "description": "State of this submission.\n\nRead-only.",
|
| + "enum": [
|
| + "SUBMISSION_STATE_UNSPECIFIED",
|
| "NEW",
|
| "CREATED",
|
| "TURNED_IN",
|
| @@ -2188,8 +2107,15 @@
|
| "description": "Classroom-assigned Identifier for the student submission.\nThis is unique among submissions for the relevant course work.\n\nRead-only.",
|
| "type": "string"
|
| },
|
| + "submissionHistory": {
|
| + "description": "The history of the submission (includes state and grade histories).\n\nRead-only.",
|
| + "items": {
|
| + "$ref": "SubmissionHistory"
|
| + },
|
| + "type": "array"
|
| + },
|
| "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.",
|
| + "description": "Optional grade. If unset, no grade was set.\nThis value must be non-negative. Decimal (i.e. non-integer) values are\nallowed, but will be rounded to two decimal places.\n\nThis may be modified only by course teachers.",
|
| "format": "double",
|
| "type": "number"
|
| },
|
| @@ -2200,53 +2126,6 @@
|
| "assignmentSubmission": {
|
| "$ref": "AssignmentSubmission",
|
| "description": "Submission content when course_work_type is ASSIGNMENT ."
|
| - },
|
| - "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"
|
| - },
|
| - "shortAnswerSubmission": {
|
| - "$ref": "ShortAnswerSubmission",
|
| - "description": "Submission content when course_work_type is SHORT_ANSWER_QUESTION."
|
| - },
|
| - "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"
|
| - },
|
| - "alternateLink": {
|
| - "description": "Absolute link to the submission in the Classroom web UI.\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"
|
| - },
|
| - "late": {
|
| - "description": "Whether this submission is late.\n\nRead-only.",
|
| - "type": "boolean"
|
| - },
|
| - "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"
|
| - },
|
| - "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"
|
| }
|
| },
|
| "type": "object"
|
| @@ -2311,6 +2190,10 @@
|
| "description": "YouTube video item.",
|
| "id": "YouTubeVideo",
|
| "properties": {
|
| + "id": {
|
| + "description": "YouTube API resource ID.",
|
| + "type": "string"
|
| + },
|
| "title": {
|
| "description": "Title of the YouTube video.\n\nRead-only.",
|
| "type": "string"
|
| @@ -2322,10 +2205,6 @@
|
| "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"
|
| @@ -2348,14 +2227,33 @@
|
| },
|
| "type": "object"
|
| },
|
| + "Attachment": {
|
| + "description": "Attachment added to student assignment work.\n\nWhen creating attachments, setting the `form` field is not supported.",
|
| + "id": "Attachment",
|
| + "properties": {
|
| + "youTubeVideo": {
|
| + "$ref": "YouTubeVideo",
|
| + "description": "Youtube video attachment."
|
| + },
|
| + "driveFile": {
|
| + "$ref": "DriveFile",
|
| + "description": "Google Drive file attachment."
|
| + },
|
| + "form": {
|
| + "$ref": "Form",
|
| + "description": "Google Forms attachment."
|
| + },
|
| + "link": {
|
| + "$ref": "Link",
|
| + "description": "Link attachment."
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| "GuardianInvitation": {
|
| "description": "An invitation to become the guardian of a specified user, sent to a specified\nemail address.",
|
| "id": "GuardianInvitation",
|
| "properties": {
|
| - "invitedEmailAddress": {
|
| - "description": "Email address that the invitation was sent to.\nThis field is only visible to domain administrators.",
|
| - "type": "string"
|
| - },
|
| "creationTime": {
|
| "description": "The time that this invitation was created.\n\nRead-only.",
|
| "format": "google-datetime",
|
| @@ -2382,29 +2280,46 @@
|
| "studentId": {
|
| "description": "ID of the student (in standard format)",
|
| "type": "string"
|
| + },
|
| + "invitedEmailAddress": {
|
| + "description": "Email address that the invitation was sent to.\nThis field is only visible to domain administrators.",
|
| + "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",
|
| + "StateHistory": {
|
| + "description": "The history of each state this submission has been in.",
|
| + "id": "StateHistory",
|
| "properties": {
|
| - "youTubeVideo": {
|
| - "$ref": "YouTubeVideo",
|
| - "description": "Youtube video attachment."
|
| - },
|
| - "driveFile": {
|
| - "$ref": "DriveFile",
|
| - "description": "Google Drive file attachment."
|
| + "state": {
|
| + "description": "The workflow pipeline stage.",
|
| + "enum": [
|
| + "STATE_UNSPECIFIED",
|
| + "CREATED",
|
| + "TURNED_IN",
|
| + "RETURNED",
|
| + "RECLAIMED_BY_STUDENT",
|
| + "STUDENT_EDITED_AFTER_TURN_IN"
|
| + ],
|
| + "enumDescriptions": [
|
| + "No state specified. This should never be returned.",
|
| + "The Submission has been created.",
|
| + "The student has turned in an assigned document, which may or may not be\na template.",
|
| + "The teacher has returned the assigned document to the student.",
|
| + "The student turned in the assigned document, and then chose to\n\"unsubmit\" the assignment, giving the student control again as the\nowner.",
|
| + "The student edited their submission after turning it in. Currently,\nonly used by Questions, when the student edits their answer."
|
| + ],
|
| + "type": "string"
|
| },
|
| - "form": {
|
| - "$ref": "Form",
|
| - "description": "Google Forms attachment."
|
| + "stateTimestamp": {
|
| + "description": "When the submission entered this state.",
|
| + "format": "google-datetime",
|
| + "type": "string"
|
| },
|
| - "link": {
|
| - "$ref": "Link",
|
| - "description": "Link attachment."
|
| + "actorUserId": {
|
| + "description": "The teacher or student who made the change",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -2431,23 +2346,23 @@
|
| "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.",
|
| + "minutes": {
|
| + "description": "Minutes of hour of day. Must be from 0 to 59.",
|
| "format": "int32",
|
| "type": "integer"
|
| },
|
| - "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.",
|
| + "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"
|
| },
|
| - "minutes": {
|
| - "description": "Minutes of hour of day. Must be from 0 to 59.",
|
| + "nanos": {
|
| + "description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.",
|
| "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.",
|
| + "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"
|
| }
|
| @@ -2458,16 +2373,16 @@
|
| "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"
|
| + },
|
| "courses": {
|
| "description": "Courses that match the list request.",
|
| "items": {
|
| "$ref": "Course"
|
| },
|
| "type": "array"
|
| - },
|
| - "nextPageToken": {
|
| - "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
|
| - "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -2517,6 +2432,10 @@
|
| "description": "URL item.",
|
| "id": "Link",
|
| "properties": {
|
| + "url": {
|
| + "description": "URL to link to.\nThis must be a valid UTF-8 string containing between 1 and 2024 characters.",
|
| + "type": "string"
|
| + },
|
| "title": {
|
| "description": "Title of the target of the URL.\n\nRead-only.",
|
| "type": "string"
|
| @@ -2524,10 +2443,6 @@
|
| "thumbnailUrl": {
|
| "description": "URL of a thumbnail image of the target URL.\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.",
|
| - "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -2536,28 +2451,28 @@
|
| "description": "Response when listing guardians.",
|
| "id": "ListGuardiansResponse",
|
| "properties": {
|
| + "nextPageToken": {
|
| + "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
|
| + "type": "string"
|
| + },
|
| "guardians": {
|
| "description": "Guardians on this page of results that met the criteria specified in\nthe request.",
|
| "items": {
|
| "$ref": "Guardian"
|
| },
|
| "type": "array"
|
| - },
|
| - "nextPageToken": {
|
| - "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
|
| - "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ListCourseAliasesResponse": {
|
| - "description": "Response when listing course aliases.",
|
| - "id": "ListCourseAliasesResponse",
|
| + "ListGuardianInvitationsResponse": {
|
| + "description": "Response when listing guardian invitations.",
|
| + "id": "ListGuardianInvitationsResponse",
|
| "properties": {
|
| - "aliases": {
|
| - "description": "The course aliases.",
|
| + "guardianInvitations": {
|
| + "description": "Guardian invitations that matched the list request.",
|
| "items": {
|
| - "$ref": "CourseAlias"
|
| + "$ref": "GuardianInvitation"
|
| },
|
| "type": "array"
|
| },
|
| @@ -2568,14 +2483,14 @@
|
| },
|
| "type": "object"
|
| },
|
| - "ListGuardianInvitationsResponse": {
|
| - "description": "Response when listing guardian invitations.",
|
| - "id": "ListGuardianInvitationsResponse",
|
| + "ListCourseAliasesResponse": {
|
| + "description": "Response when listing course aliases.",
|
| + "id": "ListCourseAliasesResponse",
|
| "properties": {
|
| - "guardianInvitations": {
|
| - "description": "Guardian invitations that matched the list request.",
|
| + "aliases": {
|
| + "description": "The course aliases.",
|
| "items": {
|
| - "$ref": "GuardianInvitation"
|
| + "$ref": "CourseAlias"
|
| },
|
| "type": "array"
|
| },
|
| @@ -2634,6 +2549,10 @@
|
| "description": "Details of the user's name.",
|
| "id": "Name",
|
| "properties": {
|
| + "fullName": {
|
| + "description": "The user's full name formed by concatenating the first and last name\nvalues.\n\nRead-only.",
|
| + "type": "string"
|
| + },
|
| "familyName": {
|
| "description": "The user's last name.\n\nRead-only.",
|
| "type": "string"
|
| @@ -2641,10 +2560,6 @@
|
| "givenName": {
|
| "description": "The user's first 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"
|
| @@ -2709,6 +2624,193 @@
|
| }
|
| },
|
| "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": {
|
| + "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"
|
| + },
|
| + "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"
|
| + },
|
| + "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"
|
| + },
|
| + "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"
|
| + },
|
| + "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. Admins can also specify this field\nin a patch course request to\ntransfer ownership. In other contexts, it is read-only.",
|
| + "type": "string"
|
| + },
|
| + "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."
|
| + ],
|
| + "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.",
|
| + "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.",
|
| + "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"
|
| + },
|
| + "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."
|
| + },
|
| + "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"
|
| + },
|
| + "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"
|
| + },
|
| + "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"
|
| + },
|
| + "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"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "DriveFile": {
|
| + "description": "Representation of a Google Drive file.",
|
| + "id": "DriveFile",
|
| + "properties": {
|
| + "alternateLink": {
|
| + "description": "URL that can be used to access the Drive item.\n\nRead-only.",
|
| + "type": "string"
|
| + },
|
| + "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"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "GlobalPermission": {
|
| + "description": "Global user permission description.",
|
| + "id": "GlobalPermission",
|
| + "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."
|
| + ],
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "ReturnStudentSubmissionRequest": {
|
| + "description": "Request to return a student submission.",
|
| + "id": "ReturnStudentSubmissionRequest",
|
| + "properties": {},
|
| + "type": "object"
|
| + },
|
| + "Teacher": {
|
| + "description": "Teacher of a course.",
|
| + "id": "Teacher",
|
| + "properties": {
|
| + "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"
|
| + },
|
| + "courseId": {
|
| + "description": "Identifier of the course.\n\nRead-only.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| }
|
| },
|
| "servicePath": "",
|
|
|
Chromium Code Reviews
Issue 3003493002:
Api-Roll 53: 2017-08-21 (Closed)
