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
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
|
<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></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="classroom_v1.courses.aliases.html">aliases()</a></code>
</p>
<p class="firstline">Returns the aliases Resource.</p>
<p class="toc_element">
<code><a href="classroom_v1.courses.courseWork.html">courseWork()</a></code>
</p>
<p class="firstline">Returns the courseWork Resource.</p>
<p class="toc_element">
<code><a href="classroom_v1.courses.students.html">students()</a></code>
</p>
<p class="firstline">Returns the students Resource.</p>
<p class="toc_element">
<code><a href="classroom_v1.courses.teachers.html">teachers()</a></code>
</p>
<p class="firstline">Returns the teachers Resource.</p>
<p class="toc_element">
<code><a href="#create">create(body, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a course. The user specified in `ownerId` is the owner of the created course and added as a teacher. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create courses or for access errors. * `NOT_FOUND` if the primary teacher is not a valid user. * `FAILED_PRECONDITION` if the course owner's account is disabled or for the following request errors: * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if an alias was specified in the `id` and already exists.</p>
<p class="toc_element">
<code><a href="#delete">delete(id, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.</p>
<p class="toc_element">
<code><a href="#get">get(id, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.</p>
<p class="toc_element">
<code><a href="#list">list(studentId=None, pageSize=None, courseStates=None, teacherId=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the query argument is malformed. * `NOT_FOUND` if any users specified in the query arguments do not exist.</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="#patch">patch(id, body, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates one or more fields in a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable</p>
<p class="toc_element">
<code><a href="#update">update(id, body, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(body, x__xgafv=None)</code>
<pre>Creates a course. The user specified in `ownerId` is the owner of the created course and added as a teacher. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create courses or for access errors. * `NOT_FOUND` if the primary teacher is not a valid user. * `FAILED_PRECONDITION` if the course owner's account is disabled or for the following request errors: * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if an alias was specified in the `id` and already exists.
Args:
body: object, The request body. (required)
The object takes the form of:
{ # A Course in Classroom.
"updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
"guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
"description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.
"alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
"enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.
"section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
"teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only.
"alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
"id": "A String", # Drive API resource ID.
"title": "A String", # Title of the Drive folder. Read-only.
},
"creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
"name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
"teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only.
"courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
{ # A set of materials that appears on the "About" page of the course. These materials might include a syllabus, schedule, or other background information relating to the course as a whole.
"materials": [ # Materials attached to this set.
{ # A material attached to a course as part of a material set.
"link": { # URL item. # Link atatchment.
"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.
},
},
],
"title": "A String", # Title for this set.
},
],
"courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
"courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only.
"ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Specifying this field in a course update mask results in an `INVALID_ARGUMENT` error.
"id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error.
"descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters.
"room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters.
}
x__xgafv: string, V1 error format.
Returns:
An object of the form:
{ # A Course in Classroom.
"updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
"guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
"description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.
"alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
"enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.
"section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
"teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only.
"alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
"id": "A String", # Drive API resource ID.
"title": "A String", # Title of the Drive folder. Read-only.
},
"creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
"name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
"teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only.
"courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
{ # A set of materials that appears on the "About" page of the course. These materials might include a syllabus, schedule, or other background information relating to the course as a whole.
"materials": [ # Materials attached to this set.
{ # A material attached to a course as part of a material set.
"link": { # URL item. # Link atatchment.
"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.
},
},
],
"title": "A String", # Title for this set.
},
],
"courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
"courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only.
"ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Specifying this field in a course update mask results in an `INVALID_ARGUMENT` error.
"id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error.
"descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters.
"room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(id, x__xgafv=None)</code>
<pre>Deletes a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.
Args:
id: string, Identifier of the course to delete. This identifier can be either the Classroom-assigned identifier or an alias. (required)
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="get">get(id, x__xgafv=None)</code>
<pre>Returns a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.
Args:
id: string, Identifier of the course to return. This identifier can be either the Classroom-assigned identifier or an alias. (required)
x__xgafv: string, V1 error format.
Returns:
An object of the form:
{ # A Course in Classroom.
"updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
"guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
"description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.
"alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
"enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.
"section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
"teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only.
"alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
"id": "A String", # Drive API resource ID.
"title": "A String", # Title of the Drive folder. Read-only.
},
"creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
"name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
"teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only.
"courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
{ # A set of materials that appears on the "About" page of the course. These materials might include a syllabus, schedule, or other background information relating to the course as a whole.
"materials": [ # Materials attached to this set.
{ # A material attached to a course as part of a material set.
"link": { # URL item. # Link atatchment.
"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.
},
},
],
"title": "A String", # Title for this set.
},
],
"courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
"courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only.
"ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Specifying this field in a course update mask results in an `INVALID_ARGUMENT` error.
"id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error.
"descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters.
"room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(studentId=None, pageSize=None, courseStates=None, teacherId=None, pageToken=None, x__xgafv=None)</code>
<pre>Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the query argument is malformed. * `NOT_FOUND` if any users specified in the query arguments do not exist.
Args:
studentId: string, Restricts returned courses to those having a student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
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.
courseStates: string, Restricts returned courses to those in one of the specified states (repeated)
teacherId: string, Restricts returned courses to those having a teacher with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
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.
x__xgafv: string, V1 error format.
Returns:
An object of the form:
{ # Response when listing courses.
"nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available.
"courses": [ # Courses that match the list request.
{ # A Course in Classroom.
"updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
"guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
"description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.
"alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
"enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.
"section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
"teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only.
"alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
"id": "A String", # Drive API resource ID.
"title": "A String", # Title of the Drive folder. Read-only.
},
"creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
"name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
"teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only.
"courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
{ # A set of materials that appears on the "About" page of the course. These materials might include a syllabus, schedule, or other background information relating to the course as a whole.
"materials": [ # Materials attached to this set.
{ # A material attached to a course as part of a material set.
"link": { # URL item. # Link atatchment.
"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.
},
},
],
"title": "A String", # Title for this set.
},
],
"courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
"courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only.
"ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Specifying this field in a course update mask results in an `INVALID_ARGUMENT` error.
"id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error.
"descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters.
"room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters.
},
],
}</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="patch">patch(id, body, updateMask=None, x__xgafv=None)</code>
<pre>Updates one or more fields in a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable
Args:
id: string, Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias. (required)
body: object, The request body. (required)
The object takes the form of:
{ # A Course in Classroom.
"updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
"guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
"description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.
"alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
"enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.
"section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
"teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only.
"alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
"id": "A String", # Drive API resource ID.
"title": "A String", # Title of the Drive folder. Read-only.
},
"creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
"name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
"teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only.
"courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
{ # A set of materials that appears on the "About" page of the course. These materials might include a syllabus, schedule, or other background information relating to the course as a whole.
"materials": [ # Materials attached to this set.
{ # A material attached to a course as part of a material set.
"link": { # URL item. # Link atatchment.
"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.
},
},
],
"title": "A String", # Title for this set.
},
],
"courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
"courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only.
"ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Specifying this field in a course update mask results in an `INVALID_ARGUMENT` error.
"id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error.
"descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters.
"room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters.
}
updateMask: string, Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: * `name` * `section` * `descriptionHeading` * `description` * `room` * `courseState` When set in a query parameter, this field should be specified as `updateMask=,,...`
x__xgafv: string, V1 error format.
Returns:
An object of the form:
{ # A Course in Classroom.
"updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
"guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
"description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.
"alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
"enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.
"section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
"teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only.
"alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
"id": "A String", # Drive API resource ID.
"title": "A String", # Title of the Drive folder. Read-only.
},
"creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
"name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
"teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only.
"courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
{ # A set of materials that appears on the "About" page of the course. These materials might include a syllabus, schedule, or other background information relating to the course as a whole.
"materials": [ # Materials attached to this set.
{ # A material attached to a course as part of a material set.
"link": { # URL item. # Link atatchment.
"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.
},
},
],
"title": "A String", # Title for this set.
},
],
"courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
"courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only.
"ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Specifying this field in a course update mask results in an `INVALID_ARGUMENT` error.
"id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error.
"descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters.
"room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(id, body, x__xgafv=None)</code>
<pre>Updates a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable
Args:
id: string, Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias. (required)
body: object, The request body. (required)
The object takes the form of:
{ # A Course in Classroom.
"updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
"guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
"description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.
"alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
"enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.
"section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
"teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only.
"alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
"id": "A String", # Drive API resource ID.
"title": "A String", # Title of the Drive folder. Read-only.
},
"creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
"name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
"teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only.
"courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
{ # A set of materials that appears on the "About" page of the course. These materials might include a syllabus, schedule, or other background information relating to the course as a whole.
"materials": [ # Materials attached to this set.
{ # A material attached to a course as part of a material set.
"link": { # URL item. # Link atatchment.
"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.
},
},
],
"title": "A String", # Title for this set.
},
],
"courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
"courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only.
"ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Specifying this field in a course update mask results in an `INVALID_ARGUMENT` error.
"id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error.
"descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters.
"room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters.
}
x__xgafv: string, V1 error format.
Returns:
An object of the form:
{ # A Course in Classroom.
"updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
"guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
"description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.
"alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
"enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.
"section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
"teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only.
"alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
"id": "A String", # Drive API resource ID.
"title": "A String", # Title of the Drive folder. Read-only.
},
"creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
"name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
"teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only.
"courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
{ # A set of materials that appears on the "About" page of the course. These materials might include a syllabus, schedule, or other background information relating to the course as a whole.
"materials": [ # Materials attached to this set.
{ # A material attached to a course as part of a material set.
"link": { # URL item. # Link atatchment.
"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.
},
},
],
"title": "A String", # Title for this set.
},
],
"courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
"courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only.
"ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Specifying this field in a course update mask results in an `INVALID_ARGUMENT` error.
"id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error.
"descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters.
"room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters.
}</pre>
</div>
</body></html>
|
