OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
5 "https://www.googleapis.com/auth/classroom.rosters.readonly": { | |
6 "description": "View your Google Classroom class rosters" | |
7 }, | |
8 "https://www.googleapis.com/auth/classroom.profile.photos": { | |
9 "description": "View the profile photos of people in your cl
asses" | |
10 }, | |
11 "https://www.googleapis.com/auth/classroom.guardianlinks.student
s": { | 5 "https://www.googleapis.com/auth/classroom.guardianlinks.student
s": { |
12 "description": "View and manage guardians for students in yo
ur Google Classroom classes" | 6 "description": "View and manage guardians for students in yo
ur Google Classroom classes" |
13 }, | 7 }, |
14 "https://www.googleapis.com/auth/classroom.student-submissions.m
e.readonly": { | 8 "https://www.googleapis.com/auth/classroom.student-submissions.m
e.readonly": { |
15 "description": "View your course work and grades in Google C
lassroom" | 9 "description": "View your course work and grades in Google C
lassroom" |
16 }, | 10 }, |
| 11 "https://www.googleapis.com/auth/classroom.guardianlinks.me.read
only": { |
| 12 "description": "View your Google Classroom guardians" |
| 13 }, |
17 "https://www.googleapis.com/auth/classroom.coursework.students":
{ | 14 "https://www.googleapis.com/auth/classroom.coursework.students":
{ |
18 "description": "Manage course work and grades for students i
n the Google Classroom classes you teach and view the course work and grades for
classes you administer" | 15 "description": "Manage course work and grades for students i
n the Google Classroom classes you teach and view the course work and grades for
classes you administer" |
19 }, | 16 }, |
20 "https://www.googleapis.com/auth/classroom.coursework.students.r
eadonly": { | 17 "https://www.googleapis.com/auth/classroom.coursework.students.r
eadonly": { |
21 "description": "View course work and grades for students in
the Google Classroom classes you teach or administer" | 18 "description": "View course work and grades for students in
the Google Classroom classes you teach or administer" |
22 }, | 19 }, |
23 "https://www.googleapis.com/auth/classroom.guardianlinks.me.read
only": { | |
24 "description": "View your Google Classroom guardians" | |
25 }, | |
26 "https://www.googleapis.com/auth/classroom.coursework.me.readonl
y": { | 20 "https://www.googleapis.com/auth/classroom.coursework.me.readonl
y": { |
27 "description": "View your course work and grades in Google C
lassroom" | 21 "description": "View your course work and grades in Google C
lassroom" |
28 }, | 22 }, |
29 "https://www.googleapis.com/auth/classroom.profile.emails": { | 23 "https://www.googleapis.com/auth/classroom.profile.emails": { |
30 "description": "View the email addresses of people in your c
lasses" | 24 "description": "View the email addresses of people in your c
lasses" |
31 }, | 25 }, |
32 "https://www.googleapis.com/auth/classroom.coursework.me": { | 26 "https://www.googleapis.com/auth/classroom.coursework.me": { |
33 "description": "Manage your course work and view your grades
in Google Classroom" | 27 "description": "Manage your course work and view your grades
in Google Classroom" |
34 }, | 28 }, |
35 "https://www.googleapis.com/auth/classroom.rosters": { | 29 "https://www.googleapis.com/auth/classroom.rosters": { |
36 "description": "Manage your Google Classroom class rosters" | 30 "description": "Manage your Google Classroom class rosters" |
37 }, | 31 }, |
38 "https://www.googleapis.com/auth/classroom.student-submissions.s
tudents.readonly": { | 32 "https://www.googleapis.com/auth/classroom.student-submissions.s
tudents.readonly": { |
39 "description": "View course work and grades for students in
the Google Classroom classes you teach or administer" | 33 "description": "View course work and grades for students in
the Google Classroom classes you teach or administer" |
40 }, | 34 }, |
41 "https://www.googleapis.com/auth/classroom.guardianlinks.student
s.readonly": { | 35 "https://www.googleapis.com/auth/classroom.guardianlinks.student
s.readonly": { |
42 "description": "View guardians for students in your Google C
lassroom classes" | 36 "description": "View guardians for students in your Google C
lassroom classes" |
43 }, | 37 }, |
44 "https://www.googleapis.com/auth/classroom.courses": { | 38 "https://www.googleapis.com/auth/classroom.courses": { |
45 "description": "Manage your Google Classroom classes" | 39 "description": "Manage your Google Classroom classes" |
46 }, | 40 }, |
47 "https://www.googleapis.com/auth/classroom.courses.readonly": { | 41 "https://www.googleapis.com/auth/classroom.courses.readonly": { |
48 "description": "View your Google Classroom classes" | 42 "description": "View your Google Classroom classes" |
| 43 }, |
| 44 "https://www.googleapis.com/auth/classroom.profile.photos": { |
| 45 "description": "View the profile photos of people in your cl
asses" |
| 46 }, |
| 47 "https://www.googleapis.com/auth/classroom.rosters.readonly": { |
| 48 "description": "View your Google Classroom class rosters" |
49 } | 49 } |
50 } | 50 } |
51 } | 51 } |
52 }, | 52 }, |
53 "basePath": "", | 53 "basePath": "", |
54 "baseUrl": "https://classroom.googleapis.com/", | 54 "baseUrl": "https://classroom.googleapis.com/", |
55 "batchPath": "batch", | 55 "batchPath": "batch", |
56 "description": "Manages classes, rosters, and invitations in Google Classroo
m.", | 56 "description": "Manages classes, rosters, and invitations in Google Classroo
m.", |
57 "discoveryVersion": "v1", | 57 "discoveryVersion": "v1", |
58 "documentationLink": "https://developers.google.com/classroom/", | 58 "documentationLink": "https://developers.google.com/classroom/", |
59 "icons": { | 59 "icons": { |
60 "x16": "http://www.google.com/images/icons/product/search-16.gif", | 60 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
61 "x32": "http://www.google.com/images/icons/product/search-32.gif" | 61 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
62 }, | 62 }, |
63 "id": "classroom:v1", | 63 "id": "classroom:v1", |
64 "kind": "discovery#restDescription", | 64 "kind": "discovery#restDescription", |
65 "name": "classroom", | 65 "name": "classroom", |
66 "ownerDomain": "google.com", | 66 "ownerDomain": "google.com", |
67 "ownerName": "Google", | 67 "ownerName": "Google", |
68 "parameters": { | 68 "parameters": { |
69 "uploadType": { | 69 "upload_protocol": { |
70 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | 70 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
71 "location": "query", | 71 "location": "query", |
72 "type": "string" | 72 "type": "string" |
73 }, | 73 }, |
| 74 "prettyPrint": { |
| 75 "default": "true", |
| 76 "description": "Returns response with indentations and line breaks."
, |
| 77 "location": "query", |
| 78 "type": "boolean" |
| 79 }, |
74 "fields": { | 80 "fields": { |
75 "description": "Selector specifying which fields to include in a par
tial response.", | 81 "description": "Selector specifying which fields to include in a par
tial response.", |
76 "location": "query", | 82 "location": "query", |
77 "type": "string" | 83 "type": "string" |
78 }, | 84 }, |
| 85 "uploadType": { |
| 86 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
| 87 "location": "query", |
| 88 "type": "string" |
| 89 }, |
79 "callback": { | 90 "callback": { |
80 "description": "JSONP", | 91 "description": "JSONP", |
81 "location": "query", | 92 "location": "query", |
82 "type": "string" | 93 "type": "string" |
83 }, | 94 }, |
84 "$.xgafv": { | 95 "$.xgafv": { |
85 "description": "V1 error format.", | 96 "description": "V1 error format.", |
86 "enum": [ | 97 "enum": [ |
87 "1", | 98 "1", |
88 "2" | 99 "2" |
(...skipping 14 matching lines...) Expand all Loading... |
103 "proto" | 114 "proto" |
104 ], | 115 ], |
105 "enumDescriptions": [ | 116 "enumDescriptions": [ |
106 "Responses with Content-Type of application/json", | 117 "Responses with Content-Type of application/json", |
107 "Media download with context-dependent Content-Type", | 118 "Media download with context-dependent Content-Type", |
108 "Responses with Content-Type of application/x-protobuf" | 119 "Responses with Content-Type of application/x-protobuf" |
109 ], | 120 ], |
110 "location": "query", | 121 "location": "query", |
111 "type": "string" | 122 "type": "string" |
112 }, | 123 }, |
| 124 "key": { |
| 125 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", |
| 126 "location": "query", |
| 127 "type": "string" |
| 128 }, |
113 "access_token": { | 129 "access_token": { |
114 "description": "OAuth access token.", | 130 "description": "OAuth access token.", |
115 "location": "query", | 131 "location": "query", |
116 "type": "string" | 132 "type": "string" |
117 }, | 133 }, |
118 "key": { | |
119 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", | |
120 "location": "query", | |
121 "type": "string" | |
122 }, | |
123 "quotaUser": { | 134 "quotaUser": { |
124 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", | 135 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", |
125 "location": "query", | 136 "location": "query", |
126 "type": "string" | 137 "type": "string" |
127 }, | 138 }, |
128 "pp": { | 139 "pp": { |
129 "default": "true", | 140 "default": "true", |
130 "description": "Pretty-print response.", | 141 "description": "Pretty-print response.", |
131 "location": "query", | 142 "location": "query", |
132 "type": "boolean" | 143 "type": "boolean" |
133 }, | 144 }, |
134 "bearer_token": { | |
135 "description": "OAuth bearer token.", | |
136 "location": "query", | |
137 "type": "string" | |
138 }, | |
139 "oauth_token": { | 145 "oauth_token": { |
140 "description": "OAuth 2.0 token for the current user.", | 146 "description": "OAuth 2.0 token for the current user.", |
141 "location": "query", | 147 "location": "query", |
142 "type": "string" | 148 "type": "string" |
143 }, | 149 }, |
144 "upload_protocol": { | 150 "bearer_token": { |
145 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 151 "description": "OAuth bearer token.", |
146 "location": "query", | 152 "location": "query", |
147 "type": "string" | 153 "type": "string" |
148 }, | |
149 "prettyPrint": { | |
150 "default": "true", | |
151 "description": "Returns response with indentations and line breaks."
, | |
152 "location": "query", | |
153 "type": "boolean" | |
154 } | 154 } |
155 }, | 155 }, |
156 "protocol": "rest", | 156 "protocol": "rest", |
157 "resources": { | 157 "resources": { |
158 "invitations": { | |
159 "methods": { | |
160 "accept": { | |
161 "description": "Accepts an invitation, removing it and addin
g the invited user to the\nteachers or students (as appropriate) of the specifie
d course. Only the\ninvited user may accept an invitation.\n\nThis method return
s the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is
not permitted to accept the\nrequested invitation or for access errors.\n* `FAIL
ED_PRECONDITION` for the following request errors:\n * CourseMemberLimitReach
ed\n * CourseNotModifiable\n * CourseTeacherLimitReached\n * UserGroups
MembershipLimitReached\n* `NOT_FOUND` if no invitation exists with the requested
ID.", | |
162 "httpMethod": "POST", | |
163 "id": "classroom.invitations.accept", | |
164 "parameterOrder": [ | |
165 "id" | |
166 ], | |
167 "parameters": { | |
168 "id": { | |
169 "description": "Identifier of the invitation to acce
pt.", | |
170 "location": "path", | |
171 "required": true, | |
172 "type": "string" | |
173 } | |
174 }, | |
175 "path": "v1/invitations/{id}:accept", | |
176 "response": { | |
177 "$ref": "Empty" | |
178 }, | |
179 "scopes": [ | |
180 "https://www.googleapis.com/auth/classroom.rosters" | |
181 ] | |
182 }, | |
183 "delete": { | |
184 "description": "Deletes an invitation.\n\nThis method return
s 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.", | |
185 "httpMethod": "DELETE", | |
186 "id": "classroom.invitations.delete", | |
187 "parameterOrder": [ | |
188 "id" | |
189 ], | |
190 "parameters": { | |
191 "id": { | |
192 "description": "Identifier of the invitation to dele
te.", | |
193 "location": "path", | |
194 "required": true, | |
195 "type": "string" | |
196 } | |
197 }, | |
198 "path": "v1/invitations/{id}", | |
199 "response": { | |
200 "$ref": "Empty" | |
201 }, | |
202 "scopes": [ | |
203 "https://www.googleapis.com/auth/classroom.rosters" | |
204 ] | |
205 }, | |
206 "list": { | |
207 "description": "Returns a list of invitations that the reque
sting user is permitted to\nview, restricted to those that match the list reques
t.\n\n*Note:* At least one of `user_id` or `course_id` must be supplied. Both\nf
ields can be supplied.\n\nThis method returns the following error codes:\n\n* `P
ERMISSION_DENIED` for access errors.", | |
208 "httpMethod": "GET", | |
209 "id": "classroom.invitations.list", | |
210 "parameterOrder": [], | |
211 "parameters": { | |
212 "pageToken": { | |
213 "description": "nextPageToken\nvalue returned from a
previous\nlist call, indicating\nthat the subsequent page of results should be
returned.\n\nThe list request must be\notherwise identical to the one that resul
ted in this token.", | |
214 "location": "query", | |
215 "type": "string" | |
216 }, | |
217 "userId": { | |
218 "description": "Restricts returned invitations to th
ose for a specific user. The identifier\ncan be one of the following:\n\n* the n
umeric identifier for the user\n* the email address of the user\n* the string li
teral `\"me\"`, indicating the requesting user", | |
219 "location": "query", | |
220 "type": "string" | |
221 }, | |
222 "pageSize": { | |
223 "description": "Maximum number of items to return. Z
ero means no maximum.\n\nThe server may return fewer than the specified number o
f results.", | |
224 "format": "int32", | |
225 "location": "query", | |
226 "type": "integer" | |
227 }, | |
228 "courseId": { | |
229 "description": "Restricts returned invitations to th
ose for a course with the specified\nidentifier.", | |
230 "location": "query", | |
231 "type": "string" | |
232 } | |
233 }, | |
234 "path": "v1/invitations", | |
235 "response": { | |
236 "$ref": "ListInvitationsResponse" | |
237 }, | |
238 "scopes": [ | |
239 "https://www.googleapis.com/auth/classroom.rosters", | |
240 "https://www.googleapis.com/auth/classroom.rosters.reado
nly" | |
241 ] | |
242 }, | |
243 "get": { | |
244 "description": "Returns an invitation.\n\nThis method return
s the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is
not permitted to view the\nrequested invitation or for access errors.\n* `NOT_FO
UND` if no invitation exists with the requested ID.", | |
245 "httpMethod": "GET", | |
246 "id": "classroom.invitations.get", | |
247 "parameterOrder": [ | |
248 "id" | |
249 ], | |
250 "parameters": { | |
251 "id": { | |
252 "description": "Identifier of the invitation to retu
rn.", | |
253 "location": "path", | |
254 "required": true, | |
255 "type": "string" | |
256 } | |
257 }, | |
258 "path": "v1/invitations/{id}", | |
259 "response": { | |
260 "$ref": "Invitation" | |
261 }, | |
262 "scopes": [ | |
263 "https://www.googleapis.com/auth/classroom.rosters", | |
264 "https://www.googleapis.com/auth/classroom.rosters.reado
nly" | |
265 ] | |
266 }, | |
267 "create": { | |
268 "description": "Creates an invitation. Only one invitation f
or a user and course may exist\nat a time. Delete and re-create an invitation to
make changes.\n\nThis method returns the following error codes:\n\n* `PERMISSIO
N_DENIED` if the requesting user is not permitted to create\ninvitations for thi
s course or for access errors.\n* `NOT_FOUND` if the course or the user does not
exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled or
if\nthe user already has this role or a role with greater permissions.\n* `ALREA
DY_EXISTS` if an invitation for the specified user and course\nalready exists.", | |
269 "httpMethod": "POST", | |
270 "id": "classroom.invitations.create", | |
271 "parameterOrder": [], | |
272 "parameters": {}, | |
273 "path": "v1/invitations", | |
274 "request": { | |
275 "$ref": "Invitation" | |
276 }, | |
277 "response": { | |
278 "$ref": "Invitation" | |
279 }, | |
280 "scopes": [ | |
281 "https://www.googleapis.com/auth/classroom.rosters" | |
282 ] | |
283 } | |
284 } | |
285 }, | |
286 "userProfiles": { | 158 "userProfiles": { |
287 "methods": { | 159 "methods": { |
288 "get": { | 160 "get": { |
289 "description": "Returns a user profile.\n\nThis method retur
ns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is
not permitted to access\nthis user profile, if no profile exists with the reque
sted ID, or for\naccess errors.", | 161 "description": "Returns a user profile.\n\nThis method retur
ns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is
not permitted to access\nthis user profile, if no profile exists with the reque
sted ID, or for\naccess errors.", |
290 "httpMethod": "GET", | 162 "httpMethod": "GET", |
291 "id": "classroom.userProfiles.get", | 163 "id": "classroom.userProfiles.get", |
292 "parameterOrder": [ | 164 "parameterOrder": [ |
293 "userId" | 165 "userId" |
294 ], | 166 ], |
295 "parameters": { | 167 "parameters": { |
(...skipping 272 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
568 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students", | 440 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students", |
569 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students.readonly" | 441 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students.readonly" |
570 ] | 442 ] |
571 } | 443 } |
572 } | 444 } |
573 } | 445 } |
574 } | 446 } |
575 }, | 447 }, |
576 "courses": { | 448 "courses": { |
577 "methods": { | 449 "methods": { |
578 "get": { | |
579 "description": "Returns a course.\n\nThis method returns the
following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not p
ermitted to access the\nrequested course or for access errors.\n* `NOT_FOUND` if
no course exists with the requested ID.", | |
580 "httpMethod": "GET", | |
581 "id": "classroom.courses.get", | |
582 "parameterOrder": [ | |
583 "id" | |
584 ], | |
585 "parameters": { | |
586 "id": { | |
587 "description": "Identifier of the course to return.\
nThis identifier can be either the Classroom-assigned identifier or an\nalias.", | |
588 "location": "path", | |
589 "required": true, | |
590 "type": "string" | |
591 } | |
592 }, | |
593 "path": "v1/courses/{id}", | |
594 "response": { | |
595 "$ref": "Course" | |
596 }, | |
597 "scopes": [ | |
598 "https://www.googleapis.com/auth/classroom.courses", | |
599 "https://www.googleapis.com/auth/classroom.courses.reado
nly" | |
600 ] | |
601 }, | |
602 "patch": { | 450 "patch": { |
603 "description": "Updates one or more fields in a course.\n\nT
his method returns the following error codes:\n\n* `PERMISSION_DENIED` if the re
questing user is not permitted to modify the\nrequested course or for access err
ors.\n* `NOT_FOUND` if no course exists with the requested ID.\n* `INVALID_ARGUM
ENT` 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 * Cou
rseNotModifiable", | 451 "description": "Updates one or more fields in a course.\n\nT
his method returns the following error codes:\n\n* `PERMISSION_DENIED` if the re
questing user is not permitted to modify the\nrequested course or for access err
ors.\n* `NOT_FOUND` if no course exists with the requested ID.\n* `INVALID_ARGUM
ENT` 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 * Cou
rseNotModifiable", |
604 "httpMethod": "PATCH", | 452 "httpMethod": "PATCH", |
605 "id": "classroom.courses.patch", | 453 "id": "classroom.courses.patch", |
606 "parameterOrder": [ | 454 "parameterOrder": [ |
607 "id" | 455 "id" |
608 ], | 456 ], |
609 "parameters": { | 457 "parameters": { |
610 "id": { | 458 "id": { |
611 "description": "Identifier of the course to update.\
nThis identifier can be either the Classroom-assigned identifier or an\nalias.", | 459 "description": "Identifier of the course to update.\
nThis identifier can be either the Classroom-assigned identifier or an\nalias.", |
(...skipping 12 matching lines...) Expand all Loading... |
624 "request": { | 472 "request": { |
625 "$ref": "Course" | 473 "$ref": "Course" |
626 }, | 474 }, |
627 "response": { | 475 "response": { |
628 "$ref": "Course" | 476 "$ref": "Course" |
629 }, | 477 }, |
630 "scopes": [ | 478 "scopes": [ |
631 "https://www.googleapis.com/auth/classroom.courses" | 479 "https://www.googleapis.com/auth/classroom.courses" |
632 ] | 480 ] |
633 }, | 481 }, |
| 482 "get": { |
| 483 "description": "Returns a course.\n\nThis method returns the
following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not p
ermitted to access the\nrequested course or for access errors.\n* `NOT_FOUND` if
no course exists with the requested ID.", |
| 484 "httpMethod": "GET", |
| 485 "id": "classroom.courses.get", |
| 486 "parameterOrder": [ |
| 487 "id" |
| 488 ], |
| 489 "parameters": { |
| 490 "id": { |
| 491 "description": "Identifier of the course to return.\
nThis identifier can be either the Classroom-assigned identifier or an\nalias.", |
| 492 "location": "path", |
| 493 "required": true, |
| 494 "type": "string" |
| 495 } |
| 496 }, |
| 497 "path": "v1/courses/{id}", |
| 498 "response": { |
| 499 "$ref": "Course" |
| 500 }, |
| 501 "scopes": [ |
| 502 "https://www.googleapis.com/auth/classroom.courses", |
| 503 "https://www.googleapis.com/auth/classroom.courses.reado
nly" |
| 504 ] |
| 505 }, |
634 "update": { | 506 "update": { |
635 "description": "Updates a course.\n\nThis method returns the
following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not p
ermitted 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 follow
ing request errors:\n * CourseNotModifiable", | 507 "description": "Updates a course.\n\nThis method returns the
following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not p
ermitted 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 follow
ing request errors:\n * CourseNotModifiable", |
636 "httpMethod": "PUT", | 508 "httpMethod": "PUT", |
637 "id": "classroom.courses.update", | 509 "id": "classroom.courses.update", |
638 "parameterOrder": [ | 510 "parameterOrder": [ |
639 "id" | 511 "id" |
640 ], | 512 ], |
641 "parameters": { | 513 "parameters": { |
642 "id": { | 514 "id": { |
643 "description": "Identifier of the course to update.\
nThis identifier can be either the Classroom-assigned identifier or an\nalias.", | 515 "description": "Identifier of the course to update.\
nThis identifier can be either the Classroom-assigned identifier or an\nalias.", |
(...skipping 101 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
745 "$ref": "Course" | 617 "$ref": "Course" |
746 }, | 618 }, |
747 "scopes": [ | 619 "scopes": [ |
748 "https://www.googleapis.com/auth/classroom.courses" | 620 "https://www.googleapis.com/auth/classroom.courses" |
749 ] | 621 ] |
750 } | 622 } |
751 }, | 623 }, |
752 "resources": { | 624 "resources": { |
753 "aliases": { | 625 "aliases": { |
754 "methods": { | 626 "methods": { |
755 "create": { | |
756 "description": "Creates an alias for a course.\n\nTh
is method returns the following error codes:\n\n* `PERMISSION_DENIED` if the req
uesting user is not permitted to create the\nalias or for access errors.\n* `NOT
_FOUND` if the course does not exist.\n* `ALREADY_EXISTS` if the alias already e
xists.\n* `FAILED_PRECONDITION` if the alias requested does not make sense for t
he\n requesting user or course (for example, if a user not in a domain\n attem
pts to access a domain-scoped alias).", | |
757 "httpMethod": "POST", | |
758 "id": "classroom.courses.aliases.create", | |
759 "parameterOrder": [ | |
760 "courseId" | |
761 ], | |
762 "parameters": { | |
763 "courseId": { | |
764 "description": "Identifier of the course to
alias.\nThis identifier can be either the Classroom-assigned identifier or an\na
lias.", | |
765 "location": "path", | |
766 "required": true, | |
767 "type": "string" | |
768 } | |
769 }, | |
770 "path": "v1/courses/{courseId}/aliases", | |
771 "request": { | |
772 "$ref": "CourseAlias" | |
773 }, | |
774 "response": { | |
775 "$ref": "CourseAlias" | |
776 }, | |
777 "scopes": [ | |
778 "https://www.googleapis.com/auth/classroom.cours
es" | |
779 ] | |
780 }, | |
781 "delete": { | 627 "delete": { |
782 "description": "Deletes an alias of a course.\n\nThi
s method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requ
esting user is not permitted to remove the\nalias or for access errors.\n* `NOT_
FOUND` if the alias does not exist.\n* `FAILED_PRECONDITION` if the alias reques
ted does not make sense for the\n requesting user or course (for example, if a
user not in a domain\n attempts to delete a domain-scoped alias).", | 628 "description": "Deletes an alias of a course.\n\nThi
s method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requ
esting user is not permitted to remove the\nalias or for access errors.\n* `NOT_
FOUND` if the alias does not exist.\n* `FAILED_PRECONDITION` if the alias reques
ted does not make sense for the\n requesting user or course (for example, if a
user not in a domain\n attempts to delete a domain-scoped alias).", |
783 "httpMethod": "DELETE", | 629 "httpMethod": "DELETE", |
784 "id": "classroom.courses.aliases.delete", | 630 "id": "classroom.courses.aliases.delete", |
785 "parameterOrder": [ | 631 "parameterOrder": [ |
786 "courseId", | 632 "courseId", |
787 "alias" | 633 "alias" |
788 ], | 634 ], |
789 "parameters": { | 635 "parameters": { |
790 "courseId": { | 636 "courseId": { |
(...skipping 44 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
835 } | 681 } |
836 }, | 682 }, |
837 "path": "v1/courses/{courseId}/aliases", | 683 "path": "v1/courses/{courseId}/aliases", |
838 "response": { | 684 "response": { |
839 "$ref": "ListCourseAliasesResponse" | 685 "$ref": "ListCourseAliasesResponse" |
840 }, | 686 }, |
841 "scopes": [ | 687 "scopes": [ |
842 "https://www.googleapis.com/auth/classroom.cours
es", | 688 "https://www.googleapis.com/auth/classroom.cours
es", |
843 "https://www.googleapis.com/auth/classroom.cours
es.readonly" | 689 "https://www.googleapis.com/auth/classroom.cours
es.readonly" |
844 ] | 690 ] |
| 691 }, |
| 692 "create": { |
| 693 "description": "Creates an alias for a course.\n\nTh
is method returns the following error codes:\n\n* `PERMISSION_DENIED` if the req
uesting user is not permitted to create the\nalias or for access errors.\n* `NOT
_FOUND` if the course does not exist.\n* `ALREADY_EXISTS` if the alias already e
xists.\n* `FAILED_PRECONDITION` if the alias requested does not make sense for t
he\n requesting user or course (for example, if a user not in a domain\n attem
pts to access a domain-scoped alias).", |
| 694 "httpMethod": "POST", |
| 695 "id": "classroom.courses.aliases.create", |
| 696 "parameterOrder": [ |
| 697 "courseId" |
| 698 ], |
| 699 "parameters": { |
| 700 "courseId": { |
| 701 "description": "Identifier of the course to
alias.\nThis identifier can be either the Classroom-assigned identifier or an\na
lias.", |
| 702 "location": "path", |
| 703 "required": true, |
| 704 "type": "string" |
| 705 } |
| 706 }, |
| 707 "path": "v1/courses/{courseId}/aliases", |
| 708 "request": { |
| 709 "$ref": "CourseAlias" |
| 710 }, |
| 711 "response": { |
| 712 "$ref": "CourseAlias" |
| 713 }, |
| 714 "scopes": [ |
| 715 "https://www.googleapis.com/auth/classroom.cours
es" |
| 716 ] |
845 } | 717 } |
846 } | 718 } |
847 }, | 719 }, |
848 "students": { | 720 "students": { |
849 "methods": { | 721 "methods": { |
| 722 "delete": { |
| 723 "description": "Deletes a student of a course.\n\nTh
is method returns the following error codes:\n\n* `PERMISSION_DENIED` if the req
uesting user is not permitted to delete\nstudents of this course or for access e
rrors.\n* `NOT_FOUND` if no student of this course has the requested ID or if th
e\ncourse does not exist.", |
| 724 "httpMethod": "DELETE", |
| 725 "id": "classroom.courses.students.delete", |
| 726 "parameterOrder": [ |
| 727 "courseId", |
| 728 "userId" |
| 729 ], |
| 730 "parameters": { |
| 731 "userId": { |
| 732 "description": "Identifier of the student to
delete. The identifier can be one of the\nfollowing:\n\n* the numeric identifie
r for the user\n* the email address of the user\n* the string literal `\"me\"`,
indicating the requesting user", |
| 733 "location": "path", |
| 734 "required": true, |
| 735 "type": "string" |
| 736 }, |
| 737 "courseId": { |
| 738 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", |
| 739 "location": "path", |
| 740 "required": true, |
| 741 "type": "string" |
| 742 } |
| 743 }, |
| 744 "path": "v1/courses/{courseId}/students/{userId}", |
| 745 "response": { |
| 746 "$ref": "Empty" |
| 747 }, |
| 748 "scopes": [ |
| 749 "https://www.googleapis.com/auth/classroom.roste
rs" |
| 750 ] |
| 751 }, |
850 "list": { | 752 "list": { |
851 "description": "Returns a list of students of this c
ourse that the requester\nis permitted to view.\n\nThis method returns the follo
wing error codes:\n\n* `NOT_FOUND` if the course does not exist.\n* `PERMISSION_
DENIED` for access errors.", | 753 "description": "Returns a list of students of this c
ourse that the requester\nis permitted to view.\n\nThis method returns the follo
wing error codes:\n\n* `NOT_FOUND` if the course does not exist.\n* `PERMISSION_
DENIED` for access errors.", |
852 "httpMethod": "GET", | 754 "httpMethod": "GET", |
853 "id": "classroom.courses.students.list", | 755 "id": "classroom.courses.students.list", |
854 "parameterOrder": [ | 756 "parameterOrder": [ |
855 "courseId" | 757 "courseId" |
856 ], | 758 ], |
857 "parameters": { | 759 "parameters": { |
858 "pageToken": { | |
859 "description": "nextPageToken\nvalue returne
d from a previous\nlist call, indicating that\nthe subsequent page of results sh
ould be returned.\n\nThe list request must be\notherwise identical to the one th
at resulted in this token.", | |
860 "location": "query", | |
861 "type": "string" | |
862 }, | |
863 "pageSize": { | 760 "pageSize": { |
864 "description": "Maximum number of items to r
eturn. Zero means no maximum.\n\nThe server may return fewer than the specified
number of results.", | 761 "description": "Maximum number of items to r
eturn. Zero means no maximum.\n\nThe server may return fewer than the specified
number of results.", |
865 "format": "int32", | 762 "format": "int32", |
866 "location": "query", | 763 "location": "query", |
867 "type": "integer" | 764 "type": "integer" |
868 }, | 765 }, |
869 "courseId": { | 766 "courseId": { |
870 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", | 767 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", |
871 "location": "path", | 768 "location": "path", |
872 "required": true, | 769 "required": true, |
873 "type": "string" | 770 "type": "string" |
| 771 }, |
| 772 "pageToken": { |
| 773 "description": "nextPageToken\nvalue returne
d from a previous\nlist call, indicating that\nthe subsequent page of results sh
ould be returned.\n\nThe list request must be\notherwise identical to the one th
at resulted in this token.", |
| 774 "location": "query", |
| 775 "type": "string" |
874 } | 776 } |
875 }, | 777 }, |
876 "path": "v1/courses/{courseId}/students", | 778 "path": "v1/courses/{courseId}/students", |
877 "response": { | 779 "response": { |
878 "$ref": "ListStudentsResponse" | 780 "$ref": "ListStudentsResponse" |
879 }, | 781 }, |
880 "scopes": [ | 782 "scopes": [ |
881 "https://www.googleapis.com/auth/classroom.profi
le.emails", | 783 "https://www.googleapis.com/auth/classroom.profi
le.emails", |
882 "https://www.googleapis.com/auth/classroom.profi
le.photos", | 784 "https://www.googleapis.com/auth/classroom.profi
le.photos", |
883 "https://www.googleapis.com/auth/classroom.roste
rs", | 785 "https://www.googleapis.com/auth/classroom.roste
rs", |
(...skipping 34 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
918 ] | 820 ] |
919 }, | 821 }, |
920 "create": { | 822 "create": { |
921 "description": "Adds a user as a student of a course
.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if
the requesting user is not permitted to create\nstudents in this course or for a
ccess errors.\n* `NOT_FOUND` if the requested course ID does not exist.\n* `FAIL
ED_PRECONDITION` if the requested user's account is disabled,\nfor the following
request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n
* UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if the user is already a
student or teacher in the\ncourse.", | 823 "description": "Adds a user as a student of a course
.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if
the requesting user is not permitted to create\nstudents in this course or for a
ccess errors.\n* `NOT_FOUND` if the requested course ID does not exist.\n* `FAIL
ED_PRECONDITION` if the requested user's account is disabled,\nfor the following
request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n
* UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if the user is already a
student or teacher in the\ncourse.", |
922 "httpMethod": "POST", | 824 "httpMethod": "POST", |
923 "id": "classroom.courses.students.create", | 825 "id": "classroom.courses.students.create", |
924 "parameterOrder": [ | 826 "parameterOrder": [ |
925 "courseId" | 827 "courseId" |
926 ], | 828 ], |
927 "parameters": { | 829 "parameters": { |
| 830 "enrollmentCode": { |
| 831 "description": "Enrollment code of the cours
e to create the student in.\nThis code is required if userId\ncorresponds to the
requesting user; it may be omitted if the requesting\nuser has administrative p
ermissions to create students for any user.", |
| 832 "location": "query", |
| 833 "type": "string" |
| 834 }, |
928 "courseId": { | 835 "courseId": { |
929 "description": "Identifier of the course to
create the student in.\nThis identifier can be either the Classroom-assigned ide
ntifier or an\nalias.", | 836 "description": "Identifier of the course to
create the student in.\nThis identifier can be either the Classroom-assigned ide
ntifier or an\nalias.", |
930 "location": "path", | 837 "location": "path", |
931 "required": true, | 838 "required": true, |
932 "type": "string" | 839 "type": "string" |
933 }, | |
934 "enrollmentCode": { | |
935 "description": "Enrollment code of the cours
e to create the student in.\nThis code is required if userId\ncorresponds to the
requesting user; it may be omitted if the requesting\nuser has administrative p
ermissions to create students for any user.", | |
936 "location": "query", | |
937 "type": "string" | |
938 } | 840 } |
939 }, | 841 }, |
940 "path": "v1/courses/{courseId}/students", | 842 "path": "v1/courses/{courseId}/students", |
941 "request": { | 843 "request": { |
942 "$ref": "Student" | 844 "$ref": "Student" |
943 }, | 845 }, |
944 "response": { | 846 "response": { |
945 "$ref": "Student" | 847 "$ref": "Student" |
946 }, | 848 }, |
947 "scopes": [ | 849 "scopes": [ |
948 "https://www.googleapis.com/auth/classroom.profi
le.emails", | 850 "https://www.googleapis.com/auth/classroom.profi
le.emails", |
949 "https://www.googleapis.com/auth/classroom.profi
le.photos", | 851 "https://www.googleapis.com/auth/classroom.profi
le.photos", |
950 "https://www.googleapis.com/auth/classroom.roste
rs" | 852 "https://www.googleapis.com/auth/classroom.roste
rs" |
951 ] | 853 ] |
952 }, | |
953 "delete": { | |
954 "description": "Deletes a student of a course.\n\nTh
is method returns the following error codes:\n\n* `PERMISSION_DENIED` if the req
uesting user is not permitted to delete\nstudents of this course or for access e
rrors.\n* `NOT_FOUND` if no student of this course has the requested ID or if th
e\ncourse does not exist.", | |
955 "httpMethod": "DELETE", | |
956 "id": "classroom.courses.students.delete", | |
957 "parameterOrder": [ | |
958 "courseId", | |
959 "userId" | |
960 ], | |
961 "parameters": { | |
962 "userId": { | |
963 "description": "Identifier of the student to
delete. The identifier can be one of the\nfollowing:\n\n* the numeric identifie
r for the user\n* the email address of the user\n* the string literal `\"me\"`,
indicating the requesting user", | |
964 "location": "path", | |
965 "required": true, | |
966 "type": "string" | |
967 }, | |
968 "courseId": { | |
969 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", | |
970 "location": "path", | |
971 "required": true, | |
972 "type": "string" | |
973 } | |
974 }, | |
975 "path": "v1/courses/{courseId}/students/{userId}", | |
976 "response": { | |
977 "$ref": "Empty" | |
978 }, | |
979 "scopes": [ | |
980 "https://www.googleapis.com/auth/classroom.roste
rs" | |
981 ] | |
982 } | 854 } |
983 } | 855 } |
984 }, | 856 }, |
985 "courseWork": { | 857 "courseWork": { |
986 "methods": { | 858 "methods": { |
987 "delete": { | 859 "delete": { |
988 "description": "Deletes a course work.\n\nThis reque
st 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 co
urse work item.\n\nThis method returns the following error codes:\n\n* `PERMISSI
ON_DENIED` if the requesting developer project did not create\nthe corresponding
course work, if the requesting user is not permitted\nto delete the requested c
ourse or for access errors.\n* `FAILED_PRECONDITION` if the requested course wor
k has already been\ndeleted.\n* `NOT_FOUND` if no course exists with the request
ed ID.", | 860 "description": "Deletes a course work.\n\nThis reque
st 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 co
urse work item.\n\nThis method returns the following error codes:\n\n* `PERMISSI
ON_DENIED` if the requesting developer project did not create\nthe corresponding
course work, if the requesting user is not permitted\nto delete the requested c
ourse or for access errors.\n* `FAILED_PRECONDITION` if the requested course wor
k has already been\ndeleted.\n* `NOT_FOUND` if no course exists with the request
ed ID.", |
989 "httpMethod": "DELETE", | 861 "httpMethod": "DELETE", |
990 "id": "classroom.courses.courseWork.delete", | 862 "id": "classroom.courses.courseWork.delete", |
991 "parameterOrder": [ | 863 "parameterOrder": [ |
(...skipping 23 matching lines...) Expand all Loading... |
1015 ] | 887 ] |
1016 }, | 888 }, |
1017 "list": { | 889 "list": { |
1018 "description": "Returns a list of course work that t
he requester is permitted to view.\n\nCourse students may only view `PUBLISHED`
course work. Course teachers\nand domain administrators may view all course work
.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if
the requesting user is not permitted to access\nthe requested course or for acce
ss errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if
the requested course does not exist.", | 890 "description": "Returns a list of course work that t
he requester is permitted to view.\n\nCourse students may only view `PUBLISHED`
course work. Course teachers\nand domain administrators may view all course work
.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if
the requesting user is not permitted to access\nthe requested course or for acce
ss errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if
the requested course does not exist.", |
1019 "httpMethod": "GET", | 891 "httpMethod": "GET", |
1020 "id": "classroom.courses.courseWork.list", | 892 "id": "classroom.courses.courseWork.list", |
1021 "parameterOrder": [ | 893 "parameterOrder": [ |
1022 "courseId" | 894 "courseId" |
1023 ], | 895 ], |
1024 "parameters": { | 896 "parameters": { |
1025 "pageToken": { | |
1026 "description": "nextPageToken\nvalue returne
d from a previous\nlist call,\nindicating that the subsequent page of results sh
ould be returned.\n\nThe list request\nmust be otherwise identical to the one th
at resulted in this token.", | |
1027 "location": "query", | |
1028 "type": "string" | |
1029 }, | |
1030 "orderBy": { | |
1031 "description": "Optional sort ordering for r
esults. A comma-separated list of fields with\nan optional sort direction keywor
d. Supported fields are `updateTime`\nand `dueDate`. Supported direction keyword
s are `asc` and `desc`.\nIf not specified, `updateTime desc` is the default beha
vior.\nExamples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc`", | |
1032 "location": "query", | |
1033 "type": "string" | |
1034 }, | |
1035 "pageSize": { | 897 "pageSize": { |
1036 "description": "Maximum number of items to r
eturn. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nT
he server may return fewer than the specified number of results.", | 898 "description": "Maximum number of items to r
eturn. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nT
he server may return fewer than the specified number of results.", |
1037 "format": "int32", | 899 "format": "int32", |
1038 "location": "query", | 900 "location": "query", |
1039 "type": "integer" | 901 "type": "integer" |
1040 }, | 902 }, |
1041 "courseWorkStates": { | 903 "courseWorkStates": { |
1042 "description": "Restriction on the work stat
us to return. Only courseWork that matches\nis returned. If unspecified, items w
ith a work status of `PUBLISHED`\nis returned.", | 904 "description": "Restriction on the work stat
us to return. Only courseWork that matches\nis returned. If unspecified, items w
ith a work status of `PUBLISHED`\nis returned.", |
1043 "enum": [ | 905 "enum": [ |
1044 "COURSE_WORK_STATE_UNSPECIFIED", | 906 "COURSE_WORK_STATE_UNSPECIFIED", |
1045 "PUBLISHED", | 907 "PUBLISHED", |
1046 "DRAFT", | 908 "DRAFT", |
1047 "DELETED" | 909 "DELETED" |
1048 ], | 910 ], |
1049 "location": "query", | 911 "location": "query", |
1050 "repeated": true, | 912 "repeated": true, |
1051 "type": "string" | 913 "type": "string" |
1052 }, | 914 }, |
1053 "courseId": { | 915 "courseId": { |
1054 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", | 916 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", |
1055 "location": "path", | 917 "location": "path", |
1056 "required": true, | 918 "required": true, |
1057 "type": "string" | 919 "type": "string" |
| 920 }, |
| 921 "pageToken": { |
| 922 "description": "nextPageToken\nvalue returne
d from a previous\nlist call,\nindicating that the subsequent page of results sh
ould be returned.\n\nThe list request\nmust be otherwise identical to the one th
at resulted in this token.", |
| 923 "location": "query", |
| 924 "type": "string" |
| 925 }, |
| 926 "orderBy": { |
| 927 "description": "Optional sort ordering for r
esults. A comma-separated list of fields with\nan optional sort direction keywor
d. Supported fields are `updateTime`\nand `dueDate`. Supported direction keyword
s are `asc` and `desc`.\nIf not specified, `updateTime desc` is the default beha
vior.\nExamples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc`", |
| 928 "location": "query", |
| 929 "type": "string" |
1058 } | 930 } |
1059 }, | 931 }, |
1060 "path": "v1/courses/{courseId}/courseWork", | 932 "path": "v1/courses/{courseId}/courseWork", |
1061 "response": { | 933 "response": { |
1062 "$ref": "ListCourseWorkResponse" | 934 "$ref": "ListCourseWorkResponse" |
1063 }, | 935 }, |
1064 "scopes": [ | 936 "scopes": [ |
1065 "https://www.googleapis.com/auth/classroom.cours
ework.me", | 937 "https://www.googleapis.com/auth/classroom.cours
ework.me", |
1066 "https://www.googleapis.com/auth/classroom.cours
ework.me.readonly", | 938 "https://www.googleapis.com/auth/classroom.cours
ework.me.readonly", |
1067 "https://www.googleapis.com/auth/classroom.cours
ework.students", | 939 "https://www.googleapis.com/auth/classroom.cours
ework.students", |
(...skipping 35 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1103 }, | 975 }, |
1104 "patch": { | 976 "patch": { |
1105 "description": "Updates one or more fields of a cour
se work.\n\nSee google.classroom.v1.CourseWork for details\nof which fields may
be updated and who may change them.\n\nThis request must be made by the Develope
r Console project of the\n[OAuth client ID](https://support.google.com/cloud/ans
wer/6158849) used to\ncreate the corresponding course work item.\n\nThis method
returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting de
veloper project did not create\nthe corresponding course work, if the user is no
t permitted to make the\nrequested modification to the student submission, or fo
r\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `FAILED_
PRECONDITION` if the requested course work has already been\ndeleted.\n* `NOT_FO
UND` if the requested course, course work, or student submission\ndoes not exist
.", | 977 "description": "Updates one or more fields of a cour
se work.\n\nSee google.classroom.v1.CourseWork for details\nof which fields may
be updated and who may change them.\n\nThis request must be made by the Develope
r Console project of the\n[OAuth client ID](https://support.google.com/cloud/ans
wer/6158849) used to\ncreate the corresponding course work item.\n\nThis method
returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting de
veloper project did not create\nthe corresponding course work, if the user is no
t permitted to make the\nrequested modification to the student submission, or fo
r\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `FAILED_
PRECONDITION` if the requested course work has already been\ndeleted.\n* `NOT_FO
UND` if the requested course, course work, or student submission\ndoes not exist
.", |
1106 "httpMethod": "PATCH", | 978 "httpMethod": "PATCH", |
1107 "id": "classroom.courses.courseWork.patch", | 979 "id": "classroom.courses.courseWork.patch", |
1108 "parameterOrder": [ | 980 "parameterOrder": [ |
1109 "courseId", | 981 "courseId", |
1110 "id" | 982 "id" |
1111 ], | 983 ], |
1112 "parameters": { | 984 "parameters": { |
| 985 "updateMask": { |
| 986 "description": "Mask that identifies which f
ields 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 CourseWo
rk object. If a\nfield that does not support empty values is included in the upd
ate 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* `sche
duled_time`\n* `submission_modification_mode`", |
| 987 "format": "google-fieldmask", |
| 988 "location": "query", |
| 989 "type": "string" |
| 990 }, |
1113 "courseId": { | 991 "courseId": { |
1114 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", | 992 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", |
1115 "location": "path", | 993 "location": "path", |
1116 "required": true, | 994 "required": true, |
1117 "type": "string" | 995 "type": "string" |
1118 }, | 996 }, |
1119 "id": { | 997 "id": { |
1120 "description": "Identifier of the course wor
k.", | 998 "description": "Identifier of the course wor
k.", |
1121 "location": "path", | 999 "location": "path", |
1122 "required": true, | 1000 "required": true, |
1123 "type": "string" | 1001 "type": "string" |
1124 }, | |
1125 "updateMask": { | |
1126 "description": "Mask that identifies which f
ields 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 CourseWo
rk object. If a\nfield that does not support empty values is included in the upd
ate 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* `sche
duled_time`\n* `submission_modification_mode`", | |
1127 "format": "google-fieldmask", | |
1128 "location": "query", | |
1129 "type": "string" | |
1130 } | 1002 } |
1131 }, | 1003 }, |
1132 "path": "v1/courses/{courseId}/courseWork/{id}", | 1004 "path": "v1/courses/{courseId}/courseWork/{id}", |
1133 "request": { | 1005 "request": { |
1134 "$ref": "CourseWork" | 1006 "$ref": "CourseWork" |
1135 }, | 1007 }, |
1136 "response": { | 1008 "response": { |
1137 "$ref": "CourseWork" | 1009 "$ref": "CourseWork" |
1138 }, | 1010 }, |
1139 "scopes": [ | 1011 "scopes": [ |
(...skipping 75 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1215 "patch": { | 1087 "patch": { |
1216 "description": "Updates one or more fields o
f a student submission.\n\nSee google.classroom.v1.StudentSubmission for details
\nof which fields may be updated and who may change them.\n\nThis request must b
e made by the Developer Console project of the\n[OAuth client ID](https://suppor
t.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work
item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED
` if the requesting developer project did not create\nthe corresponding course w
ork, if the user is not permitted to make the\nrequested modification to the stu
dent submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is
malformed.\n* `NOT_FOUND` if the requested course, course work, or student submi
ssion\ndoes not exist.", | 1088 "description": "Updates one or more fields o
f a student submission.\n\nSee google.classroom.v1.StudentSubmission for details
\nof which fields may be updated and who may change them.\n\nThis request must b
e made by the Developer Console project of the\n[OAuth client ID](https://suppor
t.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work
item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED
` if the requesting developer project did not create\nthe corresponding course w
ork, if the user is not permitted to make the\nrequested modification to the stu
dent submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is
malformed.\n* `NOT_FOUND` if the requested course, course work, or student submi
ssion\ndoes not exist.", |
1217 "httpMethod": "PATCH", | 1089 "httpMethod": "PATCH", |
1218 "id": "classroom.courses.courseWork.studentS
ubmissions.patch", | 1090 "id": "classroom.courses.courseWork.studentS
ubmissions.patch", |
1219 "parameterOrder": [ | 1091 "parameterOrder": [ |
1220 "courseId", | 1092 "courseId", |
1221 "courseWorkId", | 1093 "courseWorkId", |
1222 "id" | 1094 "id" |
1223 ], | 1095 ], |
1224 "parameters": { | 1096 "parameters": { |
| 1097 "updateMask": { |
| 1098 "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`", |
| 1099 "format": "google-fieldmask", |
| 1100 "location": "query", |
| 1101 "type": "string" |
| 1102 }, |
1225 "courseWorkId": { | 1103 "courseWorkId": { |
1226 "description": "Identifier of the co
urse work.", | 1104 "description": "Identifier of the co
urse work.", |
1227 "location": "path", | 1105 "location": "path", |
1228 "required": true, | 1106 "required": true, |
1229 "type": "string" | 1107 "type": "string" |
1230 }, | 1108 }, |
1231 "courseId": { | 1109 "courseId": { |
1232 "description": "Identifier of the co
urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal
ias.", | 1110 "description": "Identifier of the co
urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal
ias.", |
1233 "location": "path", | 1111 "location": "path", |
1234 "required": true, | 1112 "required": true, |
1235 "type": "string" | 1113 "type": "string" |
1236 }, | 1114 }, |
1237 "id": { | 1115 "id": { |
1238 "description": "Identifier of the st
udent submission.", | 1116 "description": "Identifier of the st
udent submission.", |
1239 "location": "path", | 1117 "location": "path", |
1240 "required": true, | 1118 "required": true, |
1241 "type": "string" | 1119 "type": "string" |
1242 }, | |
1243 "updateMask": { | |
1244 "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`", | |
1245 "format": "google-fieldmask", | |
1246 "location": "query", | |
1247 "type": "string" | |
1248 } | 1120 } |
1249 }, | 1121 }, |
1250 "path": "v1/courses/{courseId}/courseWork/{c
ourseWorkId}/studentSubmissions/{id}", | 1122 "path": "v1/courses/{courseId}/courseWork/{c
ourseWorkId}/studentSubmissions/{id}", |
1251 "request": { | 1123 "request": { |
1252 "$ref": "StudentSubmission" | 1124 "$ref": "StudentSubmission" |
1253 }, | 1125 }, |
1254 "response": { | 1126 "response": { |
1255 "$ref": "StudentSubmission" | 1127 "$ref": "StudentSubmission" |
1256 }, | 1128 }, |
1257 "scopes": [ | 1129 "scopes": [ |
(...skipping 44 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1302 "reclaim": { | 1174 "reclaim": { |
1303 "description": "Reclaims a student submissio
n on behalf of the student that owns it.\n\nReclaiming a student submission tran
sfers ownership of attached Drive\nfiles to the student and update the submissio
n state.\n\nOnly the student that owns the requested student submission may call
this\nmethod, and only for a student submission that has been turned in.\n\nThi
s 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 correspon
ding course work item.\n\nThis method returns the following error codes:\n\n* `P
ERMISSION_DENIED` if the requesting user is not permitted to access the\nrequest
ed course or course work, unsubmit the requested student submission,\nor for acc
ess errors.\n* `FAILED_PRECONDITION` if the student submission has not been turn
ed in.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the
requested course, course work, or student submission\ndoes not exist.", | 1175 "description": "Reclaims a student submissio
n on behalf of the student that owns it.\n\nReclaiming a student submission tran
sfers ownership of attached Drive\nfiles to the student and update the submissio
n state.\n\nOnly the student that owns the requested student submission may call
this\nmethod, and only for a student submission that has been turned in.\n\nThi
s 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 correspon
ding course work item.\n\nThis method returns the following error codes:\n\n* `P
ERMISSION_DENIED` if the requesting user is not permitted to access the\nrequest
ed course or course work, unsubmit the requested student submission,\nor for acc
ess errors.\n* `FAILED_PRECONDITION` if the student submission has not been turn
ed in.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the
requested course, course work, or student submission\ndoes not exist.", |
1304 "httpMethod": "POST", | 1176 "httpMethod": "POST", |
1305 "id": "classroom.courses.courseWork.studentS
ubmissions.reclaim", | 1177 "id": "classroom.courses.courseWork.studentS
ubmissions.reclaim", |
1306 "parameterOrder": [ | 1178 "parameterOrder": [ |
1307 "courseId", | 1179 "courseId", |
1308 "courseWorkId", | 1180 "courseWorkId", |
1309 "id" | 1181 "id" |
1310 ], | 1182 ], |
1311 "parameters": { | 1183 "parameters": { |
| 1184 "courseWorkId": { |
| 1185 "description": "Identifier of the co
urse work.", |
| 1186 "location": "path", |
| 1187 "required": true, |
| 1188 "type": "string" |
| 1189 }, |
1312 "courseId": { | 1190 "courseId": { |
1313 "description": "Identifier of the co
urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal
ias.", | 1191 "description": "Identifier of the co
urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal
ias.", |
1314 "location": "path", | 1192 "location": "path", |
1315 "required": true, | 1193 "required": true, |
1316 "type": "string" | 1194 "type": "string" |
1317 }, | 1195 }, |
1318 "id": { | 1196 "id": { |
1319 "description": "Identifier of the st
udent submission.", | 1197 "description": "Identifier of the st
udent submission.", |
1320 "location": "path", | 1198 "location": "path", |
1321 "required": true, | 1199 "required": true, |
1322 "type": "string" | 1200 "type": "string" |
1323 }, | |
1324 "courseWorkId": { | |
1325 "description": "Identifier of the co
urse work.", | |
1326 "location": "path", | |
1327 "required": true, | |
1328 "type": "string" | |
1329 } | 1201 } |
1330 }, | 1202 }, |
1331 "path": "v1/courses/{courseId}/courseWork/{c
ourseWorkId}/studentSubmissions/{id}:reclaim", | 1203 "path": "v1/courses/{courseId}/courseWork/{c
ourseWorkId}/studentSubmissions/{id}:reclaim", |
1332 "request": { | 1204 "request": { |
1333 "$ref": "ReclaimStudentSubmissionRequest
" | 1205 "$ref": "ReclaimStudentSubmissionRequest
" |
1334 }, | 1206 }, |
1335 "response": { | 1207 "response": { |
1336 "$ref": "Empty" | 1208 "$ref": "Empty" |
1337 }, | 1209 }, |
1338 "scopes": [ | 1210 "scopes": [ |
1339 "https://www.googleapis.com/auth/classro
om.coursework.me" | 1211 "https://www.googleapis.com/auth/classro
om.coursework.me" |
1340 ] | 1212 ] |
1341 }, | 1213 }, |
1342 "turnIn": { | 1214 "turnIn": { |
1343 "description": "Turns in a student submissio
n.\n\nTurning in a student submission transfers ownership of attached Drive\nfil
es to the teacher and may also update the submission state.\n\nThis may only be
called by the student that owns the specified student\nsubmission.\n\nThis reque
st 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 co
urse work item.\n\nThis method returns the following error codes:\n\n* `PERMISSI
ON_DENIED` if the requesting user is not permitted to access the\nrequested cour
se or course work, turn in the requested student submission,\nor for access erro
rs.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the req
uested course, course work, or student submission\ndoes not exist.", | 1215 "description": "Turns in a student submissio
n.\n\nTurning in a student submission transfers ownership of attached Drive\nfil
es to the teacher and may also update the submission state.\n\nThis may only be
called by the student that owns the specified student\nsubmission.\n\nThis reque
st 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 co
urse work item.\n\nThis method returns the following error codes:\n\n* `PERMISSI
ON_DENIED` if the requesting user is not permitted to access the\nrequested cour
se or course work, turn in the requested student submission,\nor for access erro
rs.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the req
uested course, course work, or student submission\ndoes not exist.", |
1344 "httpMethod": "POST", | 1216 "httpMethod": "POST", |
1345 "id": "classroom.courses.courseWork.studentS
ubmissions.turnIn", | 1217 "id": "classroom.courses.courseWork.studentS
ubmissions.turnIn", |
1346 "parameterOrder": [ | 1218 "parameterOrder": [ |
1347 "courseId", | 1219 "courseId", |
1348 "courseWorkId", | 1220 "courseWorkId", |
1349 "id" | 1221 "id" |
1350 ], | 1222 ], |
1351 "parameters": { | 1223 "parameters": { |
| 1224 "courseWorkId": { |
| 1225 "description": "Identifier of the co
urse work.", |
| 1226 "location": "path", |
| 1227 "required": true, |
| 1228 "type": "string" |
| 1229 }, |
1352 "courseId": { | 1230 "courseId": { |
1353 "description": "Identifier of the co
urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal
ias.", | 1231 "description": "Identifier of the co
urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal
ias.", |
1354 "location": "path", | 1232 "location": "path", |
1355 "required": true, | 1233 "required": true, |
1356 "type": "string" | 1234 "type": "string" |
1357 }, | 1235 }, |
1358 "id": { | 1236 "id": { |
1359 "description": "Identifier of the st
udent submission.", | 1237 "description": "Identifier of the st
udent submission.", |
1360 "location": "path", | 1238 "location": "path", |
1361 "required": true, | 1239 "required": true, |
1362 "type": "string" | 1240 "type": "string" |
1363 }, | |
1364 "courseWorkId": { | |
1365 "description": "Identifier of the co
urse work.", | |
1366 "location": "path", | |
1367 "required": true, | |
1368 "type": "string" | |
1369 } | 1241 } |
1370 }, | 1242 }, |
1371 "path": "v1/courses/{courseId}/courseWork/{c
ourseWorkId}/studentSubmissions/{id}:turnIn", | 1243 "path": "v1/courses/{courseId}/courseWork/{c
ourseWorkId}/studentSubmissions/{id}:turnIn", |
1372 "request": { | 1244 "request": { |
1373 "$ref": "TurnInStudentSubmissionRequest" | 1245 "$ref": "TurnInStudentSubmissionRequest" |
1374 }, | 1246 }, |
1375 "response": { | 1247 "response": { |
1376 "$ref": "Empty" | 1248 "$ref": "Empty" |
1377 }, | 1249 }, |
1378 "scopes": [ | 1250 "scopes": [ |
(...skipping 43 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1422 }, | 1294 }, |
1423 "list": { | 1295 "list": { |
1424 "description": "Returns a list of student su
bmissions that the requester is permitted to\nview, factoring in the OAuth scope
s of the request.\n`-` may be specified as the `course_work_id` to include stude
nt\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 m
alformed.\n* `NOT_FOUND` if the requested course does not exist.", | 1296 "description": "Returns a list of student su
bmissions that the requester is permitted to\nview, factoring in the OAuth scope
s of the request.\n`-` may be specified as the `course_work_id` to include stude
nt\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 m
alformed.\n* `NOT_FOUND` if the requested course does not exist.", |
1425 "httpMethod": "GET", | 1297 "httpMethod": "GET", |
1426 "id": "classroom.courses.courseWork.studentS
ubmissions.list", | 1298 "id": "classroom.courses.courseWork.studentS
ubmissions.list", |
1427 "parameterOrder": [ | 1299 "parameterOrder": [ |
1428 "courseId", | 1300 "courseId", |
1429 "courseWorkId" | 1301 "courseWorkId" |
1430 ], | 1302 ], |
1431 "parameters": { | 1303 "parameters": { |
| 1304 "late": { |
| 1305 "description": "Requested lateness v
alue. If specified, returned student submissions are\nrestricted by the requeste
d value.\nIf unspecified, submissions are returned regardless of `late` value.", |
| 1306 "enum": [ |
| 1307 "LATE_VALUES_UNSPECIFIED", |
| 1308 "LATE_ONLY", |
| 1309 "NOT_LATE_ONLY" |
| 1310 ], |
| 1311 "location": "query", |
| 1312 "type": "string" |
| 1313 }, |
1432 "pageToken": { | 1314 "pageToken": { |
1433 "description": "nextPageToken\nvalue
returned from a previous\nlist call,\nindicating that the subsequent page of re
sults should be returned.\n\nThe list request\nmust be otherwise identical to th
e one that resulted in this token.", | 1315 "description": "nextPageToken\nvalue
returned from a previous\nlist call,\nindicating that the subsequent page of re
sults should be returned.\n\nThe list request\nmust be otherwise identical to th
e one that resulted in this token.", |
1434 "location": "query", | 1316 "location": "query", |
1435 "type": "string" | 1317 "type": "string" |
1436 }, | 1318 }, |
1437 "pageSize": { | |
1438 "description": "Maximum number of it
ems to return. Zero or unspecified indicates that the\nserver may assign a maxim
um.\n\nThe server may return fewer than the specified number of results.", | |
1439 "format": "int32", | |
1440 "location": "query", | |
1441 "type": "integer" | |
1442 }, | |
1443 "states": { | 1319 "states": { |
1444 "description": "Requested submission
states. If specified, returned student submissions\nmatch one of the specified
submission states.", | 1320 "description": "Requested submission
states. If specified, returned student submissions\nmatch one of the specified
submission states.", |
1445 "enum": [ | 1321 "enum": [ |
1446 "SUBMISSION_STATE_UNSPECIFIED", | 1322 "SUBMISSION_STATE_UNSPECIFIED", |
1447 "NEW", | 1323 "NEW", |
1448 "CREATED", | 1324 "CREATED", |
1449 "TURNED_IN", | 1325 "TURNED_IN", |
1450 "RETURNED", | 1326 "RETURNED", |
1451 "RECLAIMED_BY_STUDENT" | 1327 "RECLAIMED_BY_STUDENT" |
1452 ], | 1328 ], |
1453 "location": "query", | 1329 "location": "query", |
1454 "repeated": true, | 1330 "repeated": true, |
1455 "type": "string" | 1331 "type": "string" |
1456 }, | 1332 }, |
| 1333 "pageSize": { |
| 1334 "description": "Maximum number of it
ems to return. Zero or unspecified indicates that the\nserver may assign a maxim
um.\n\nThe server may return fewer than the specified number of results.", |
| 1335 "format": "int32", |
| 1336 "location": "query", |
| 1337 "type": "integer" |
| 1338 }, |
1457 "userId": { | 1339 "userId": { |
1458 "description": "Optional argument to
restrict returned student work to those owned by the\nstudent with the specifie
d identifier. The identifier can be one of the\nfollowing:\n\n* the numeric iden
tifier for the user\n* the email address of the user\n* the string literal `\"me
\"`, indicating the requesting user", | 1340 "description": "Optional argument to
restrict returned student work to those owned by the\nstudent with the specifie
d identifier. The identifier can be one of the\nfollowing:\n\n* the numeric iden
tifier for the user\n* the email address of the user\n* the string literal `\"me
\"`, indicating the requesting user", |
1459 "location": "query", | 1341 "location": "query", |
1460 "type": "string" | 1342 "type": "string" |
1461 }, | 1343 }, |
1462 "courseWorkId": { | 1344 "courseWorkId": { |
1463 "description": "Identifer of the stu
dent work to request.\nThis may be set to the string literal `\"-\"` to request
student work for\nall course work in the specified course.", | 1345 "description": "Identifer of the stu
dent work to request.\nThis may be set to the string literal `\"-\"` to request
student work for\nall course work in the specified course.", |
1464 "location": "path", | 1346 "location": "path", |
1465 "required": true, | 1347 "required": true, |
1466 "type": "string" | 1348 "type": "string" |
1467 }, | 1349 }, |
1468 "courseId": { | 1350 "courseId": { |
1469 "description": "Identifier of the co
urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal
ias.", | 1351 "description": "Identifier of the co
urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal
ias.", |
1470 "location": "path", | 1352 "location": "path", |
1471 "required": true, | 1353 "required": true, |
1472 "type": "string" | 1354 "type": "string" |
1473 }, | |
1474 "late": { | |
1475 "description": "Requested lateness v
alue. If specified, returned student submissions are\nrestricted by the requeste
d value.\nIf unspecified, submissions are returned regardless of `late` value.", | |
1476 "enum": [ | |
1477 "LATE_VALUES_UNSPECIFIED", | |
1478 "LATE_ONLY", | |
1479 "NOT_LATE_ONLY" | |
1480 ], | |
1481 "location": "query", | |
1482 "type": "string" | |
1483 } | 1355 } |
1484 }, | 1356 }, |
1485 "path": "v1/courses/{courseId}/courseWork/{c
ourseWorkId}/studentSubmissions", | 1357 "path": "v1/courses/{courseId}/courseWork/{c
ourseWorkId}/studentSubmissions", |
1486 "response": { | 1358 "response": { |
1487 "$ref": "ListStudentSubmissionsResponse" | 1359 "$ref": "ListStudentSubmissionsResponse" |
1488 }, | 1360 }, |
1489 "scopes": [ | 1361 "scopes": [ |
1490 "https://www.googleapis.com/auth/classro
om.coursework.me", | 1362 "https://www.googleapis.com/auth/classro
om.coursework.me", |
1491 "https://www.googleapis.com/auth/classro
om.coursework.me.readonly", | 1363 "https://www.googleapis.com/auth/classro
om.coursework.me.readonly", |
1492 "https://www.googleapis.com/auth/classro
om.coursework.students", | 1364 "https://www.googleapis.com/auth/classro
om.coursework.students", |
(...skipping 10 matching lines...) Expand all Loading... |
1503 "methods": { | 1375 "methods": { |
1504 "delete": { | 1376 "delete": { |
1505 "description": "Deletes a teacher of a course.\n\nTh
is method returns the following error codes:\n\n* `PERMISSION_DENIED` if the req
uesting user is not permitted to delete\nteachers of this course or for access e
rrors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if th
e\ncourse does not exist.\n* `FAILED_PRECONDITION` if the requested ID belongs t
o the primary teacher\nof this course.", | 1377 "description": "Deletes a teacher of a course.\n\nTh
is method returns the following error codes:\n\n* `PERMISSION_DENIED` if the req
uesting user is not permitted to delete\nteachers of this course or for access e
rrors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if th
e\ncourse does not exist.\n* `FAILED_PRECONDITION` if the requested ID belongs t
o the primary teacher\nof this course.", |
1506 "httpMethod": "DELETE", | 1378 "httpMethod": "DELETE", |
1507 "id": "classroom.courses.teachers.delete", | 1379 "id": "classroom.courses.teachers.delete", |
1508 "parameterOrder": [ | 1380 "parameterOrder": [ |
1509 "courseId", | 1381 "courseId", |
1510 "userId" | 1382 "userId" |
1511 ], | 1383 ], |
1512 "parameters": { | 1384 "parameters": { |
| 1385 "courseId": { |
| 1386 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", |
| 1387 "location": "path", |
| 1388 "required": true, |
| 1389 "type": "string" |
| 1390 }, |
1513 "userId": { | 1391 "userId": { |
1514 "description": "Identifier of the teacher to
delete. The identifier can be one of the\nfollowing:\n\n* the numeric identifie
r for the user\n* the email address of the user\n* the string literal `\"me\"`,
indicating the requesting user", | 1392 "description": "Identifier of the teacher to
delete. The identifier can be one of the\nfollowing:\n\n* the numeric identifie
r for the user\n* the email address of the user\n* the string literal `\"me\"`,
indicating the requesting user", |
1515 "location": "path", | 1393 "location": "path", |
1516 "required": true, | 1394 "required": true, |
1517 "type": "string" | 1395 "type": "string" |
1518 }, | |
1519 "courseId": { | |
1520 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", | |
1521 "location": "path", | |
1522 "required": true, | |
1523 "type": "string" | |
1524 } | 1396 } |
1525 }, | 1397 }, |
1526 "path": "v1/courses/{courseId}/teachers/{userId}", | 1398 "path": "v1/courses/{courseId}/teachers/{userId}", |
1527 "response": { | 1399 "response": { |
1528 "$ref": "Empty" | 1400 "$ref": "Empty" |
1529 }, | 1401 }, |
1530 "scopes": [ | 1402 "scopes": [ |
1531 "https://www.googleapis.com/auth/classroom.roste
rs" | 1403 "https://www.googleapis.com/auth/classroom.roste
rs" |
1532 ] | 1404 ] |
1533 }, | 1405 }, |
1534 "list": { | 1406 "list": { |
1535 "description": "Returns a list of teachers of this c
ourse that the requester\nis permitted to view.\n\nThis method returns the follo
wing error codes:\n\n* `NOT_FOUND` if the course does not exist.\n* `PERMISSION_
DENIED` for access errors.", | 1407 "description": "Returns a list of teachers of this c
ourse that the requester\nis permitted to view.\n\nThis method returns the follo
wing error codes:\n\n* `NOT_FOUND` if the course does not exist.\n* `PERMISSION_
DENIED` for access errors.", |
1536 "httpMethod": "GET", | 1408 "httpMethod": "GET", |
1537 "id": "classroom.courses.teachers.list", | 1409 "id": "classroom.courses.teachers.list", |
1538 "parameterOrder": [ | 1410 "parameterOrder": [ |
1539 "courseId" | 1411 "courseId" |
1540 ], | 1412 ], |
1541 "parameters": { | 1413 "parameters": { |
1542 "courseId": { | |
1543 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", | |
1544 "location": "path", | |
1545 "required": true, | |
1546 "type": "string" | |
1547 }, | |
1548 "pageToken": { | 1414 "pageToken": { |
1549 "description": "nextPageToken\nvalue returne
d from a previous\nlist call, indicating that\nthe subsequent page of results sh
ould be returned.\n\nThe list request must be\notherwise identical to the one th
at resulted in this token.", | 1415 "description": "nextPageToken\nvalue returne
d from a previous\nlist call, indicating that\nthe subsequent page of results sh
ould be returned.\n\nThe list request must be\notherwise identical to the one th
at resulted in this token.", |
1550 "location": "query", | 1416 "location": "query", |
1551 "type": "string" | 1417 "type": "string" |
1552 }, | 1418 }, |
1553 "pageSize": { | 1419 "pageSize": { |
1554 "description": "Maximum number of items to r
eturn. Zero means no maximum.\n\nThe server may return fewer than the specified
number of results.", | 1420 "description": "Maximum number of items to r
eturn. Zero means no maximum.\n\nThe server may return fewer than the specified
number of results.", |
1555 "format": "int32", | 1421 "format": "int32", |
1556 "location": "query", | 1422 "location": "query", |
1557 "type": "integer" | 1423 "type": "integer" |
| 1424 }, |
| 1425 "courseId": { |
| 1426 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", |
| 1427 "location": "path", |
| 1428 "required": true, |
| 1429 "type": "string" |
1558 } | 1430 } |
1559 }, | 1431 }, |
1560 "path": "v1/courses/{courseId}/teachers", | 1432 "path": "v1/courses/{courseId}/teachers", |
1561 "response": { | 1433 "response": { |
1562 "$ref": "ListTeachersResponse" | 1434 "$ref": "ListTeachersResponse" |
1563 }, | 1435 }, |
1564 "scopes": [ | 1436 "scopes": [ |
1565 "https://www.googleapis.com/auth/classroom.profi
le.emails", | 1437 "https://www.googleapis.com/auth/classroom.profi
le.emails", |
1566 "https://www.googleapis.com/auth/classroom.profi
le.photos", | 1438 "https://www.googleapis.com/auth/classroom.profi
le.photos", |
1567 "https://www.googleapis.com/auth/classroom.roste
rs", | 1439 "https://www.googleapis.com/auth/classroom.roste
rs", |
1568 "https://www.googleapis.com/auth/classroom.roste
rs.readonly" | 1440 "https://www.googleapis.com/auth/classroom.roste
rs.readonly" |
1569 ] | 1441 ] |
1570 }, | 1442 }, |
1571 "get": { | 1443 "get": { |
1572 "description": "Returns a teacher of a course.\n\nTh
is method returns the following error codes:\n\n* `PERMISSION_DENIED` if the req
uesting user is not permitted to view\nteachers of this course or for access err
ors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if the\
ncourse does not exist.", | 1444 "description": "Returns a teacher of a course.\n\nTh
is method returns the following error codes:\n\n* `PERMISSION_DENIED` if the req
uesting user is not permitted to view\nteachers of this course or for access err
ors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if the\
ncourse does not exist.", |
1573 "httpMethod": "GET", | 1445 "httpMethod": "GET", |
1574 "id": "classroom.courses.teachers.get", | 1446 "id": "classroom.courses.teachers.get", |
1575 "parameterOrder": [ | 1447 "parameterOrder": [ |
1576 "courseId", | 1448 "courseId", |
1577 "userId" | 1449 "userId" |
1578 ], | 1450 ], |
1579 "parameters": { | 1451 "parameters": { |
| 1452 "courseId": { |
| 1453 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", |
| 1454 "location": "path", |
| 1455 "required": true, |
| 1456 "type": "string" |
| 1457 }, |
1580 "userId": { | 1458 "userId": { |
1581 "description": "Identifier of the teacher to
return. The identifier can be one of the\nfollowing:\n\n* the numeric identifie
r for the user\n* the email address of the user\n* the string literal `\"me\"`,
indicating the requesting user", | 1459 "description": "Identifier of the teacher to
return. The identifier can be one of the\nfollowing:\n\n* the numeric identifie
r for the user\n* the email address of the user\n* the string literal `\"me\"`,
indicating the requesting user", |
1582 "location": "path", | 1460 "location": "path", |
1583 "required": true, | 1461 "required": true, |
1584 "type": "string" | 1462 "type": "string" |
1585 }, | |
1586 "courseId": { | |
1587 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", | |
1588 "location": "path", | |
1589 "required": true, | |
1590 "type": "string" | |
1591 } | 1463 } |
1592 }, | 1464 }, |
1593 "path": "v1/courses/{courseId}/teachers/{userId}", | 1465 "path": "v1/courses/{courseId}/teachers/{userId}", |
1594 "response": { | 1466 "response": { |
1595 "$ref": "Teacher" | 1467 "$ref": "Teacher" |
1596 }, | 1468 }, |
1597 "scopes": [ | 1469 "scopes": [ |
1598 "https://www.googleapis.com/auth/classroom.profi
le.emails", | 1470 "https://www.googleapis.com/auth/classroom.profi
le.emails", |
1599 "https://www.googleapis.com/auth/classroom.profi
le.photos", | 1471 "https://www.googleapis.com/auth/classroom.profi
le.photos", |
1600 "https://www.googleapis.com/auth/classroom.roste
rs", | 1472 "https://www.googleapis.com/auth/classroom.roste
rs", |
(...skipping 24 matching lines...) Expand all Loading... |
1625 }, | 1497 }, |
1626 "scopes": [ | 1498 "scopes": [ |
1627 "https://www.googleapis.com/auth/classroom.profi
le.emails", | 1499 "https://www.googleapis.com/auth/classroom.profi
le.emails", |
1628 "https://www.googleapis.com/auth/classroom.profi
le.photos", | 1500 "https://www.googleapis.com/auth/classroom.profi
le.photos", |
1629 "https://www.googleapis.com/auth/classroom.roste
rs" | 1501 "https://www.googleapis.com/auth/classroom.roste
rs" |
1630 ] | 1502 ] |
1631 } | 1503 } |
1632 } | 1504 } |
1633 } | 1505 } |
1634 } | 1506 } |
| 1507 }, |
| 1508 "invitations": { |
| 1509 "methods": { |
| 1510 "list": { |
| 1511 "description": "Returns a list of invitations that the reque
sting user is permitted to\nview, restricted to those that match the list reques
t.\n\n*Note:* At least one of `user_id` or `course_id` must be supplied. Both\nf
ields can be supplied.\n\nThis method returns the following error codes:\n\n* `P
ERMISSION_DENIED` for access errors.", |
| 1512 "httpMethod": "GET", |
| 1513 "id": "classroom.invitations.list", |
| 1514 "parameterOrder": [], |
| 1515 "parameters": { |
| 1516 "pageToken": { |
| 1517 "description": "nextPageToken\nvalue returned from a
previous\nlist call, indicating\nthat the subsequent page of results should be
returned.\n\nThe list request must be\notherwise identical to the one that resul
ted in this token.", |
| 1518 "location": "query", |
| 1519 "type": "string" |
| 1520 }, |
| 1521 "userId": { |
| 1522 "description": "Restricts returned invitations to th
ose for a specific user. The identifier\ncan be one of the following:\n\n* the n
umeric identifier for the user\n* the email address of the user\n* the string li
teral `\"me\"`, indicating the requesting user", |
| 1523 "location": "query", |
| 1524 "type": "string" |
| 1525 }, |
| 1526 "pageSize": { |
| 1527 "description": "Maximum number of items to return. Z
ero means no maximum.\n\nThe server may return fewer than the specified number o
f results.", |
| 1528 "format": "int32", |
| 1529 "location": "query", |
| 1530 "type": "integer" |
| 1531 }, |
| 1532 "courseId": { |
| 1533 "description": "Restricts returned invitations to th
ose for a course with the specified\nidentifier.", |
| 1534 "location": "query", |
| 1535 "type": "string" |
| 1536 } |
| 1537 }, |
| 1538 "path": "v1/invitations", |
| 1539 "response": { |
| 1540 "$ref": "ListInvitationsResponse" |
| 1541 }, |
| 1542 "scopes": [ |
| 1543 "https://www.googleapis.com/auth/classroom.rosters", |
| 1544 "https://www.googleapis.com/auth/classroom.rosters.reado
nly" |
| 1545 ] |
| 1546 }, |
| 1547 "get": { |
| 1548 "description": "Returns an invitation.\n\nThis method return
s the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is
not permitted to view the\nrequested invitation or for access errors.\n* `NOT_FO
UND` if no invitation exists with the requested ID.", |
| 1549 "httpMethod": "GET", |
| 1550 "id": "classroom.invitations.get", |
| 1551 "parameterOrder": [ |
| 1552 "id" |
| 1553 ], |
| 1554 "parameters": { |
| 1555 "id": { |
| 1556 "description": "Identifier of the invitation to retu
rn.", |
| 1557 "location": "path", |
| 1558 "required": true, |
| 1559 "type": "string" |
| 1560 } |
| 1561 }, |
| 1562 "path": "v1/invitations/{id}", |
| 1563 "response": { |
| 1564 "$ref": "Invitation" |
| 1565 }, |
| 1566 "scopes": [ |
| 1567 "https://www.googleapis.com/auth/classroom.rosters", |
| 1568 "https://www.googleapis.com/auth/classroom.rosters.reado
nly" |
| 1569 ] |
| 1570 }, |
| 1571 "create": { |
| 1572 "description": "Creates an invitation. Only one invitation f
or a user and course may exist\nat a time. Delete and re-create an invitation to
make changes.\n\nThis method returns the following error codes:\n\n* `PERMISSIO
N_DENIED` if the requesting user is not permitted to create\ninvitations for thi
s course or for access errors.\n* `NOT_FOUND` if the course or the user does not
exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled or
if\nthe user already has this role or a role with greater permissions.\n* `ALREA
DY_EXISTS` if an invitation for the specified user and course\nalready exists.", |
| 1573 "httpMethod": "POST", |
| 1574 "id": "classroom.invitations.create", |
| 1575 "parameterOrder": [], |
| 1576 "parameters": {}, |
| 1577 "path": "v1/invitations", |
| 1578 "request": { |
| 1579 "$ref": "Invitation" |
| 1580 }, |
| 1581 "response": { |
| 1582 "$ref": "Invitation" |
| 1583 }, |
| 1584 "scopes": [ |
| 1585 "https://www.googleapis.com/auth/classroom.rosters" |
| 1586 ] |
| 1587 }, |
| 1588 "accept": { |
| 1589 "description": "Accepts an invitation, removing it and addin
g the invited user to the\nteachers or students (as appropriate) of the specifie
d course. Only the\ninvited user may accept an invitation.\n\nThis method return
s the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is
not permitted to accept the\nrequested invitation or for access errors.\n* `FAIL
ED_PRECONDITION` for the following request errors:\n * CourseMemberLimitReach
ed\n * CourseNotModifiable\n * CourseTeacherLimitReached\n * UserGroups
MembershipLimitReached\n* `NOT_FOUND` if no invitation exists with the requested
ID.", |
| 1590 "httpMethod": "POST", |
| 1591 "id": "classroom.invitations.accept", |
| 1592 "parameterOrder": [ |
| 1593 "id" |
| 1594 ], |
| 1595 "parameters": { |
| 1596 "id": { |
| 1597 "description": "Identifier of the invitation to acce
pt.", |
| 1598 "location": "path", |
| 1599 "required": true, |
| 1600 "type": "string" |
| 1601 } |
| 1602 }, |
| 1603 "path": "v1/invitations/{id}:accept", |
| 1604 "response": { |
| 1605 "$ref": "Empty" |
| 1606 }, |
| 1607 "scopes": [ |
| 1608 "https://www.googleapis.com/auth/classroom.rosters" |
| 1609 ] |
| 1610 }, |
| 1611 "delete": { |
| 1612 "description": "Deletes an invitation.\n\nThis method return
s 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.", |
| 1613 "httpMethod": "DELETE", |
| 1614 "id": "classroom.invitations.delete", |
| 1615 "parameterOrder": [ |
| 1616 "id" |
| 1617 ], |
| 1618 "parameters": { |
| 1619 "id": { |
| 1620 "description": "Identifier of the invitation to dele
te.", |
| 1621 "location": "path", |
| 1622 "required": true, |
| 1623 "type": "string" |
| 1624 } |
| 1625 }, |
| 1626 "path": "v1/invitations/{id}", |
| 1627 "response": { |
| 1628 "$ref": "Empty" |
| 1629 }, |
| 1630 "scopes": [ |
| 1631 "https://www.googleapis.com/auth/classroom.rosters" |
| 1632 ] |
| 1633 } |
| 1634 } |
1635 } | 1635 } |
1636 }, | 1636 }, |
1637 "revision": "20170705", | 1637 "revision": "20170727", |
1638 "rootUrl": "https://classroom.googleapis.com/", | 1638 "rootUrl": "https://classroom.googleapis.com/", |
1639 "schemas": { | 1639 "schemas": { |
| 1640 "Empty": { |
| 1641 "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 i
t as the request\nor the response type of an API method. For instance:\n\n se
rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty
);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", |
| 1642 "id": "Empty", |
| 1643 "properties": {}, |
| 1644 "type": "object" |
| 1645 }, |
| 1646 "MultipleChoiceQuestion": { |
| 1647 "description": "Additional details for multiple-choice questions.", |
| 1648 "id": "MultipleChoiceQuestion", |
| 1649 "properties": { |
| 1650 "choices": { |
| 1651 "description": "Possible choices.", |
| 1652 "items": { |
| 1653 "type": "string" |
| 1654 }, |
| 1655 "type": "array" |
| 1656 } |
| 1657 }, |
| 1658 "type": "object" |
| 1659 }, |
| 1660 "Course": { |
| 1661 "description": "A Course in Classroom.", |
| 1662 "id": "Course", |
| 1663 "properties": { |
| 1664 "teacherFolder": { |
| 1665 "$ref": "DriveFolder", |
| 1666 "description": "Information about a Drive Folder that is sha
red with all teachers of the\ncourse.\n\nThis field will only be set for teacher
s of the course and domain administrators.\n\nRead-only." |
| 1667 }, |
| 1668 "name": { |
| 1669 "description": "Name of the course.\nFor example, \"10th Gra
de Biology\".\nThe name is required. It must be between 1 and 750 characters and
a valid\nUTF-8 string.", |
| 1670 "type": "string" |
| 1671 }, |
| 1672 "section": { |
| 1673 "description": "Section of the course.\nFor example, \"Perio
d 2\".\nIf set, this field must be a valid UTF-8 string and no longer than 2800\
ncharacters.", |
| 1674 "type": "string" |
| 1675 }, |
| 1676 "id": { |
| 1677 "description": "Identifier for this course assigned by Class
room.\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\nSp
ecifying this field in a course update mask results in an error.", |
| 1678 "type": "string" |
| 1679 }, |
| 1680 "room": { |
| 1681 "description": "Optional room location.\nFor example, \"301\
".\nIf set, this field must be a valid UTF-8 string and no longer than 650\nchar
acters.", |
| 1682 "type": "string" |
| 1683 }, |
| 1684 "courseGroupEmail": { |
| 1685 "description": "The email address of a Google group containi
ng all members of the course.\nThis group does not accept email and can only be
used for permissions.\n\nRead-only.", |
| 1686 "type": "string" |
| 1687 }, |
| 1688 "enrollmentCode": { |
| 1689 "description": "Enrollment code to use when joining this cou
rse.\nSpecifying this field in a course update mask results in an error.\n\nRead
-only.", |
| 1690 "type": "string" |
| 1691 }, |
| 1692 "courseMaterialSets": { |
| 1693 "description": "Sets of materials that appear on the \"about
\" page of this course.\n\nRead-only.", |
| 1694 "items": { |
| 1695 "$ref": "CourseMaterialSet" |
| 1696 }, |
| 1697 "type": "array" |
| 1698 }, |
| 1699 "descriptionHeading": { |
| 1700 "description": "Optional heading for the description.\nFor e
xample, \"Welcome to 10th Grade Biology.\"\nIf set, this field must be a valid U
TF-8 string and no longer than 3600\ncharacters.", |
| 1701 "type": "string" |
| 1702 }, |
| 1703 "updateTime": { |
| 1704 "description": "Time of the most recent update to this cours
e.\nSpecifying this field in a course update mask results in an error.\n\nRead-o
nly.", |
| 1705 "format": "google-datetime", |
| 1706 "type": "string" |
| 1707 }, |
| 1708 "calendarId": { |
| 1709 "description": "The Calendar ID for a calendar that all cour
se members can see, to which\nClassroom adds events for course work and announce
ments in the course.\n\nRead-only.", |
| 1710 "type": "string" |
| 1711 }, |
| 1712 "alternateLink": { |
| 1713 "description": "Absolute link to this course in the Classroo
m web UI.\n\nRead-only.", |
| 1714 "type": "string" |
| 1715 }, |
| 1716 "guardiansEnabled": { |
| 1717 "description": "Whether or not guardian notifications are en
abled for this course.\n\nRead-only.", |
| 1718 "type": "boolean" |
| 1719 }, |
| 1720 "courseState": { |
| 1721 "description": "State of the course.\nIf unspecified, the de
fault state is `PROVISIONED`.", |
| 1722 "enum": [ |
| 1723 "COURSE_STATE_UNSPECIFIED", |
| 1724 "ACTIVE", |
| 1725 "ARCHIVED", |
| 1726 "PROVISIONED", |
| 1727 "DECLINED", |
| 1728 "SUSPENDED" |
| 1729 ], |
| 1730 "enumDescriptions": [ |
| 1731 "No course state. No returned Course message will use th
is value.", |
| 1732 "The course is active.", |
| 1733 "The course has been archived. You cannot modify it exce
pt to change it\nto a different state.", |
| 1734 "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 cha
nged to `PROVISIONED` if it is in the `DECLINED`\nstate.", |
| 1735 "The course has been created, but declined. It is access
ible by the\ncourse owner and domain administrators, though it will not be\ndisp
layed in the web UI. You cannot modify the course except to change it\nto the `P
ROVISIONED` state.\nA course may only be changed to `DECLINED` if it is in the `
PROVISIONED`\nstate.", |
| 1736 "The course has been suspended. You cannot modify the co
urse, and only the\nuser identified by the `owner_id` can view the course.\nA co
urse may be placed in this state if it potentially violates the\nTerms of Servic
e." |
| 1737 ], |
| 1738 "type": "string" |
| 1739 }, |
| 1740 "ownerId": { |
| 1741 "description": "The identifier of the owner of a course.\n\n
When specified as a parameter of a\ncreate course request, this\nfield is requir
ed.\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\"`, indic
ating the requesting user\n\nThis must be set in a create request. Specifying th
is field in a course\nupdate mask results in an `INVALID_ARGUMENT` error.", |
| 1742 "type": "string" |
| 1743 }, |
| 1744 "description": { |
| 1745 "description": "Optional description.\nFor example, \"We'll
be learning about the structure of living\ncreatures from a combination of textb
ooks, 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.", |
| 1746 "type": "string" |
| 1747 }, |
| 1748 "teacherGroupEmail": { |
| 1749 "description": "The email address of a Google group containi
ng all teachers of the course.\nThis group does not accept email and can only be
used for permissions.\n\nRead-only.", |
| 1750 "type": "string" |
| 1751 }, |
| 1752 "creationTime": { |
| 1753 "description": "Creation time of the course.\nSpecifying thi
s field in a course update mask results in an error.\n\nRead-only.", |
| 1754 "format": "google-datetime", |
| 1755 "type": "string" |
| 1756 } |
| 1757 }, |
| 1758 "type": "object" |
| 1759 }, |
| 1760 "DriveFile": { |
| 1761 "description": "Representation of a Google Drive file.", |
| 1762 "id": "DriveFile", |
| 1763 "properties": { |
| 1764 "title": { |
| 1765 "description": "Title of the Drive item.\n\nRead-only.", |
| 1766 "type": "string" |
| 1767 }, |
| 1768 "alternateLink": { |
| 1769 "description": "URL that can be used to access the Drive ite
m.\n\nRead-only.", |
| 1770 "type": "string" |
| 1771 }, |
| 1772 "thumbnailUrl": { |
| 1773 "description": "URL of a thumbnail image of the Drive item.\
n\nRead-only.", |
| 1774 "type": "string" |
| 1775 }, |
| 1776 "id": { |
| 1777 "description": "Drive API resource ID.", |
| 1778 "type": "string" |
| 1779 } |
| 1780 }, |
| 1781 "type": "object" |
| 1782 }, |
| 1783 "GlobalPermission": { |
| 1784 "description": "Global user permission description.", |
| 1785 "id": "GlobalPermission", |
| 1786 "properties": { |
| 1787 "permission": { |
| 1788 "description": "Permission value.", |
| 1789 "enum": [ |
| 1790 "PERMISSION_UNSPECIFIED", |
| 1791 "CREATE_COURSE" |
| 1792 ], |
| 1793 "enumDescriptions": [ |
| 1794 "No permission is specified. This is not returned and is
not a\nvalid value.", |
| 1795 "User is permitted to create a course." |
| 1796 ], |
| 1797 "type": "string" |
| 1798 } |
| 1799 }, |
| 1800 "type": "object" |
| 1801 }, |
| 1802 "ReturnStudentSubmissionRequest": { |
| 1803 "description": "Request to return a student submission.", |
| 1804 "id": "ReturnStudentSubmissionRequest", |
| 1805 "properties": {}, |
| 1806 "type": "object" |
| 1807 }, |
1640 "Teacher": { | 1808 "Teacher": { |
1641 "description": "Teacher of a course.", | 1809 "description": "Teacher of a course.", |
1642 "id": "Teacher", | 1810 "id": "Teacher", |
1643 "properties": { | 1811 "properties": { |
| 1812 "courseId": { |
| 1813 "description": "Identifier of the course.\n\nRead-only.", |
| 1814 "type": "string" |
| 1815 }, |
1644 "profile": { | 1816 "profile": { |
1645 "$ref": "UserProfile", | 1817 "$ref": "UserProfile", |
1646 "description": "Global user information for the teacher.\n\n
Read-only." | 1818 "description": "Global user information for the teacher.\n\n
Read-only." |
1647 }, | 1819 }, |
1648 "userId": { | 1820 "userId": { |
1649 "description": "Identifier of the user.\n\nWhen specified as
a parameter of a request, this identifier can be one of\nthe following:\n\n* th
e numeric identifier for the user\n* the email address of the user\n* the string
literal `\"me\"`, indicating the requesting user", | 1821 "description": "Identifier of the user.\n\nWhen specified as
a parameter of a request, this identifier can be one of\nthe following:\n\n* th
e numeric identifier for the user\n* the email address of the user\n* the string
literal `\"me\"`, indicating the requesting user", |
1650 "type": "string" | 1822 "type": "string" |
1651 }, | 1823 } |
1652 "courseId": { | 1824 }, |
1653 "description": "Identifier of the course.\n\nRead-only.", | 1825 "type": "object" |
1654 "type": "string" | 1826 }, |
1655 } | |
1656 }, | |
1657 "type": "object" | |
1658 }, | |
1659 "ReclaimStudentSubmissionRequest": { | 1827 "ReclaimStudentSubmissionRequest": { |
1660 "description": "Request to reclaim a student submission.", | 1828 "description": "Request to reclaim a student submission.", |
1661 "id": "ReclaimStudentSubmissionRequest", | 1829 "id": "ReclaimStudentSubmissionRequest", |
1662 "properties": {}, | 1830 "properties": {}, |
1663 "type": "object" | 1831 "type": "object" |
1664 }, | 1832 }, |
1665 "AssignmentSubmission": { | 1833 "AssignmentSubmission": { |
1666 "description": "Student work for an assignment.", | 1834 "description": "Student work for an assignment.", |
1667 "id": "AssignmentSubmission", | 1835 "id": "AssignmentSubmission", |
1668 "properties": { | 1836 "properties": { |
(...skipping 27 matching lines...) Expand all Loading... |
1696 "$ref": "Link", | 1864 "$ref": "Link", |
1697 "description": "Link material. On creation, will be upgraded
to a more appropriate type\nif possible, and this will be reflected in the resp
onse." | 1865 "description": "Link material. On creation, will be upgraded
to a more appropriate type\nif possible, and this will be reflected in the resp
onse." |
1698 } | 1866 } |
1699 }, | 1867 }, |
1700 "type": "object" | 1868 "type": "object" |
1701 }, | 1869 }, |
1702 "CourseWork": { | 1870 "CourseWork": { |
1703 "description": "Course work created by a teacher for students of the
course.", | 1871 "description": "Course work created by a teacher for students of the
course.", |
1704 "id": "CourseWork", | 1872 "id": "CourseWork", |
1705 "properties": { | 1873 "properties": { |
| 1874 "associatedWithDeveloper": { |
| 1875 "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.", |
| 1876 "type": "boolean" |
| 1877 }, |
| 1878 "materials": { |
| 1879 "description": "Additional materials.\n\nCourseWork must hav
e no more than 20 material items.", |
| 1880 "items": { |
| 1881 "$ref": "Material" |
| 1882 }, |
| 1883 "type": "array" |
| 1884 }, |
| 1885 "updateTime": { |
| 1886 "description": "Timestamp of the most recent change to this
course work.\n\nRead-only.", |
| 1887 "format": "google-datetime", |
| 1888 "type": "string" |
| 1889 }, |
| 1890 "alternateLink": { |
| 1891 "description": "Absolute link to this course work in the Cla
ssroom web UI.\nThis is only populated if `state` is `PUBLISHED`.\n\nRead-only."
, |
| 1892 "type": "string" |
| 1893 }, |
1706 "maxPoints": { | 1894 "maxPoints": { |
1707 "description": "Maximum grade for this course work.\nIf zero
or unspecified, this assignment is considered ungraded.\nThis must be a non-neg
ative integer value.", | 1895 "description": "Maximum grade for this course work.\nIf zero
or unspecified, this assignment is considered ungraded.\nThis must be a non-neg
ative integer value.", |
1708 "format": "double", | 1896 "format": "double", |
1709 "type": "number" | 1897 "type": "number" |
1710 }, | 1898 }, |
1711 "multipleChoiceQuestion": { | 1899 "multipleChoiceQuestion": { |
1712 "$ref": "MultipleChoiceQuestion", | 1900 "$ref": "MultipleChoiceQuestion", |
1713 "description": "Multiple choice question details.\nFor read
operations, this field is populated only when `work_type` is\n`MULTIPLE_CHOICE_Q
UESTION`.\nFor write operations, this field must be specified when creating cour
se\nwork with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be\ns
et otherwise." | 1901 "description": "Multiple choice question details.\nFor read
operations, this field is populated only when `work_type` is\n`MULTIPLE_CHOICE_Q
UESTION`.\nFor write operations, this field must be specified when creating cour
se\nwork with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be\ns
et otherwise." |
1714 }, | 1902 }, |
| 1903 "assignment": { |
| 1904 "$ref": "Assignment", |
| 1905 "description": "Assignment details.\nThis is populated only
when `work_type` is `ASSIGNMENT`.\n\nRead-only." |
| 1906 }, |
1715 "workType": { | 1907 "workType": { |
1716 "description": "Type of this course work.\n\nThe type is set
when the course work is created and cannot be changed.", | 1908 "description": "Type of this course work.\n\nThe type is set
when the course work is created and cannot be changed.", |
1717 "enum": [ | 1909 "enum": [ |
1718 "COURSE_WORK_TYPE_UNSPECIFIED", | 1910 "COURSE_WORK_TYPE_UNSPECIFIED", |
1719 "ASSIGNMENT", | 1911 "ASSIGNMENT", |
1720 "SHORT_ANSWER_QUESTION", | 1912 "SHORT_ANSWER_QUESTION", |
1721 "MULTIPLE_CHOICE_QUESTION" | 1913 "MULTIPLE_CHOICE_QUESTION" |
1722 ], | 1914 ], |
1723 "enumDescriptions": [ | 1915 "enumDescriptions": [ |
1724 "No work type specified. This is never returned.", | 1916 "No work type specified. This is never returned.", |
1725 "An assignment.", | 1917 "An assignment.", |
1726 "A short answer question.", | 1918 "A short answer question.", |
1727 "A multiple-choice question." | 1919 "A multiple-choice question." |
1728 ], | 1920 ], |
1729 "type": "string" | 1921 "type": "string" |
1730 }, | 1922 }, |
1731 "assignment": { | 1923 "description": { |
1732 "$ref": "Assignment", | 1924 "description": "Optional description of this course work.\nI
f set, the description must be a valid UTF-8 string containing no more\nthan 30,
000 characters.", |
1733 "description": "Assignment details.\nThis is populated only
when `work_type` is `ASSIGNMENT`.\n\nRead-only." | 1925 "type": "string" |
1734 }, | 1926 }, |
1735 "scheduledTime": { | 1927 "scheduledTime": { |
1736 "description": "Optional timestamp when this course work is
scheduled to be published.", | 1928 "description": "Optional timestamp when this course work is
scheduled to be published.", |
1737 "format": "google-datetime", | 1929 "format": "google-datetime", |
1738 "type": "string" | 1930 "type": "string" |
1739 }, | 1931 }, |
1740 "description": { | |
1741 "description": "Optional description of this course work.\nI
f set, the description must be a valid UTF-8 string containing no more\nthan 30,
000 characters.", | |
1742 "type": "string" | |
1743 }, | |
1744 "creationTime": { | 1932 "creationTime": { |
1745 "description": "Timestamp when this course work was created.
\n\nRead-only.", | 1933 "description": "Timestamp when this course work was created.
\n\nRead-only.", |
1746 "format": "google-datetime", | 1934 "format": "google-datetime", |
1747 "type": "string" | 1935 "type": "string" |
1748 }, | 1936 }, |
1749 "dueDate": { | 1937 "dueDate": { |
1750 "$ref": "Date", | 1938 "$ref": "Date", |
1751 "description": "Optional date, in UTC, that submissions for
this this course work are due.\nThis must be specified if `due_time` is specifie
d." | 1939 "description": "Optional date, in UTC, that submissions for
this this course work are due.\nThis must be specified if `due_time` is specifie
d." |
1752 }, | 1940 }, |
1753 "submissionModificationMode": { | 1941 "submissionModificationMode": { |
(...skipping 34 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1788 "description": "Classroom-assigned identifier of this course
work, unique per course.\n\nRead-only.", | 1976 "description": "Classroom-assigned identifier of this course
work, unique per course.\n\nRead-only.", |
1789 "type": "string" | 1977 "type": "string" |
1790 }, | 1978 }, |
1791 "dueTime": { | 1979 "dueTime": { |
1792 "$ref": "TimeOfDay", | 1980 "$ref": "TimeOfDay", |
1793 "description": "Optional time of day, in UTC, that submissio
ns for this this course work\nare due.\nThis must be specified if `due_date` is
specified." | 1981 "description": "Optional time of day, in UTC, that submissio
ns for this this course work\nare due.\nThis must be specified if `due_date` is
specified." |
1794 }, | 1982 }, |
1795 "title": { | 1983 "title": { |
1796 "description": "Title of this course work.\nThe title must b
e a valid UTF-8 string containing between 1 and 3000\ncharacters.", | 1984 "description": "Title of this course work.\nThe title must b
e a valid UTF-8 string containing between 1 and 3000\ncharacters.", |
1797 "type": "string" | 1985 "type": "string" |
1798 }, | |
1799 "associatedWithDeveloper": { | |
1800 "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.", | |
1801 "type": "boolean" | |
1802 }, | |
1803 "materials": { | |
1804 "description": "Additional materials.\n\nCourseWork must hav
e no more than 20 material items.", | |
1805 "items": { | |
1806 "$ref": "Material" | |
1807 }, | |
1808 "type": "array" | |
1809 }, | |
1810 "updateTime": { | |
1811 "description": "Timestamp of the most recent change to this
course work.\n\nRead-only.", | |
1812 "format": "google-datetime", | |
1813 "type": "string" | |
1814 }, | |
1815 "alternateLink": { | |
1816 "description": "Absolute link to this course work in the Cla
ssroom web UI.\nThis is only populated if `state` is `PUBLISHED`.\n\nRead-only."
, | |
1817 "type": "string" | |
1818 } | 1986 } |
1819 }, | 1987 }, |
1820 "type": "object" | 1988 "type": "object" |
1821 }, | 1989 }, |
1822 "Guardian": { | 1990 "Guardian": { |
1823 "description": "Association between a student and a guardian of that
student. The guardian\nmay receive information about the student's course work.
", | 1991 "description": "Association between a student and a guardian of that
student. The guardian\nmay receive information about the student's course work.
", |
1824 "id": "Guardian", | 1992 "id": "Guardian", |
1825 "properties": { | 1993 "properties": { |
1826 "studentId": { | 1994 "studentId": { |
1827 "description": "Identifier for the student to whom the guard
ian relationship applies.", | 1995 "description": "Identifier for the student to whom the guard
ian relationship applies.", |
1828 "type": "string" | 1996 "type": "string" |
1829 }, | 1997 }, |
1830 "invitedEmailAddress": { | 1998 "invitedEmailAddress": { |
1831 "description": "The email address to which the initial guard
ian invitation was sent.\nThis field is only visible to domain administrators.", | 1999 "description": "The email address to which the initial guard
ian invitation was sent.\nThis field is only visible to domain administrators.", |
1832 "type": "string" | 2000 "type": "string" |
1833 }, | 2001 }, |
1834 "guardianId": { | 2002 "guardianId": { |
1835 "description": "Identifier for the guardian.", | 2003 "description": "Identifier for the guardian.", |
1836 "type": "string" | 2004 "type": "string" |
1837 }, | 2005 }, |
1838 "guardianProfile": { | 2006 "guardianProfile": { |
1839 "$ref": "UserProfile", | 2007 "$ref": "UserProfile", |
1840 "description": "User profile for the guardian." | 2008 "description": "User profile for the guardian." |
1841 } | 2009 } |
1842 }, | 2010 }, |
1843 "type": "object" | 2011 "type": "object" |
1844 }, | 2012 }, |
1845 "ListStudentsResponse": { | |
1846 "description": "Response when listing students.", | |
1847 "id": "ListStudentsResponse", | |
1848 "properties": { | |
1849 "nextPageToken": { | |
1850 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", | |
1851 "type": "string" | |
1852 }, | |
1853 "students": { | |
1854 "description": "Students who match the list request.", | |
1855 "items": { | |
1856 "$ref": "Student" | |
1857 }, | |
1858 "type": "array" | |
1859 } | |
1860 }, | |
1861 "type": "object" | |
1862 }, | |
1863 "UserProfile": { | 2013 "UserProfile": { |
1864 "description": "Global information for a user.", | 2014 "description": "Global information for a user.", |
1865 "id": "UserProfile", | 2015 "id": "UserProfile", |
1866 "properties": { | 2016 "properties": { |
1867 "emailAddress": { | 2017 "emailAddress": { |
1868 "description": "Email address of the user.\n\nRead-only.", | 2018 "description": "Email address of the user.\n\nRead-only.", |
1869 "type": "string" | 2019 "type": "string" |
1870 }, | 2020 }, |
1871 "photoUrl": { | 2021 "photoUrl": { |
1872 "description": "URL of user's profile photo.\n\nRead-only.", | 2022 "description": "URL of user's profile photo.\n\nRead-only.", |
(...skipping 14 matching lines...) Expand all Loading... |
1887 "description": "Identifier of the user.\n\nRead-only.", | 2037 "description": "Identifier of the user.\n\nRead-only.", |
1888 "type": "string" | 2038 "type": "string" |
1889 }, | 2039 }, |
1890 "verifiedTeacher": { | 2040 "verifiedTeacher": { |
1891 "description": "Represents whether a G Suite for Education u
ser'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 wil
l always be false.\n\nRead-only", | 2041 "description": "Represents whether a G Suite for Education u
ser'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 wil
l always be false.\n\nRead-only", |
1892 "type": "boolean" | 2042 "type": "boolean" |
1893 } | 2043 } |
1894 }, | 2044 }, |
1895 "type": "object" | 2045 "type": "object" |
1896 }, | 2046 }, |
| 2047 "ListStudentsResponse": { |
| 2048 "description": "Response when listing students.", |
| 2049 "id": "ListStudentsResponse", |
| 2050 "properties": { |
| 2051 "nextPageToken": { |
| 2052 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", |
| 2053 "type": "string" |
| 2054 }, |
| 2055 "students": { |
| 2056 "description": "Students who match the list request.", |
| 2057 "items": { |
| 2058 "$ref": "Student" |
| 2059 }, |
| 2060 "type": "array" |
| 2061 } |
| 2062 }, |
| 2063 "type": "object" |
| 2064 }, |
1897 "Student": { | 2065 "Student": { |
1898 "description": "Student in a course.", | 2066 "description": "Student in a course.", |
1899 "id": "Student", | 2067 "id": "Student", |
1900 "properties": { | 2068 "properties": { |
1901 "userId": { | |
1902 "description": "Identifier of the user.\n\nWhen specified as
a parameter of a request, this identifier can be one of\nthe following:\n\n* th
e numeric identifier for the user\n* the email address of the user\n* the string
literal `\"me\"`, indicating the requesting user", | |
1903 "type": "string" | |
1904 }, | |
1905 "courseId": { | 2069 "courseId": { |
1906 "description": "Identifier of the course.\n\nRead-only.", | 2070 "description": "Identifier of the course.\n\nRead-only.", |
1907 "type": "string" | 2071 "type": "string" |
1908 }, | 2072 }, |
1909 "studentWorkFolder": { | 2073 "studentWorkFolder": { |
1910 "$ref": "DriveFolder", | 2074 "$ref": "DriveFolder", |
1911 "description": "Information about a Drive Folder for this st
udent's work in this course.\nOnly visible to the student and domain administrat
ors.\n\nRead-only." | 2075 "description": "Information about a Drive Folder for this st
udent's work in this course.\nOnly visible to the student and domain administrat
ors.\n\nRead-only." |
1912 }, | 2076 }, |
1913 "profile": { | 2077 "profile": { |
1914 "$ref": "UserProfile", | 2078 "$ref": "UserProfile", |
1915 "description": "Global user information for the student.\n\n
Read-only." | 2079 "description": "Global user information for the student.\n\n
Read-only." |
| 2080 }, |
| 2081 "userId": { |
| 2082 "description": "Identifier of the user.\n\nWhen specified as
a parameter of a request, this identifier can be one of\nthe following:\n\n* th
e numeric identifier for the user\n* the email address of the user\n* the string
literal `\"me\"`, indicating the requesting user", |
| 2083 "type": "string" |
1916 } | 2084 } |
1917 }, | 2085 }, |
1918 "type": "object" | 2086 "type": "object" |
1919 }, | 2087 }, |
1920 "Invitation": { | 2088 "Invitation": { |
1921 "description": "An invitation to join a course.", | 2089 "description": "An invitation to join a course.", |
1922 "id": "Invitation", | 2090 "id": "Invitation", |
1923 "properties": { | 2091 "properties": { |
| 2092 "courseId": { |
| 2093 "description": "Identifier of the course to invite the user
to.", |
| 2094 "type": "string" |
| 2095 }, |
| 2096 "id": { |
| 2097 "description": "Identifier assigned by Classroom.\n\nRead-on
ly.", |
| 2098 "type": "string" |
| 2099 }, |
1924 "role": { | 2100 "role": { |
1925 "description": "Role to invite the user to have.\nMust not b
e `COURSE_ROLE_UNSPECIFIED`.", | 2101 "description": "Role to invite the user to have.\nMust not b
e `COURSE_ROLE_UNSPECIFIED`.", |
1926 "enum": [ | 2102 "enum": [ |
1927 "COURSE_ROLE_UNSPECIFIED", | 2103 "COURSE_ROLE_UNSPECIFIED", |
1928 "STUDENT", | 2104 "STUDENT", |
1929 "TEACHER" | 2105 "TEACHER" |
1930 ], | 2106 ], |
1931 "enumDescriptions": [ | 2107 "enumDescriptions": [ |
1932 "No course role.", | 2108 "No course role.", |
1933 "Student in the course.", | 2109 "Student in the course.", |
1934 "Teacher of the course." | 2110 "Teacher of the course." |
1935 ], | 2111 ], |
1936 "type": "string" | 2112 "type": "string" |
1937 }, | 2113 }, |
1938 "userId": { | 2114 "userId": { |
1939 "description": "Identifier of the invited user.\n\nWhen spec
ified as a parameter of a request, this identifier can be set to\none of the fol
lowing:\n\n* the numeric identifier for the user\n* the email address of the use
r\n* the string literal `\"me\"`, indicating the requesting user", | 2115 "description": "Identifier of the invited user.\n\nWhen spec
ified as a parameter of a request, this identifier can be set to\none of the fol
lowing:\n\n* the numeric identifier for the user\n* the email address of the use
r\n* the string literal `\"me\"`, indicating the requesting user", |
1940 "type": "string" | 2116 "type": "string" |
1941 }, | |
1942 "courseId": { | |
1943 "description": "Identifier of the course to invite the user
to.", | |
1944 "type": "string" | |
1945 }, | |
1946 "id": { | |
1947 "description": "Identifier assigned by Classroom.\n\nRead-on
ly.", | |
1948 "type": "string" | |
1949 } | 2117 } |
1950 }, | 2118 }, |
1951 "type": "object" | 2119 "type": "object" |
1952 }, | 2120 }, |
1953 "DriveFolder": { | 2121 "DriveFolder": { |
1954 "description": "Representation of a Google Drive folder.", | 2122 "description": "Representation of a Google Drive folder.", |
1955 "id": "DriveFolder", | 2123 "id": "DriveFolder", |
1956 "properties": { | 2124 "properties": { |
1957 "id": { | |
1958 "description": "Drive API resource ID.", | |
1959 "type": "string" | |
1960 }, | |
1961 "title": { | 2125 "title": { |
1962 "description": "Title of the Drive folder.\n\nRead-only.", | 2126 "description": "Title of the Drive folder.\n\nRead-only.", |
1963 "type": "string" | 2127 "type": "string" |
1964 }, | 2128 }, |
1965 "alternateLink": { | 2129 "alternateLink": { |
1966 "description": "URL that can be used to access the Drive fol
der.\n\nRead-only.", | 2130 "description": "URL that can be used to access the Drive fol
der.\n\nRead-only.", |
1967 "type": "string" | 2131 "type": "string" |
| 2132 }, |
| 2133 "id": { |
| 2134 "description": "Drive API resource ID.", |
| 2135 "type": "string" |
1968 } | 2136 } |
1969 }, | 2137 }, |
1970 "type": "object" | 2138 "type": "object" |
1971 }, | 2139 }, |
1972 "ShortAnswerSubmission": { | 2140 "ShortAnswerSubmission": { |
1973 "description": "Student work for a short answer question.", | 2141 "description": "Student work for a short answer question.", |
1974 "id": "ShortAnswerSubmission", | 2142 "id": "ShortAnswerSubmission", |
1975 "properties": { | 2143 "properties": { |
1976 "answer": { | 2144 "answer": { |
1977 "description": "Student response to a short-answer question.
", | 2145 "description": "Student response to a short-answer question.
", |
1978 "type": "string" | 2146 "type": "string" |
1979 } | 2147 } |
1980 }, | 2148 }, |
1981 "type": "object" | 2149 "type": "object" |
1982 }, | 2150 }, |
1983 "TurnInStudentSubmissionRequest": { | |
1984 "description": "Request to turn in a student submission.", | |
1985 "id": "TurnInStudentSubmissionRequest", | |
1986 "properties": {}, | |
1987 "type": "object" | |
1988 }, | |
1989 "ListStudentSubmissionsResponse": { | |
1990 "description": "Response when listing student submissions.", | |
1991 "id": "ListStudentSubmissionsResponse", | |
1992 "properties": { | |
1993 "nextPageToken": { | |
1994 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", | |
1995 "type": "string" | |
1996 }, | |
1997 "studentSubmissions": { | |
1998 "description": "Student work that matches the request.", | |
1999 "items": { | |
2000 "$ref": "StudentSubmission" | |
2001 }, | |
2002 "type": "array" | |
2003 } | |
2004 }, | |
2005 "type": "object" | |
2006 }, | |
2007 "StudentSubmission": { | 2151 "StudentSubmission": { |
2008 "description": "Student submission for course work.\n\nStudentSubmis
sion items are generated when a CourseWork item is created.\n\nStudentSubmission
s that have never been accessed (i.e. with `state` = NEW)\nmay not have a creati
on time or update time.", | 2152 "description": "Student submission for course work.\n\nStudentSubmis
sion items are generated when a CourseWork item is created.\n\nStudentSubmission
s that have never been accessed (i.e. with `state` = NEW)\nmay not have a creati
on time or update time.", |
2009 "id": "StudentSubmission", | 2153 "id": "StudentSubmission", |
2010 "properties": { | 2154 "properties": { |
| 2155 "state": { |
| 2156 "description": "State of this submission.\n\nRead-only.", |
| 2157 "enum": [ |
| 2158 "SUBMISSION_STATE_UNSPECIFIED", |
| 2159 "NEW", |
| 2160 "CREATED", |
| 2161 "TURNED_IN", |
| 2162 "RETURNED", |
| 2163 "RECLAIMED_BY_STUDENT" |
| 2164 ], |
| 2165 "enumDescriptions": [ |
| 2166 "No state specified. This should never be returned.", |
| 2167 "The student has never accessed this submission. Attachm
ents are not\nreturned and timestamps is not set.", |
| 2168 "Has been created.", |
| 2169 "Has been turned in to the teacher.", |
| 2170 "Has been returned to the student.", |
| 2171 "Student chose to \"unsubmit\" the assignment." |
| 2172 ], |
| 2173 "type": "string" |
| 2174 }, |
| 2175 "userId": { |
| 2176 "description": "Identifier for the student that owns this su
bmission.\n\nRead-only.", |
| 2177 "type": "string" |
| 2178 }, |
| 2179 "courseWorkId": { |
| 2180 "description": "Identifier for the course work this correspo
nds to.\n\nRead-only.", |
| 2181 "type": "string" |
| 2182 }, |
| 2183 "courseId": { |
| 2184 "description": "Identifier of the course.\n\nRead-only.", |
| 2185 "type": "string" |
| 2186 }, |
| 2187 "id": { |
| 2188 "description": "Classroom-assigned Identifier for the studen
t submission.\nThis is unique among submissions for the relevant course work.\n\
nRead-only.", |
| 2189 "type": "string" |
| 2190 }, |
2011 "assignedGrade": { | 2191 "assignedGrade": { |
2012 "description": "Optional grade. If unset, no grade was set.\
nThis must be a non-negative integer value.\n\nThis may be modified only by cour
se teachers.", | 2192 "description": "Optional grade. If unset, no grade was set.\
nThis must be a non-negative integer value.\n\nThis may be modified only by cour
se teachers.", |
2013 "format": "double", | 2193 "format": "double", |
2014 "type": "number" | 2194 "type": "number" |
2015 }, | 2195 }, |
2016 "multipleChoiceSubmission": { | 2196 "multipleChoiceSubmission": { |
2017 "$ref": "MultipleChoiceSubmission", | 2197 "$ref": "MultipleChoiceSubmission", |
2018 "description": "Submission content when course_work_type is
MULTIPLE_CHOICE_QUESTION." | 2198 "description": "Submission content when course_work_type is
MULTIPLE_CHOICE_QUESTION." |
2019 }, | 2199 }, |
2020 "assignmentSubmission": { | 2200 "assignmentSubmission": { |
2021 "$ref": "AssignmentSubmission", | 2201 "$ref": "AssignmentSubmission", |
2022 "description": "Submission content when course_work_type is
ASSIGNMENT ." | 2202 "description": "Submission content when course_work_type is
ASSIGNMENT ." |
2023 }, | 2203 }, |
| 2204 "associatedWithDeveloper": { |
| 2205 "description": "Whether this student submission is associate
d with the Developer Console\nproject making the request.\n\nSee google.classroo
m.Work.CreateCourseWork for more\ndetails.\n\nRead-only.", |
| 2206 "type": "boolean" |
| 2207 }, |
2024 "shortAnswerSubmission": { | 2208 "shortAnswerSubmission": { |
2025 "$ref": "ShortAnswerSubmission", | 2209 "$ref": "ShortAnswerSubmission", |
2026 "description": "Submission content when course_work_type is
SHORT_ANSWER_QUESTION." | 2210 "description": "Submission content when course_work_type is
SHORT_ANSWER_QUESTION." |
2027 }, | 2211 }, |
2028 "associatedWithDeveloper": { | |
2029 "description": "Whether this student submission is associate
d with the Developer Console\nproject making the request.\n\nSee google.classroo
m.Work.CreateCourseWork for more\ndetails.\n\nRead-only.", | |
2030 "type": "boolean" | |
2031 }, | |
2032 "updateTime": { | 2212 "updateTime": { |
2033 "description": "Last update time of this submission.\nThis m
ay be unset if the student has not accessed this item.\n\nRead-only.", | 2213 "description": "Last update time of this submission.\nThis m
ay be unset if the student has not accessed this item.\n\nRead-only.", |
2034 "format": "google-datetime", | 2214 "format": "google-datetime", |
2035 "type": "string" | 2215 "type": "string" |
2036 }, | 2216 }, |
2037 "alternateLink": { | 2217 "alternateLink": { |
2038 "description": "Absolute link to the submission in the Class
room web UI.\n\nRead-only.", | 2218 "description": "Absolute link to the submission in the Class
room web UI.\n\nRead-only.", |
2039 "type": "string" | 2219 "type": "string" |
2040 }, | 2220 }, |
2041 "late": { | |
2042 "description": "Whether this submission is late.\n\nRead-onl
y.", | |
2043 "type": "boolean" | |
2044 }, | |
2045 "draftGrade": { | 2221 "draftGrade": { |
2046 "description": "Optional pending grade. If unset, no grade w
as set.\nThis must be a non-negative integer value.\n\nThis is only visible to a
nd modifiable by course teachers.", | 2222 "description": "Optional pending grade. If unset, no grade w
as set.\nThis must be a non-negative integer value.\n\nThis is only visible to a
nd modifiable by course teachers.", |
2047 "format": "double", | 2223 "format": "double", |
2048 "type": "number" | 2224 "type": "number" |
2049 }, | 2225 }, |
| 2226 "late": { |
| 2227 "description": "Whether this submission is late.\n\nRead-onl
y.", |
| 2228 "type": "boolean" |
| 2229 }, |
2050 "courseWorkType": { | 2230 "courseWorkType": { |
2051 "description": "Type of course work this submission is for.\
n\nRead-only.", | 2231 "description": "Type of course work this submission is for.\
n\nRead-only.", |
2052 "enum": [ | 2232 "enum": [ |
2053 "COURSE_WORK_TYPE_UNSPECIFIED", | 2233 "COURSE_WORK_TYPE_UNSPECIFIED", |
2054 "ASSIGNMENT", | 2234 "ASSIGNMENT", |
2055 "SHORT_ANSWER_QUESTION", | 2235 "SHORT_ANSWER_QUESTION", |
2056 "MULTIPLE_CHOICE_QUESTION" | 2236 "MULTIPLE_CHOICE_QUESTION" |
2057 ], | 2237 ], |
2058 "enumDescriptions": [ | 2238 "enumDescriptions": [ |
2059 "No work type specified. This is never returned.", | 2239 "No work type specified. This is never returned.", |
2060 "An assignment.", | 2240 "An assignment.", |
2061 "A short answer question.", | 2241 "A short answer question.", |
2062 "A multiple-choice question." | 2242 "A multiple-choice question." |
2063 ], | 2243 ], |
2064 "type": "string" | 2244 "type": "string" |
2065 }, | 2245 }, |
2066 "creationTime": { | 2246 "creationTime": { |
2067 "description": "Creation time of this submission.\nThis may
be unset if the student has not accessed this item.\n\nRead-only.", | 2247 "description": "Creation time of this submission.\nThis may
be unset if the student has not accessed this item.\n\nRead-only.", |
2068 "format": "google-datetime", | 2248 "format": "google-datetime", |
2069 "type": "string" | 2249 "type": "string" |
2070 }, | |
2071 "state": { | |
2072 "description": "State of this submission.\n\nRead-only.", | |
2073 "enum": [ | |
2074 "SUBMISSION_STATE_UNSPECIFIED", | |
2075 "NEW", | |
2076 "CREATED", | |
2077 "TURNED_IN", | |
2078 "RETURNED", | |
2079 "RECLAIMED_BY_STUDENT" | |
2080 ], | |
2081 "enumDescriptions": [ | |
2082 "No state specified. This should never be returned.", | |
2083 "The student has never accessed this submission. Attachm
ents are not\nreturned and timestamps is not set.", | |
2084 "Has been created.", | |
2085 "Has been turned in to the teacher.", | |
2086 "Has been returned to the student.", | |
2087 "Student chose to \"unsubmit\" the assignment." | |
2088 ], | |
2089 "type": "string" | |
2090 }, | |
2091 "userId": { | |
2092 "description": "Identifier for the student that owns this su
bmission.\n\nRead-only.", | |
2093 "type": "string" | |
2094 }, | |
2095 "courseWorkId": { | |
2096 "description": "Identifier for the course work this correspo
nds to.\n\nRead-only.", | |
2097 "type": "string" | |
2098 }, | |
2099 "courseId": { | |
2100 "description": "Identifier of the course.\n\nRead-only.", | |
2101 "type": "string" | |
2102 }, | |
2103 "id": { | |
2104 "description": "Classroom-assigned Identifier for the studen
t submission.\nThis is unique among submissions for the relevant course work.\n\
nRead-only.", | |
2105 "type": "string" | |
2106 } | 2250 } |
2107 }, | 2251 }, |
2108 "type": "object" | 2252 "type": "object" |
2109 }, | 2253 }, |
2110 "ModifyAttachmentsRequest": { | 2254 "ListStudentSubmissionsResponse": { |
2111 "description": "Request to modify the attachments of a student submi
ssion.", | 2255 "description": "Response when listing student submissions.", |
2112 "id": "ModifyAttachmentsRequest", | 2256 "id": "ListStudentSubmissionsResponse", |
2113 "properties": { | 2257 "properties": { |
2114 "addAttachments": { | 2258 "nextPageToken": { |
2115 "description": "Attachments to add.\nA student submission ma
y not have more than 20 attachments.\n\nForm attachments are not supported.", | 2259 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", |
| 2260 "type": "string" |
| 2261 }, |
| 2262 "studentSubmissions": { |
| 2263 "description": "Student work that matches the request.", |
2116 "items": { | 2264 "items": { |
2117 "$ref": "Attachment" | 2265 "$ref": "StudentSubmission" |
2118 }, | 2266 }, |
2119 "type": "array" | 2267 "type": "array" |
2120 } | 2268 } |
2121 }, | 2269 }, |
2122 "type": "object" | 2270 "type": "object" |
2123 }, | 2271 }, |
| 2272 "TurnInStudentSubmissionRequest": { |
| 2273 "description": "Request to turn in a student submission.", |
| 2274 "id": "TurnInStudentSubmissionRequest", |
| 2275 "properties": {}, |
| 2276 "type": "object" |
| 2277 }, |
2124 "ListCourseWorkResponse": { | 2278 "ListCourseWorkResponse": { |
2125 "description": "Response when listing course work.", | 2279 "description": "Response when listing course work.", |
2126 "id": "ListCourseWorkResponse", | 2280 "id": "ListCourseWorkResponse", |
2127 "properties": { | 2281 "properties": { |
2128 "nextPageToken": { | 2282 "nextPageToken": { |
2129 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", | 2283 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", |
2130 "type": "string" | 2284 "type": "string" |
2131 }, | 2285 }, |
2132 "courseWork": { | 2286 "courseWork": { |
2133 "description": "Course work items that match the request.", | 2287 "description": "Course work items that match the request.", |
2134 "items": { | 2288 "items": { |
2135 "$ref": "CourseWork" | 2289 "$ref": "CourseWork" |
2136 }, | 2290 }, |
2137 "type": "array" | 2291 "type": "array" |
2138 } | 2292 } |
2139 }, | 2293 }, |
2140 "type": "object" | 2294 "type": "object" |
2141 }, | 2295 }, |
| 2296 "ModifyAttachmentsRequest": { |
| 2297 "description": "Request to modify the attachments of a student submi
ssion.", |
| 2298 "id": "ModifyAttachmentsRequest", |
| 2299 "properties": { |
| 2300 "addAttachments": { |
| 2301 "description": "Attachments to add.\nA student submission ma
y not have more than 20 attachments.\n\nForm attachments are not supported.", |
| 2302 "items": { |
| 2303 "$ref": "Attachment" |
| 2304 }, |
| 2305 "type": "array" |
| 2306 } |
| 2307 }, |
| 2308 "type": "object" |
| 2309 }, |
2142 "YouTubeVideo": { | 2310 "YouTubeVideo": { |
2143 "description": "YouTube video item.", | 2311 "description": "YouTube video item.", |
2144 "id": "YouTubeVideo", | 2312 "id": "YouTubeVideo", |
2145 "properties": { | 2313 "properties": { |
2146 "id": { | |
2147 "description": "YouTube API resource ID.", | |
2148 "type": "string" | |
2149 }, | |
2150 "title": { | 2314 "title": { |
2151 "description": "Title of the YouTube video.\n\nRead-only.", | 2315 "description": "Title of the YouTube video.\n\nRead-only.", |
2152 "type": "string" | 2316 "type": "string" |
2153 }, | 2317 }, |
2154 "alternateLink": { | 2318 "alternateLink": { |
2155 "description": "URL that can be used to view the YouTube vid
eo.\n\nRead-only.", | 2319 "description": "URL that can be used to view the YouTube vid
eo.\n\nRead-only.", |
2156 "type": "string" | 2320 "type": "string" |
2157 }, | 2321 }, |
2158 "thumbnailUrl": { | 2322 "thumbnailUrl": { |
2159 "description": "URL of a thumbnail image of the YouTube vide
o.\n\nRead-only.", | 2323 "description": "URL of a thumbnail image of the YouTube vide
o.\n\nRead-only.", |
2160 "type": "string" | 2324 "type": "string" |
| 2325 }, |
| 2326 "id": { |
| 2327 "description": "YouTube API resource ID.", |
| 2328 "type": "string" |
2161 } | 2329 } |
2162 }, | 2330 }, |
2163 "type": "object" | 2331 "type": "object" |
2164 }, | 2332 }, |
2165 "ListInvitationsResponse": { | 2333 "ListInvitationsResponse": { |
2166 "description": "Response when listing invitations.", | 2334 "description": "Response when listing invitations.", |
2167 "id": "ListInvitationsResponse", | 2335 "id": "ListInvitationsResponse", |
2168 "properties": { | 2336 "properties": { |
2169 "nextPageToken": { | 2337 "nextPageToken": { |
2170 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", | 2338 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", |
2171 "type": "string" | 2339 "type": "string" |
2172 }, | 2340 }, |
2173 "invitations": { | 2341 "invitations": { |
2174 "description": "Invitations that match the list request.", | 2342 "description": "Invitations that match the list request.", |
2175 "items": { | 2343 "items": { |
2176 "$ref": "Invitation" | 2344 "$ref": "Invitation" |
2177 }, | 2345 }, |
2178 "type": "array" | 2346 "type": "array" |
2179 } | 2347 } |
2180 }, | 2348 }, |
2181 "type": "object" | 2349 "type": "object" |
2182 }, | 2350 }, |
2183 "GuardianInvitation": { | 2351 "GuardianInvitation": { |
2184 "description": "An invitation to become the guardian of a specified
user, sent to a specified\nemail address.", | 2352 "description": "An invitation to become the guardian of a specified
user, sent to a specified\nemail address.", |
2185 "id": "GuardianInvitation", | 2353 "id": "GuardianInvitation", |
2186 "properties": { | 2354 "properties": { |
| 2355 "invitedEmailAddress": { |
| 2356 "description": "Email address that the invitation was sent t
o.\nThis field is only visible to domain administrators.", |
| 2357 "type": "string" |
| 2358 }, |
| 2359 "creationTime": { |
| 2360 "description": "The time that this invitation was created.\n
\nRead-only.", |
| 2361 "format": "google-datetime", |
| 2362 "type": "string" |
| 2363 }, |
2187 "invitationId": { | 2364 "invitationId": { |
2188 "description": "Unique identifier for this invitation.\n\nRe
ad-only.", | 2365 "description": "Unique identifier for this invitation.\n\nRe
ad-only.", |
2189 "type": "string" | 2366 "type": "string" |
2190 }, | 2367 }, |
2191 "state": { | 2368 "state": { |
2192 "description": "The state that this invitation is in.", | 2369 "description": "The state that this invitation is in.", |
2193 "enum": [ | 2370 "enum": [ |
2194 "GUARDIAN_INVITATION_STATE_UNSPECIFIED", | 2371 "GUARDIAN_INVITATION_STATE_UNSPECIFIED", |
2195 "PENDING", | 2372 "PENDING", |
2196 "COMPLETE" | 2373 "COMPLETE" |
2197 ], | 2374 ], |
2198 "enumDescriptions": [ | 2375 "enumDescriptions": [ |
2199 "Should never be returned.", | 2376 "Should never be returned.", |
2200 "The invitation is active and awaiting a response.", | 2377 "The invitation is active and awaiting a response.", |
2201 "The invitation is no longer active. It may have been ac
cepted, declined,\nwithdrawn or it may have expired." | 2378 "The invitation is no longer active. It may have been ac
cepted, declined,\nwithdrawn or it may have expired." |
2202 ], | 2379 ], |
2203 "type": "string" | 2380 "type": "string" |
2204 }, | 2381 }, |
2205 "studentId": { | 2382 "studentId": { |
2206 "description": "ID of the student (in standard format)", | 2383 "description": "ID of the student (in standard format)", |
2207 "type": "string" | 2384 "type": "string" |
2208 }, | |
2209 "invitedEmailAddress": { | |
2210 "description": "Email address that the invitation was sent t
o.\nThis field is only visible to domain administrators.", | |
2211 "type": "string" | |
2212 }, | |
2213 "creationTime": { | |
2214 "description": "The time that this invitation was created.\n
\nRead-only.", | |
2215 "format": "google-datetime", | |
2216 "type": "string" | |
2217 } | 2385 } |
2218 }, | 2386 }, |
2219 "type": "object" | 2387 "type": "object" |
2220 }, | 2388 }, |
2221 "Attachment": { | 2389 "Attachment": { |
2222 "description": "Attachment added to student assignment work.\n\nWhen
creating attachments, setting the `form` field is not supported.", | 2390 "description": "Attachment added to student assignment work.\n\nWhen
creating attachments, setting the `form` field is not supported.", |
2223 "id": "Attachment", | 2391 "id": "Attachment", |
2224 "properties": { | 2392 "properties": { |
2225 "link": { | |
2226 "$ref": "Link", | |
2227 "description": "Link attachment." | |
2228 }, | |
2229 "youTubeVideo": { | 2393 "youTubeVideo": { |
2230 "$ref": "YouTubeVideo", | 2394 "$ref": "YouTubeVideo", |
2231 "description": "Youtube video attachment." | 2395 "description": "Youtube video attachment." |
2232 }, | 2396 }, |
2233 "driveFile": { | 2397 "driveFile": { |
2234 "$ref": "DriveFile", | 2398 "$ref": "DriveFile", |
2235 "description": "Google Drive file attachment." | 2399 "description": "Google Drive file attachment." |
2236 }, | 2400 }, |
2237 "form": { | 2401 "form": { |
2238 "$ref": "Form", | 2402 "$ref": "Form", |
2239 "description": "Google Forms attachment." | 2403 "description": "Google Forms attachment." |
| 2404 }, |
| 2405 "link": { |
| 2406 "$ref": "Link", |
| 2407 "description": "Link attachment." |
2240 } | 2408 } |
2241 }, | 2409 }, |
2242 "type": "object" | 2410 "type": "object" |
2243 }, | 2411 }, |
2244 "CourseMaterialSet": { | 2412 "CourseMaterialSet": { |
2245 "description": "A set of materials that appears on the \"About\" pag
e of the course.\nThese materials might include a syllabus, schedule, or other b
ackground\ninformation relating to the course as a whole.", | 2413 "description": "A set of materials that appears on the \"About\" pag
e of the course.\nThese materials might include a syllabus, schedule, or other b
ackground\ninformation relating to the course as a whole.", |
2246 "id": "CourseMaterialSet", | 2414 "id": "CourseMaterialSet", |
2247 "properties": { | 2415 "properties": { |
2248 "materials": { | 2416 "materials": { |
2249 "description": "Materials attached to this set.", | 2417 "description": "Materials attached to this set.", |
2250 "items": { | 2418 "items": { |
2251 "$ref": "CourseMaterial" | 2419 "$ref": "CourseMaterial" |
2252 }, | 2420 }, |
2253 "type": "array" | 2421 "type": "array" |
2254 }, | 2422 }, |
2255 "title": { | 2423 "title": { |
2256 "description": "Title for this set.", | 2424 "description": "Title for this set.", |
2257 "type": "string" | 2425 "type": "string" |
2258 } | 2426 } |
2259 }, | 2427 }, |
2260 "type": "object" | 2428 "type": "object" |
2261 }, | 2429 }, |
2262 "TimeOfDay": { | 2430 "TimeOfDay": { |
2263 "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
`.", | 2431 "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
`.", |
2264 "id": "TimeOfDay", | 2432 "id": "TimeOfDay", |
2265 "properties": { | 2433 "properties": { |
| 2434 "nanos": { |
| 2435 "description": "Fractions of seconds in nanoseconds. Must be
from 0 to 999,999,999.", |
| 2436 "format": "int32", |
| 2437 "type": "integer" |
| 2438 }, |
| 2439 "seconds": { |
| 2440 "description": "Seconds of minutes of the time. Must normall
y be from 0 to 59. An API may\nallow the value 60 if it allows leap-seconds.", |
| 2441 "format": "int32", |
| 2442 "type": "integer" |
| 2443 }, |
2266 "minutes": { | 2444 "minutes": { |
2267 "description": "Minutes of hour of day. Must be from 0 to 59
.", | 2445 "description": "Minutes of hour of day. Must be from 0 to 59
.", |
2268 "format": "int32", | 2446 "format": "int32", |
2269 "type": "integer" | 2447 "type": "integer" |
2270 }, | 2448 }, |
2271 "hours": { | 2449 "hours": { |
2272 "description": "Hours of day in 24 hour format. Should be fr
om 0 to 23. An API may choose\nto allow the value \"24:00:00\" for scenarios lik
e business closing time.", | 2450 "description": "Hours of day in 24 hour format. Should be fr
om 0 to 23. An API may choose\nto allow the value \"24:00:00\" for scenarios lik
e business closing time.", |
2273 "format": "int32", | 2451 "format": "int32", |
2274 "type": "integer" | 2452 "type": "integer" |
2275 }, | |
2276 "nanos": { | |
2277 "description": "Fractions of seconds in nanoseconds. Must be
from 0 to 999,999,999.", | |
2278 "format": "int32", | |
2279 "type": "integer" | |
2280 }, | |
2281 "seconds": { | |
2282 "description": "Seconds of minutes of the time. Must normall
y be from 0 to 59. An API may\nallow the value 60 if it allows leap-seconds.", | |
2283 "format": "int32", | |
2284 "type": "integer" | |
2285 } | 2453 } |
2286 }, | 2454 }, |
2287 "type": "object" | 2455 "type": "object" |
2288 }, | 2456 }, |
2289 "ListCoursesResponse": { | 2457 "ListCoursesResponse": { |
2290 "description": "Response when listing courses.", | 2458 "description": "Response when listing courses.", |
2291 "id": "ListCoursesResponse", | 2459 "id": "ListCoursesResponse", |
2292 "properties": { | 2460 "properties": { |
2293 "nextPageToken": { | |
2294 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", | |
2295 "type": "string" | |
2296 }, | |
2297 "courses": { | 2461 "courses": { |
2298 "description": "Courses that match the list request.", | 2462 "description": "Courses that match the list request.", |
2299 "items": { | 2463 "items": { |
2300 "$ref": "Course" | 2464 "$ref": "Course" |
2301 }, | 2465 }, |
2302 "type": "array" | 2466 "type": "array" |
| 2467 }, |
| 2468 "nextPageToken": { |
| 2469 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", |
| 2470 "type": "string" |
2303 } | 2471 } |
2304 }, | 2472 }, |
2305 "type": "object" | 2473 "type": "object" |
2306 }, | 2474 }, |
2307 "Form": { | 2475 "Form": { |
2308 "description": "Google Forms item.", | 2476 "description": "Google Forms item.", |
2309 "id": "Form", | 2477 "id": "Form", |
2310 "properties": { | 2478 "properties": { |
| 2479 "thumbnailUrl": { |
| 2480 "description": "URL of a thumbnail image of the Form.\n\nRea
d-only.", |
| 2481 "type": "string" |
| 2482 }, |
2311 "responseUrl": { | 2483 "responseUrl": { |
2312 "description": "URL of the form responses document.\nOnly se
t if respsonses have been recorded and only when the\nrequesting user is an edit
or of the form.\n\nRead-only.", | 2484 "description": "URL of the form responses document.\nOnly se
t if respsonses have been recorded and only when the\nrequesting user is an edit
or of the form.\n\nRead-only.", |
2313 "type": "string" | 2485 "type": "string" |
2314 }, | 2486 }, |
2315 "formUrl": { | 2487 "formUrl": { |
2316 "description": "URL of the form.", | 2488 "description": "URL of the form.", |
2317 "type": "string" | 2489 "type": "string" |
2318 }, | 2490 }, |
2319 "title": { | 2491 "title": { |
2320 "description": "Title of the Form.\n\nRead-only.", | 2492 "description": "Title of the Form.\n\nRead-only.", |
2321 "type": "string" | 2493 "type": "string" |
2322 }, | |
2323 "thumbnailUrl": { | |
2324 "description": "URL of a thumbnail image of the Form.\n\nRea
d-only.", | |
2325 "type": "string" | |
2326 } | 2494 } |
2327 }, | 2495 }, |
2328 "type": "object" | 2496 "type": "object" |
2329 }, | 2497 }, |
2330 "ListTeachersResponse": { | 2498 "ListTeachersResponse": { |
2331 "description": "Response when listing teachers.", | 2499 "description": "Response when listing teachers.", |
2332 "id": "ListTeachersResponse", | 2500 "id": "ListTeachersResponse", |
2333 "properties": { | 2501 "properties": { |
2334 "nextPageToken": { | 2502 "nextPageToken": { |
2335 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", | 2503 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", |
2336 "type": "string" | 2504 "type": "string" |
2337 }, | 2505 }, |
2338 "teachers": { | 2506 "teachers": { |
2339 "description": "Teachers who match the list request.", | 2507 "description": "Teachers who match the list request.", |
2340 "items": { | 2508 "items": { |
2341 "$ref": "Teacher" | 2509 "$ref": "Teacher" |
2342 }, | 2510 }, |
2343 "type": "array" | 2511 "type": "array" |
2344 } | 2512 } |
2345 }, | 2513 }, |
2346 "type": "object" | 2514 "type": "object" |
2347 }, | 2515 }, |
2348 "Link": { | 2516 "Link": { |
2349 "description": "URL item.", | 2517 "description": "URL item.", |
2350 "id": "Link", | 2518 "id": "Link", |
2351 "properties": { | 2519 "properties": { |
| 2520 "title": { |
| 2521 "description": "Title of the target of the URL.\n\nRead-only
.", |
| 2522 "type": "string" |
| 2523 }, |
2352 "thumbnailUrl": { | 2524 "thumbnailUrl": { |
2353 "description": "URL of a thumbnail image of the target URL.\
n\nRead-only.", | 2525 "description": "URL of a thumbnail image of the target URL.\
n\nRead-only.", |
2354 "type": "string" | 2526 "type": "string" |
2355 }, | 2527 }, |
2356 "url": { | 2528 "url": { |
2357 "description": "URL to link to.\nThis must be a valid UTF-8
string containing between 1 and 2024 characters.", | 2529 "description": "URL to link to.\nThis must be a valid UTF-8
string containing between 1 and 2024 characters.", |
2358 "type": "string" | 2530 "type": "string" |
2359 }, | |
2360 "title": { | |
2361 "description": "Title of the target of the URL.\n\nRead-only
.", | |
2362 "type": "string" | |
2363 } | 2531 } |
2364 }, | 2532 }, |
2365 "type": "object" | 2533 "type": "object" |
2366 }, | 2534 }, |
2367 "ListGuardiansResponse": { | 2535 "ListGuardiansResponse": { |
2368 "description": "Response when listing guardians.", | 2536 "description": "Response when listing guardians.", |
2369 "id": "ListGuardiansResponse", | 2537 "id": "ListGuardiansResponse", |
2370 "properties": { | 2538 "properties": { |
2371 "nextPageToken": { | |
2372 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", | |
2373 "type": "string" | |
2374 }, | |
2375 "guardians": { | 2539 "guardians": { |
2376 "description": "Guardians on this page of results that met t
he criteria specified in\nthe request.", | 2540 "description": "Guardians on this page of results that met t
he criteria specified in\nthe request.", |
2377 "items": { | 2541 "items": { |
2378 "$ref": "Guardian" | 2542 "$ref": "Guardian" |
2379 }, | 2543 }, |
2380 "type": "array" | 2544 "type": "array" |
| 2545 }, |
| 2546 "nextPageToken": { |
| 2547 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", |
| 2548 "type": "string" |
2381 } | 2549 } |
2382 }, | 2550 }, |
2383 "type": "object" | 2551 "type": "object" |
| 2552 }, |
| 2553 "ListCourseAliasesResponse": { |
| 2554 "description": "Response when listing course aliases.", |
| 2555 "id": "ListCourseAliasesResponse", |
| 2556 "properties": { |
| 2557 "aliases": { |
| 2558 "description": "The course aliases.", |
| 2559 "items": { |
| 2560 "$ref": "CourseAlias" |
| 2561 }, |
| 2562 "type": "array" |
| 2563 }, |
| 2564 "nextPageToken": { |
| 2565 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", |
| 2566 "type": "string" |
| 2567 } |
| 2568 }, |
| 2569 "type": "object" |
2384 }, | 2570 }, |
2385 "ListGuardianInvitationsResponse": { | 2571 "ListGuardianInvitationsResponse": { |
2386 "description": "Response when listing guardian invitations.", | 2572 "description": "Response when listing guardian invitations.", |
2387 "id": "ListGuardianInvitationsResponse", | 2573 "id": "ListGuardianInvitationsResponse", |
2388 "properties": { | 2574 "properties": { |
2389 "nextPageToken": { | |
2390 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", | |
2391 "type": "string" | |
2392 }, | |
2393 "guardianInvitations": { | 2575 "guardianInvitations": { |
2394 "description": "Guardian invitations that matched the list r
equest.", | 2576 "description": "Guardian invitations that matched the list r
equest.", |
2395 "items": { | 2577 "items": { |
2396 "$ref": "GuardianInvitation" | 2578 "$ref": "GuardianInvitation" |
2397 }, | 2579 }, |
2398 "type": "array" | 2580 "type": "array" |
| 2581 }, |
| 2582 "nextPageToken": { |
| 2583 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", |
| 2584 "type": "string" |
2399 } | 2585 } |
2400 }, | 2586 }, |
2401 "type": "object" | 2587 "type": "object" |
2402 }, | 2588 }, |
2403 "CourseAlias": { | 2589 "CourseAlias": { |
2404 "description": "Alternative identifier for a course.\n\nAn alias uni
quely identifies a course. It must be unique within one of the\nfollowing scopes
:\n\n* domain: A domain-scoped alias is visible to all users within the alias\nc
reator's domain and can be created only by a domain admin. A domain-scoped\nalia
s is often used when a course has an identifier external to Classroom.\n\n* proj
ect: A project-scoped alias is visible to any request from an\napplication using
the Developer Console project ID that created the alias\nand can be created by
any project. A project-scoped alias is often used when\nan application has alter
native identifiers. A random value can also be used\nto avoid duplicate courses
in the event of transmission failures, as retrying\na request will return `ALREA
DY_EXISTS` if a previous one has succeeded.", | 2590 "description": "Alternative identifier for a course.\n\nAn alias uni
quely identifies a course. It must be unique within one of the\nfollowing scopes
:\n\n* domain: A domain-scoped alias is visible to all users within the alias\nc
reator's domain and can be created only by a domain admin. A domain-scoped\nalia
s is often used when a course has an identifier external to Classroom.\n\n* proj
ect: A project-scoped alias is visible to any request from an\napplication using
the Developer Console project ID that created the alias\nand can be created by
any project. A project-scoped alias is often used when\nan application has alter
native identifiers. A random value can also be used\nto avoid duplicate courses
in the event of transmission failures, as retrying\na request will return `ALREA
DY_EXISTS` if a previous one has succeeded.", |
2405 "id": "CourseAlias", | 2591 "id": "CourseAlias", |
2406 "properties": { | 2592 "properties": { |
2407 "alias": { | 2593 "alias": { |
2408 "description": "Alias string. The format of the string indic
ates the desired alias scoping.\n\n* `d:<name>` indicates a domain-scoped alias.
\n Example: `d:math_101`\n* `p:<name>` indicates a project-scoped alias.\n Exa
mple: `p:abc123`\n\nThis field has a maximum length of 256 characters.", | 2594 "description": "Alias string. The format of the string indic
ates the desired alias scoping.\n\n* `d:<name>` indicates a domain-scoped alias.
\n Example: `d:math_101`\n* `p:<name>` indicates a project-scoped alias.\n Exa
mple: `p:abc123`\n\nThis field has a maximum length of 256 characters.", |
2409 "type": "string" | 2595 "type": "string" |
2410 } | 2596 } |
2411 }, | 2597 }, |
2412 "type": "object" | 2598 "type": "object" |
2413 }, | 2599 }, |
2414 "ListCourseAliasesResponse": { | |
2415 "description": "Response when listing course aliases.", | |
2416 "id": "ListCourseAliasesResponse", | |
2417 "properties": { | |
2418 "aliases": { | |
2419 "description": "The course aliases.", | |
2420 "items": { | |
2421 "$ref": "CourseAlias" | |
2422 }, | |
2423 "type": "array" | |
2424 }, | |
2425 "nextPageToken": { | |
2426 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", | |
2427 "type": "string" | |
2428 } | |
2429 }, | |
2430 "type": "object" | |
2431 }, | |
2432 "Date": { | 2600 "Date": { |
2433 "description": "Represents a whole calendar date, e.g. date of birth
. The time of day and\ntime zone are either specified elsewhere or are not signi
ficant. The date\nis relative to the Proleptic Gregorian Calendar. The day may b
e 0 to\nrepresent a year and month where the day is not significant, e.g. credit
card\nexpiration date. The year may be 0 to represent a month and day independe
nt\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand
`google.protobuf.Timestamp`.", | 2601 "description": "Represents a whole calendar date, e.g. date of birth
. The time of day and\ntime zone are either specified elsewhere or are not signi
ficant. The date\nis relative to the Proleptic Gregorian Calendar. The day may b
e 0 to\nrepresent a year and month where the day is not significant, e.g. credit
card\nexpiration date. The year may be 0 to represent a month and day independe
nt\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand
`google.protobuf.Timestamp`.", |
2434 "id": "Date", | 2602 "id": "Date", |
2435 "properties": { | 2603 "properties": { |
2436 "day": { | 2604 "day": { |
2437 "description": "Day of month. Must be from 1 to 31 and valid
for the year and month, or 0\nif specifying a year/month where the day is not s
ignificant.", | 2605 "description": "Day of month. Must be from 1 to 31 and valid
for the year and month, or 0\nif specifying a year/month where the day is not s
ignificant.", |
2438 "format": "int32", | 2606 "format": "int32", |
2439 "type": "integer" | 2607 "type": "integer" |
2440 }, | 2608 }, |
2441 "year": { | 2609 "year": { |
(...skipping 13 matching lines...) Expand all Loading... |
2455 "description": "Student work for a multiple-choice question.", | 2623 "description": "Student work for a multiple-choice question.", |
2456 "id": "MultipleChoiceSubmission", | 2624 "id": "MultipleChoiceSubmission", |
2457 "properties": { | 2625 "properties": { |
2458 "answer": { | 2626 "answer": { |
2459 "description": "Student's select choice.", | 2627 "description": "Student's select choice.", |
2460 "type": "string" | 2628 "type": "string" |
2461 } | 2629 } |
2462 }, | 2630 }, |
2463 "type": "object" | 2631 "type": "object" |
2464 }, | 2632 }, |
2465 "CourseMaterial": { | |
2466 "description": "A material attached to a course as part of a materia
l set.", | |
2467 "id": "CourseMaterial", | |
2468 "properties": { | |
2469 "form": { | |
2470 "$ref": "Form", | |
2471 "description": "Google Forms attachment." | |
2472 }, | |
2473 "link": { | |
2474 "$ref": "Link", | |
2475 "description": "Link atatchment." | |
2476 }, | |
2477 "youTubeVideo": { | |
2478 "$ref": "YouTubeVideo", | |
2479 "description": "Youtube video attachment." | |
2480 }, | |
2481 "driveFile": { | |
2482 "$ref": "DriveFile", | |
2483 "description": "Google Drive file attachment." | |
2484 } | |
2485 }, | |
2486 "type": "object" | |
2487 }, | |
2488 "Name": { | 2633 "Name": { |
2489 "description": "Details of the user's name.", | 2634 "description": "Details of the user's name.", |
2490 "id": "Name", | 2635 "id": "Name", |
2491 "properties": { | 2636 "properties": { |
2492 "familyName": { | 2637 "familyName": { |
2493 "description": "The user's last name.\n\nRead-only.", | 2638 "description": "The user's last name.\n\nRead-only.", |
2494 "type": "string" | 2639 "type": "string" |
2495 }, | 2640 }, |
2496 "givenName": { | 2641 "givenName": { |
2497 "description": "The user's first name.\n\nRead-only.", | 2642 "description": "The user's first name.\n\nRead-only.", |
2498 "type": "string" | 2643 "type": "string" |
2499 }, | 2644 }, |
2500 "fullName": { | 2645 "fullName": { |
2501 "description": "The user's full name formed by concatenating
the first and last name\nvalues.\n\nRead-only.", | 2646 "description": "The user's full name formed by concatenating
the first and last name\nvalues.\n\nRead-only.", |
2502 "type": "string" | 2647 "type": "string" |
2503 } | 2648 } |
2504 }, | 2649 }, |
2505 "type": "object" | 2650 "type": "object" |
2506 }, | 2651 }, |
| 2652 "CourseMaterial": { |
| 2653 "description": "A material attached to a course as part of a materia
l set.", |
| 2654 "id": "CourseMaterial", |
| 2655 "properties": { |
| 2656 "youTubeVideo": { |
| 2657 "$ref": "YouTubeVideo", |
| 2658 "description": "Youtube video attachment." |
| 2659 }, |
| 2660 "driveFile": { |
| 2661 "$ref": "DriveFile", |
| 2662 "description": "Google Drive file attachment." |
| 2663 }, |
| 2664 "form": { |
| 2665 "$ref": "Form", |
| 2666 "description": "Google Forms attachment." |
| 2667 }, |
| 2668 "link": { |
| 2669 "$ref": "Link", |
| 2670 "description": "Link atatchment." |
| 2671 } |
| 2672 }, |
| 2673 "type": "object" |
| 2674 }, |
2507 "Assignment": { | 2675 "Assignment": { |
2508 "description": "Additional details for assignments.", | 2676 "description": "Additional details for assignments.", |
2509 "id": "Assignment", | 2677 "id": "Assignment", |
2510 "properties": { | 2678 "properties": { |
2511 "studentWorkFolder": { | 2679 "studentWorkFolder": { |
2512 "$ref": "DriveFolder", | 2680 "$ref": "DriveFolder", |
2513 "description": "Drive folder where attachments from student
submissions are placed.\nThis is only populated for course teachers." | 2681 "description": "Drive folder where attachments from student
submissions are placed.\nThis is only populated for course teachers and administ
rators." |
2514 } | 2682 } |
2515 }, | 2683 }, |
2516 "type": "object" | 2684 "type": "object" |
2517 }, | 2685 }, |
2518 "SharedDriveFile": { | 2686 "SharedDriveFile": { |
2519 "description": "Drive file that is used as material for course work.
", | 2687 "description": "Drive file that is used as material for course work.
", |
2520 "id": "SharedDriveFile", | 2688 "id": "SharedDriveFile", |
2521 "properties": { | 2689 "properties": { |
2522 "shareMode": { | 2690 "shareMode": { |
2523 "description": "Mechanism by which students access the Drive
item.", | 2691 "description": "Mechanism by which students access the Drive
item.", |
(...skipping 10 matching lines...) Expand all Loading... |
2534 "Students have a personal copy of the shared file." | 2702 "Students have a personal copy of the shared file." |
2535 ], | 2703 ], |
2536 "type": "string" | 2704 "type": "string" |
2537 }, | 2705 }, |
2538 "driveFile": { | 2706 "driveFile": { |
2539 "$ref": "DriveFile", | 2707 "$ref": "DriveFile", |
2540 "description": "Drive file details." | 2708 "description": "Drive file details." |
2541 } | 2709 } |
2542 }, | 2710 }, |
2543 "type": "object" | 2711 "type": "object" |
2544 }, | |
2545 "Empty": { | |
2546 "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 i
t as the request\nor the response type of an API method. For instance:\n\n se
rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty
);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", | |
2547 "id": "Empty", | |
2548 "properties": {}, | |
2549 "type": "object" | |
2550 }, | |
2551 "MultipleChoiceQuestion": { | |
2552 "description": "Additional details for multiple-choice questions.", | |
2553 "id": "MultipleChoiceQuestion", | |
2554 "properties": { | |
2555 "choices": { | |
2556 "description": "Possible choices.", | |
2557 "items": { | |
2558 "type": "string" | |
2559 }, | |
2560 "type": "array" | |
2561 } | |
2562 }, | |
2563 "type": "object" | |
2564 }, | |
2565 "Course": { | |
2566 "description": "A Course in Classroom.", | |
2567 "id": "Course", | |
2568 "properties": { | |
2569 "updateTime": { | |
2570 "description": "Time of the most recent update to this cours
e.\nSpecifying this field in a course update mask results in an error.\n\nRead-o
nly.", | |
2571 "format": "google-datetime", | |
2572 "type": "string" | |
2573 }, | |
2574 "calendarId": { | |
2575 "description": "The Calendar ID for a calendar that all cour
se members can see, to which\nClassroom adds events for course work and announce
ments in the course.\n\nRead-only.", | |
2576 "type": "string" | |
2577 }, | |
2578 "alternateLink": { | |
2579 "description": "Absolute link to this course in the Classroo
m web UI.\n\nRead-only.", | |
2580 "type": "string" | |
2581 }, | |
2582 "guardiansEnabled": { | |
2583 "description": "Whether or not guardian notifications are en
abled for this course.\n\nRead-only.", | |
2584 "type": "boolean" | |
2585 }, | |
2586 "ownerId": { | |
2587 "description": "The identifier of the owner of a course.\n\n
When specified as a parameter of a\ncreate course request, this\nfield is requir
ed.\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\"`, indic
ating the requesting user\n\nThis must be set in a create request. Specifying th
is field in a course\nupdate mask results in an `INVALID_ARGUMENT` error.", | |
2588 "type": "string" | |
2589 }, | |
2590 "courseState": { | |
2591 "description": "State of the course.\nIf unspecified, the de
fault state is `PROVISIONED`.", | |
2592 "enum": [ | |
2593 "COURSE_STATE_UNSPECIFIED", | |
2594 "ACTIVE", | |
2595 "ARCHIVED", | |
2596 "PROVISIONED", | |
2597 "DECLINED", | |
2598 "SUSPENDED" | |
2599 ], | |
2600 "enumDescriptions": [ | |
2601 "No course state. No returned Course message will use th
is value.", | |
2602 "The course is active.", | |
2603 "The course has been archived. You cannot modify it exce
pt to change it\nto a different state.", | |
2604 "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 cha
nged to `PROVISIONED` if it is in the `DECLINED`\nstate.", | |
2605 "The course has been created, but declined. It is access
ible by the\ncourse owner and domain administrators, though it will not be\ndisp
layed in the web UI. You cannot modify the course except to change it\nto the `P
ROVISIONED` state.\nA course may only be changed to `DECLINED` if it is in the `
PROVISIONED`\nstate.", | |
2606 "The course has been suspended. You cannot modify the co
urse, and only the\nuser identified by the `owner_id` can view the course.\nA co
urse may be placed in this state if it potentially violates the\nTerms of Servic
e." | |
2607 ], | |
2608 "type": "string" | |
2609 }, | |
2610 "description": { | |
2611 "description": "Optional description.\nFor example, \"We'll
be learning about the structure of living\ncreatures from a combination of textb
ooks, 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.", | |
2612 "type": "string" | |
2613 }, | |
2614 "teacherGroupEmail": { | |
2615 "description": "The email address of a Google group containi
ng all teachers of the course.\nThis group does not accept email and can only be
used for permissions.\n\nRead-only.", | |
2616 "type": "string" | |
2617 }, | |
2618 "creationTime": { | |
2619 "description": "Creation time of the course.\nSpecifying thi
s field in a course update mask results in an error.\n\nRead-only.", | |
2620 "format": "google-datetime", | |
2621 "type": "string" | |
2622 }, | |
2623 "teacherFolder": { | |
2624 "$ref": "DriveFolder", | |
2625 "description": "Information about a Drive Folder that is sha
red with all teachers of the\ncourse.\n\nThis field will only be set for teacher
s of the course and domain administrators.\n\nRead-only." | |
2626 }, | |
2627 "name": { | |
2628 "description": "Name of the course.\nFor example, \"10th Gra
de Biology\".\nThe name is required. It must be between 1 and 750 characters and
a valid\nUTF-8 string.", | |
2629 "type": "string" | |
2630 }, | |
2631 "section": { | |
2632 "description": "Section of the course.\nFor example, \"Perio
d 2\".\nIf set, this field must be a valid UTF-8 string and no longer than 2800\
ncharacters.", | |
2633 "type": "string" | |
2634 }, | |
2635 "id": { | |
2636 "description": "Identifier for this course assigned by Class
room.\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\nSp
ecifying this field in a course update mask results in an error.", | |
2637 "type": "string" | |
2638 }, | |
2639 "room": { | |
2640 "description": "Optional room location.\nFor example, \"301\
".\nIf set, this field must be a valid UTF-8 string and no longer than 650\nchar
acters.", | |
2641 "type": "string" | |
2642 }, | |
2643 "courseGroupEmail": { | |
2644 "description": "The email address of a Google group containi
ng all members of the course.\nThis group does not accept email and can only be
used for permissions.\n\nRead-only.", | |
2645 "type": "string" | |
2646 }, | |
2647 "courseMaterialSets": { | |
2648 "description": "Sets of materials that appear on the \"about
\" page of this course.\n\nRead-only.", | |
2649 "items": { | |
2650 "$ref": "CourseMaterialSet" | |
2651 }, | |
2652 "type": "array" | |
2653 }, | |
2654 "enrollmentCode": { | |
2655 "description": "Enrollment code to use when joining this cou
rse.\nSpecifying this field in a course update mask results in an error.\n\nRead
-only.", | |
2656 "type": "string" | |
2657 }, | |
2658 "descriptionHeading": { | |
2659 "description": "Optional heading for the description.\nFor e
xample, \"Welcome to 10th Grade Biology.\"\nIf set, this field must be a valid U
TF-8 string and no longer than 3600\ncharacters.", | |
2660 "type": "string" | |
2661 } | |
2662 }, | |
2663 "type": "object" | |
2664 }, | |
2665 "DriveFile": { | |
2666 "description": "Representation of a Google Drive file.", | |
2667 "id": "DriveFile", | |
2668 "properties": { | |
2669 "id": { | |
2670 "description": "Drive API resource ID.", | |
2671 "type": "string" | |
2672 }, | |
2673 "title": { | |
2674 "description": "Title of the Drive item.\n\nRead-only.", | |
2675 "type": "string" | |
2676 }, | |
2677 "alternateLink": { | |
2678 "description": "URL that can be used to access the Drive ite
m.\n\nRead-only.", | |
2679 "type": "string" | |
2680 }, | |
2681 "thumbnailUrl": { | |
2682 "description": "URL of a thumbnail image of the Drive item.\
n\nRead-only.", | |
2683 "type": "string" | |
2684 } | |
2685 }, | |
2686 "type": "object" | |
2687 }, | |
2688 "ReturnStudentSubmissionRequest": { | |
2689 "description": "Request to return a student submission.", | |
2690 "id": "ReturnStudentSubmissionRequest", | |
2691 "properties": {}, | |
2692 "type": "object" | |
2693 }, | |
2694 "GlobalPermission": { | |
2695 "description": "Global user permission description.", | |
2696 "id": "GlobalPermission", | |
2697 "properties": { | |
2698 "permission": { | |
2699 "description": "Permission value.", | |
2700 "enum": [ | |
2701 "PERMISSION_UNSPECIFIED", | |
2702 "CREATE_COURSE" | |
2703 ], | |
2704 "enumDescriptions": [ | |
2705 "No permission is specified. This is not returned and is
not a\nvalid value.", | |
2706 "User is permitted to create a course." | |
2707 ], | |
2708 "type": "string" | |
2709 } | |
2710 }, | |
2711 "type": "object" | |
2712 } | 2712 } |
2713 }, | 2713 }, |
2714 "servicePath": "", | 2714 "servicePath": "", |
2715 "title": "Google Classroom API", | 2715 "title": "Google Classroom API", |
2716 "version": "v1" | 2716 "version": "v1" |
2717 } | 2717 } |
OLD | NEW |