1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="classroom_v1.html">Google Classroom API</a> . <a href="classroom_v1.courses.html">courses</a> . <a href="classroom_v1.courses.courseWork.html">courseWork</a> . <a href="classroom_v1.courses.courseWork.studentSubmissions.html">studentSubmissions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(courseId, courseWorkId, id, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a student submission. * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, course work, or student submission or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.</p>
<p class="toc_element">
<code><a href="#list">list(courseId, courseWorkId, pageSize=None, userId=None, states=None, x__xgafv=None, pageToken=None, late=None)</a></code></p>
<p class="firstline">Returns a list of student submissions that the requester is permitted to view, factoring in the OAuth scopes of the request. `-` may be specified as the `course_work_id` to include student submissions for multiple course work items. Course students may only view their own work. Course teachers and domain administrators may view all student submissions. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#modifyAttachments">modifyAttachments(courseId, courseWorkId, id, body, x__xgafv=None)</a></code></p>
<p class="firstline">Modifies attachments of student submission. Attachments may only be added to student submissions whose type is `ASSIGNMENT`. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, if the user is not permitted to modify attachments on the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.</p>
<p class="toc_element">
<code><a href="#patch">patch(courseId, courseWorkId, id, body, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates one or more fields of a student submission. See google.classroom.v1.StudentSubmission for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.</p>
<p class="toc_element">
<code><a href="#reclaim">reclaim(courseId, courseWorkId, id, body, x__xgafv=None)</a></code></p>
<p class="firstline">Reclaims a student submission on behalf of the student that owns it. Reclaiming a student submission transfers ownership of attached Drive files to the student and update the submission state. Only the student that ownes the requested student submission may call this method, and only for a student submission that has been turned in. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, unsubmit the requested student submission, or for access errors. * `FAILED_PRECONDITION` if the student submission has not been turned in. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.</p>
<p class="toc_element">
<code><a href="#return_">return_(courseId, courseWorkId, id, body, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a student submission. Returning a student submission transfers ownership of attached Drive files to the student and may also update the submission state. Unlike the Classroom application, returning a student submission does not set assignedGrade to the draftGrade value. Only a teacher of the course that contains the requested student submission may call this method. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, return the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.</p>
<p class="toc_element">
<code><a href="#turnIn">turnIn(courseId, courseWorkId, id, body, x__xgafv=None)</a></code></p>
<p class="firstline">Turns in a student submission. Turning in a student submission transfers ownership of attached Drive files to the teacher and may also update the submission state. This may only be called by the student that owns the specified student submission. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, turn in the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(courseId, courseWorkId, id, x__xgafv=None)</code>
<pre>Returns a student submission. * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, course work, or student submission or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.
Args:
courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
courseWorkId: string, Identifier of the course work. (required)
id: string, Identifier of the student submission. (required)
x__xgafv: string, V1 error format.
Returns:
An object of the form:
{ # Student submission for course work. StudentSubmission items are generated when a CourseWork item is created. StudentSubmissions that have never been accessed (i.e. with `state` = NEW) may not have a creation time or update time.
"draftGrade": 3.14, # Optional pending grade. If unset, no grade was set. This must be a non-negative integer value. This is only visible to and modifiable by course teachers.
"updateTime": "A String", # Last update time of this submission. This may be unset if the student has not accessed this item. Read-only.
"alternateLink": "A String", # Absolute link to the submission in the Classroom web UI. Read-only.
"courseId": "A String", # Identifier of the course. Read-only.
"userId": "A String", # Identifier for the student that owns this submission. Read-only.
"creationTime": "A String", # Creation time of this submission. This may be unset if the student has not accessed this item. Read-only.
"shortAnswerSubmission": { # Student work for a short answer question. # Submission content when course_work_type is SHORT_ANSWER_QUESTION.
"answer": "A String", # Student response to a short-answer question.
},
"associatedWithDeveloper": True or False, # Whether this student submission is associated with the Developer Console project making the request. See google.classroom.Work.CreateCourseWork for more details. Read-only.
"late": True or False, # Whether this submission is late. Read-only.
"state": "A String", # State of this submission. Read-only.
"courseWorkId": "A String", # Identifier for the course work this corresponds to. Read-only.
"courseWorkType": "A String", # Type of course work this submission is for. Read-only.
"multipleChoiceSubmission": { # Student work for a multiple-choice question. # Submission content when course_work_type is MULTIPLE_CHOICE_QUESTION.
"answer": "A String", # Student's select choice.
},
"assignedGrade": 3.14, # Optional grade. If unset, no grade was set. This must be a non-negative integer value. This may be modified only by course teachers.
"assignmentSubmission": { # Student work for an assignment. # Submission content when course_work_type is ASSIGNMENT .
"attachments": [ # Attachments added by the student. Drive files that correspond to materials with a share mode of SUBMISSION_COPY may not exist yet if the student has not accessed the assignment in Classroom. Some attachment metadata is only populated if the requesting user has permission to access it. Identifier and alternate_link fields are available, but others (e.g. title) may not be.
{ # Attachment added to student assignment work. When creating attachments, only the Link field may be specified.
"link": { # URL item. # Link attachment.
"url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
"thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
"title": "A String", # Title of the target of the URL. Read-only.
},
"driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
"thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
"alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
"id": "A String", # Drive API resource ID.
"title": "A String", # Title of the Drive item. Read-only.
},
"youTubeVideo": { # YouTube video item. # Youtube video attachment.
"thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
"alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
"id": "A String", # YouTube API resource ID.
"title": "A String", # Title of the YouTube video. Read-only.
},
"form": { # Google Forms item. # Google Forms attachment.
"thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
"formUrl": "A String", # URL of the form.
"responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
"title": "A String", # Title of the Form. Read-only.
},
},
],
},
"id": "A String", # Classroom-assigned Identifier for the student submission. This is unique among submissions for the relevant course work. Read-only.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(courseId, courseWorkId, pageSize=None, userId=None, states=None, x__xgafv=None, pageToken=None, late=None)</code>
<pre>Returns a list of student submissions that the requester is permitted to view, factoring in the OAuth scopes of the request. `-` may be specified as the `course_work_id` to include student submissions for multiple course work items. Course students may only view their own work. Course teachers and domain administrators may view all student submissions. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.
Args:
courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
courseWorkId: string, Identifer of the student work to request. This may be set to the string literal `"-"` to request student work for all course work in the specified course. (required)
pageSize: integer, Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
userId: string, Optional argument to restrict returned student work to those owned by the student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
states: string, Requested submission states. If specified, returned student submissions match one of the specified submission states. (repeated)
x__xgafv: string, V1 error format.
pageToken: string, nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
late: string, Requested lateness value. If specified, returned student submissions are restricted by the requested value. If unspecified, submissions are returned regardless of `late` value.
Returns:
An object of the form:
{ # Response when listing student submissions.
"nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available.
"studentSubmissions": [ # Student work that matches the request.
{ # Student submission for course work. StudentSubmission items are generated when a CourseWork item is created. StudentSubmissions that have never been accessed (i.e. with `state` = NEW) may not have a creation time or update time.
"draftGrade": 3.14, # Optional pending grade. If unset, no grade was set. This must be a non-negative integer value. This is only visible to and modifiable by course teachers.
"updateTime": "A String", # Last update time of this submission. This may be unset if the student has not accessed this item. Read-only.
"alternateLink": "A String", # Absolute link to the submission in the Classroom web UI. Read-only.
"courseId": "A String", # Identifier of the course. Read-only.
"userId": "A String", # Identifier for the student that owns this submission. Read-only.
"creationTime": "A String", # Creation time of this submission. This may be unset if the student has not accessed this item. Read-only.
"shortAnswerSubmission": { # Student work for a short answer question. # Submission content when course_work_type is SHORT_ANSWER_QUESTION.
"answer": "A String", # Student response to a short-answer question.
},
"associatedWithDeveloper": True or False, # Whether this student submission is associated with the Developer Console project making the request. See google.classroom.Work.CreateCourseWork for more details. Read-only.
"late": True or False, # Whether this submission is late. Read-only.
"state": "A String", # State of this submission. Read-only.
"courseWorkId": "A String", # Identifier for the course work this corresponds to. Read-only.
"courseWorkType": "A String", # Type of course work this submission is for. Read-only.
"multipleChoiceSubmission": { # Student work for a multiple-choice question. # Submission content when course_work_type is MULTIPLE_CHOICE_QUESTION.
"answer": "A String", # Student's select choice.
},
"assignedGrade": 3.14, # Optional grade. If unset, no grade was set. This must be a non-negative integer value. This may be modified only by course teachers.
"assignmentSubmission": { # Student work for an assignment. # Submission content when course_work_type is ASSIGNMENT .
"attachments": [ # Attachments added by the student. Drive files that correspond to materials with a share mode of SUBMISSION_COPY may not exist yet if the student has not accessed the assignment in Classroom. Some attachment metadata is only populated if the requesting user has permission to access it. Identifier and alternate_link fields are available, but others (e.g. title) may not be.
{ # Attachment added to student assignment work. When creating attachments, only the Link field may be specified.
"link": { # URL item. # Link attachment.
"url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
"thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
"title": "A String", # Title of the target of the URL. Read-only.
},
"driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
"thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
"alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
"id": "A String", # Drive API resource ID.
"title": "A String", # Title of the Drive item. Read-only.
},
"youTubeVideo": { # YouTube video item. # Youtube video attachment.
"thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
"alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
"id": "A String", # YouTube API resource ID.
"title": "A String", # Title of the YouTube video. Read-only.
},
"form": { # Google Forms item. # Google Forms attachment.
"thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
"formUrl": "A String", # URL of the form.
"responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
"title": "A String", # Title of the Form. Read-only.
},
},
],
},
"id": "A String", # Classroom-assigned Identifier for the student submission. This is unique among submissions for the relevant course work. Read-only.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="modifyAttachments">modifyAttachments(courseId, courseWorkId, id, body, x__xgafv=None)</code>
<pre>Modifies attachments of student submission. Attachments may only be added to student submissions whose type is `ASSIGNMENT`. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, if the user is not permitted to modify attachments on the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.
Args:
courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
courseWorkId: string, Identifier of the course work. (required)
id: string, Identifier of the student submission. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Request to modify the attachments of a student submission.
"addAttachments": [ # Attachments to add. A student submission may not have more than 20 attachments. This may only contain link attachments.
{ # Attachment added to student assignment work. When creating attachments, only the Link field may be specified.
"link": { # URL item. # Link attachment.
"url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
"thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
"title": "A String", # Title of the target of the URL. Read-only.
},
"driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
"thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
"alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
"id": "A String", # Drive API resource ID.
"title": "A String", # Title of the Drive item. Read-only.
},
"youTubeVideo": { # YouTube video item. # Youtube video attachment.
"thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
"alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
"id": "A String", # YouTube API resource ID.
"title": "A String", # Title of the YouTube video. Read-only.
},
"form": { # Google Forms item. # Google Forms attachment.
"thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
"formUrl": "A String", # URL of the form.
"responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
"title": "A String", # Title of the Form. Read-only.
},
},
],
}
x__xgafv: string, V1 error format.
Returns:
An object of the form:
{ # Student submission for course work. StudentSubmission items are generated when a CourseWork item is created. StudentSubmissions that have never been accessed (i.e. with `state` = NEW) may not have a creation time or update time.
"draftGrade": 3.14, # Optional pending grade. If unset, no grade was set. This must be a non-negative integer value. This is only visible to and modifiable by course teachers.
"updateTime": "A String", # Last update time of this submission. This may be unset if the student has not accessed this item. Read-only.
"alternateLink": "A String", # Absolute link to the submission in the Classroom web UI. Read-only.
"courseId": "A String", # Identifier of the course. Read-only.
"userId": "A String", # Identifier for the student that owns this submission. Read-only.
"creationTime": "A String", # Creation time of this submission. This may be unset if the student has not accessed this item. Read-only.
"shortAnswerSubmission": { # Student work for a short answer question. # Submission content when course_work_type is SHORT_ANSWER_QUESTION.
"answer": "A String", # Student response to a short-answer question.
},
"associatedWithDeveloper": True or False, # Whether this student submission is associated with the Developer Console project making the request. See google.classroom.Work.CreateCourseWork for more details. Read-only.
"late": True or False, # Whether this submission is late. Read-only.
"state": "A String", # State of this submission. Read-only.
"courseWorkId": "A String", # Identifier for the course work this corresponds to. Read-only.
"courseWorkType": "A String", # Type of course work this submission is for. Read-only.
"multipleChoiceSubmission": { # Student work for a multiple-choice question. # Submission content when course_work_type is MULTIPLE_CHOICE_QUESTION.
"answer": "A String", # Student's select choice.
},
"assignedGrade": 3.14, # Optional grade. If unset, no grade was set. This must be a non-negative integer value. This may be modified only by course teachers.
"assignmentSubmission": { # Student work for an assignment. # Submission content when course_work_type is ASSIGNMENT .
"attachments": [ # Attachments added by the student. Drive files that correspond to materials with a share mode of SUBMISSION_COPY may not exist yet if the student has not accessed the assignment in Classroom. Some attachment metadata is only populated if the requesting user has permission to access it. Identifier and alternate_link fields are available, but others (e.g. title) may not be.
{ # Attachment added to student assignment work. When creating attachments, only the Link field may be specified.
"link": { # URL item. # Link attachment.
"url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
"thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
"title": "A String", # Title of the target of the URL. Read-only.
},
"driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
"thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
"alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
"id": "A String", # Drive API resource ID.
"title": "A String", # Title of the Drive item. Read-only.
},
"youTubeVideo": { # YouTube video item. # Youtube video attachment.
"thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
"alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
"id": "A String", # YouTube API resource ID.
"title": "A String", # Title of the YouTube video. Read-only.
},
"form": { # Google Forms item. # Google Forms attachment.
"thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
"formUrl": "A String", # URL of the form.
"responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
"title": "A String", # Title of the Form. Read-only.
},
},
],
},
"id": "A String", # Classroom-assigned Identifier for the student submission. This is unique among submissions for the relevant course work. Read-only.
}</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(courseId, courseWorkId, id, body, updateMask=None, x__xgafv=None)</code>
<pre>Updates one or more fields of a student submission. See google.classroom.v1.StudentSubmission for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.
Args:
courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
courseWorkId: string, Identifier of the course work. (required)
id: string, Identifier of the student submission. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Student submission for course work. StudentSubmission items are generated when a CourseWork item is created. StudentSubmissions that have never been accessed (i.e. with `state` = NEW) may not have a creation time or update time.
"draftGrade": 3.14, # Optional pending grade. If unset, no grade was set. This must be a non-negative integer value. This is only visible to and modifiable by course teachers.
"updateTime": "A String", # Last update time of this submission. This may be unset if the student has not accessed this item. Read-only.
"alternateLink": "A String", # Absolute link to the submission in the Classroom web UI. Read-only.
"courseId": "A String", # Identifier of the course. Read-only.
"userId": "A String", # Identifier for the student that owns this submission. Read-only.
"creationTime": "A String", # Creation time of this submission. This may be unset if the student has not accessed this item. Read-only.
"shortAnswerSubmission": { # Student work for a short answer question. # Submission content when course_work_type is SHORT_ANSWER_QUESTION.
"answer": "A String", # Student response to a short-answer question.
},
"associatedWithDeveloper": True or False, # Whether this student submission is associated with the Developer Console project making the request. See google.classroom.Work.CreateCourseWork for more details. Read-only.
"late": True or False, # Whether this submission is late. Read-only.
"state": "A String", # State of this submission. Read-only.
"courseWorkId": "A String", # Identifier for the course work this corresponds to. Read-only.
"courseWorkType": "A String", # Type of course work this submission is for. Read-only.
"multipleChoiceSubmission": { # Student work for a multiple-choice question. # Submission content when course_work_type is MULTIPLE_CHOICE_QUESTION.
"answer": "A String", # Student's select choice.
},
"assignedGrade": 3.14, # Optional grade. If unset, no grade was set. This must be a non-negative integer value. This may be modified only by course teachers.
"assignmentSubmission": { # Student work for an assignment. # Submission content when course_work_type is ASSIGNMENT .
"attachments": [ # Attachments added by the student. Drive files that correspond to materials with a share mode of SUBMISSION_COPY may not exist yet if the student has not accessed the assignment in Classroom. Some attachment metadata is only populated if the requesting user has permission to access it. Identifier and alternate_link fields are available, but others (e.g. title) may not be.
{ # Attachment added to student assignment work. When creating attachments, only the Link field may be specified.
"link": { # URL item. # Link attachment.
"url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
"thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
"title": "A String", # Title of the target of the URL. Read-only.
},
"driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
"thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
"alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
"id": "A String", # Drive API resource ID.
"title": "A String", # Title of the Drive item. Read-only.
},
"youTubeVideo": { # YouTube video item. # Youtube video attachment.
"thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
"alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
"id": "A String", # YouTube API resource ID.
"title": "A String", # Title of the YouTube video. Read-only.
},
"form": { # Google Forms item. # Google Forms attachment.
"thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
"formUrl": "A String", # URL of the form.
"responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
"title": "A String", # Title of the Form. Read-only.
},
},
],
},
"id": "A String", # Classroom-assigned Identifier for the student submission. This is unique among submissions for the relevant course work. Read-only.
}
updateMask: string, Mask that identifies which fields on the student submission to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields may be specified by teachers: * `draft_grade` * `assigned_grade`
x__xgafv: string, V1 error format.
Returns:
An object of the form:
{ # Student submission for course work. StudentSubmission items are generated when a CourseWork item is created. StudentSubmissions that have never been accessed (i.e. with `state` = NEW) may not have a creation time or update time.
"draftGrade": 3.14, # Optional pending grade. If unset, no grade was set. This must be a non-negative integer value. This is only visible to and modifiable by course teachers.
"updateTime": "A String", # Last update time of this submission. This may be unset if the student has not accessed this item. Read-only.
"alternateLink": "A String", # Absolute link to the submission in the Classroom web UI. Read-only.
"courseId": "A String", # Identifier of the course. Read-only.
"userId": "A String", # Identifier for the student that owns this submission. Read-only.
"creationTime": "A String", # Creation time of this submission. This may be unset if the student has not accessed this item. Read-only.
"shortAnswerSubmission": { # Student work for a short answer question. # Submission content when course_work_type is SHORT_ANSWER_QUESTION.
"answer": "A String", # Student response to a short-answer question.
},
"associatedWithDeveloper": True or False, # Whether this student submission is associated with the Developer Console project making the request. See google.classroom.Work.CreateCourseWork for more details. Read-only.
"late": True or False, # Whether this submission is late. Read-only.
"state": "A String", # State of this submission. Read-only.
"courseWorkId": "A String", # Identifier for the course work this corresponds to. Read-only.
"courseWorkType": "A String", # Type of course work this submission is for. Read-only.
"multipleChoiceSubmission": { # Student work for a multiple-choice question. # Submission content when course_work_type is MULTIPLE_CHOICE_QUESTION.
"answer": "A String", # Student's select choice.
},
"assignedGrade": 3.14, # Optional grade. If unset, no grade was set. This must be a non-negative integer value. This may be modified only by course teachers.
"assignmentSubmission": { # Student work for an assignment. # Submission content when course_work_type is ASSIGNMENT .
"attachments": [ # Attachments added by the student. Drive files that correspond to materials with a share mode of SUBMISSION_COPY may not exist yet if the student has not accessed the assignment in Classroom. Some attachment metadata is only populated if the requesting user has permission to access it. Identifier and alternate_link fields are available, but others (e.g. title) may not be.
{ # Attachment added to student assignment work. When creating attachments, only the Link field may be specified.
"link": { # URL item. # Link attachment.
"url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
"thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
"title": "A String", # Title of the target of the URL. Read-only.
},
"driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
"thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
"alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
"id": "A String", # Drive API resource ID.
"title": "A String", # Title of the Drive item. Read-only.
},
"youTubeVideo": { # YouTube video item. # Youtube video attachment.
"thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
"alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
"id": "A String", # YouTube API resource ID.
"title": "A String", # Title of the YouTube video. Read-only.
},
"form": { # Google Forms item. # Google Forms attachment.
"thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
"formUrl": "A String", # URL of the form.
"responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
"title": "A String", # Title of the Form. Read-only.
},
},
],
},
"id": "A String", # Classroom-assigned Identifier for the student submission. This is unique among submissions for the relevant course work. Read-only.
}</pre>
</div>
<div class="method">
<code class="details" id="reclaim">reclaim(courseId, courseWorkId, id, body, x__xgafv=None)</code>
<pre>Reclaims a student submission on behalf of the student that owns it. Reclaiming a student submission transfers ownership of attached Drive files to the student and update the submission state. Only the student that ownes the requested student submission may call this method, and only for a student submission that has been turned in. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, unsubmit the requested student submission, or for access errors. * `FAILED_PRECONDITION` if the student submission has not been turned in. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.
Args:
courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
courseWorkId: string, Identifier of the course work. (required)
id: string, Identifier of the student submission. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Request to reclaim a student submission.
}
x__xgafv: string, V1 error format.
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
}</pre>
</div>
<div class="method">
<code class="details" id="return_">return_(courseId, courseWorkId, id, body, x__xgafv=None)</code>
<pre>Returns a student submission. Returning a student submission transfers ownership of attached Drive files to the student and may also update the submission state. Unlike the Classroom application, returning a student submission does not set assignedGrade to the draftGrade value. Only a teacher of the course that contains the requested student submission may call this method. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, return the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.
Args:
courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
courseWorkId: string, Identifier of the course work. (required)
id: string, Identifier of the student submission. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Request to return a student submission.
}
x__xgafv: string, V1 error format.
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
}</pre>
</div>
<div class="method">
<code class="details" id="turnIn">turnIn(courseId, courseWorkId, id, body, x__xgafv=None)</code>
<pre>Turns in a student submission. Turning in a student submission transfers ownership of attached Drive files to the teacher and may also update the submission state. This may only be called by the student that owns the specified student submission. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, turn in the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.
Args:
courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
courseWorkId: string, Identifier of the course work. (required)
id: string, Identifier of the student submission. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Request to turn in a student submission.
}
x__xgafv: string, V1 error format.
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
}</pre>
</div>
</body></html>
|
