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
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
|
<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.announcements.html">announcements</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="classroom_v1.courses.announcements.addOnAttachments.html">addOnAttachments()</a></code>
</p>
<p class="firstline">Returns the addOnAttachments Resource.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(courseId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create announcements in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible</p>
<p class="toc_element">
<code><a href="#delete">delete(courseId, id, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes an announcement. 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 announcement item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding announcement, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested announcement has already been deleted. * `NOT_FOUND` if no course exists with the requested ID.</p>
<p class="toc_element">
<code><a href="#get">get(courseId, id, x__xgafv=None)</a></code></p>
<p class="firstline">Returns an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or announcement, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or announcement does not exist.</p>
<p class="toc_element">
<code><a href="#getAddOnContext">getAddOnContext(courseId, itemId, addOnToken=None, attachmentId=None, postId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets metadata for Classroom add-ons in the context of a specific post. To maintain the integrity of its own data and permissions model, an add-on should call this to validate query parameters and the requesting user's role whenever the add-on is opened in an [iframe](https://developers.google.com/workspace/classroom/add-ons/get-started/iframes/iframes-overview). This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.</p>
<p class="toc_element">
<code><a href="#list">list(courseId, announcementStates=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a list of announcements that the requester is permitted to view. Course students may only view `PUBLISHED` announcements. Course teachers and domain administrators may view all announcements. 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. * `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()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#modifyAssignees">modifyAssignees(courseId, id, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Modifies assignee mode and options of an announcement. Only a teacher of the course that contains the announcement may call this method. 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 or course work does not exist.</p>
<p class="toc_element">
<code><a href="#patch">patch(courseId, id, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates one or more fields of an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding announcement or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested announcement has already been deleted. * `NOT_FOUND` if the requested course or announcement does not exist</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(courseId, body=None, x__xgafv=None)</code>
<pre>Creates an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create announcements in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible
Args:
courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
body: object, The request body.
The object takes the form of:
{ # Announcement created by a teacher for students of the course
"alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
"assigneeMode": "A String", # Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.
"courseId": "A String", # Identifier of the course. Read-only.
"creationTime": "A String", # Timestamp when this announcement was created. Read-only.
"creatorUserId": "A String", # Identifier for the user that created the announcement. Read-only.
"id": "A String", # Classroom-assigned identifier of this announcement, unique per course. Read-only.
"individualStudentsOptions": { # Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. # Identifiers of students with access to the announcement. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field can see the announcement.
"studentIds": [ # Identifiers for the students that have access to the coursework/announcement.
"A String",
],
},
"materials": [ # Additional materials. Announcements must have no more than 20 material items.
{ # Material attached to course work. When creating attachments, setting the `form`, `gem`, or `notebook` field is not supported.
"driveFile": { # Drive file that is used as material for course work. # Google Drive file material.
"driveFile": { # Representation of a Google Drive file. # Drive file details.
"alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
"id": "A String", # Drive API resource ID.
"thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
"title": "A String", # Title of the Drive item. Read-only.
},
"shareMode": "A String", # Mechanism by which students access the Drive item.
},
"form": { # Google Forms item. # Google Forms material. Read-only.
"formUrl": "A String", # URL of the form.
"responseUrl": "A String", # URL of the form responses document. Only set if responses have been recorded and only when the requesting user is an editor of the form. Read-only.
"thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
"title": "A String", # Title of the Form. Read-only.
},
"gem": { # Gemini Gem link. # Gemini Gem material. Read-only.
"id": "A String", # Gems resource id.
"title": "A String", # Title of the Gem. Read-only.
"url": "A String", # URL that can be used to access the Gem. Read-only.
},
"link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response.
"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.
"url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
},
"notebook": { # NotebookLM Notebook link. # NotebookLM Notebook material. Read-only.
"id": "A String", # Notebook resource id.
"title": "A String", # Title of the Notebook. Read-only.
"url": "A String", # URL that can be used to access the Notebook. Read-only.
},
"youtubeVideo": { # YouTube video item. # YouTube video material.
"alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
"id": "A String", # YouTube API resource ID.
"thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
"title": "A String", # Title of the YouTube video. Read-only.
},
},
],
"scheduledTime": "A String", # Optional timestamp when this announcement is scheduled to be published.
"state": "A String", # Status of this announcement. If unspecified, the default state is `DRAFT`.
"text": "A String", # Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters.
"updateTime": "A String", # Timestamp of the most recent change to this announcement. Read-only.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Announcement created by a teacher for students of the course
"alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
"assigneeMode": "A String", # Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.
"courseId": "A String", # Identifier of the course. Read-only.
"creationTime": "A String", # Timestamp when this announcement was created. Read-only.
"creatorUserId": "A String", # Identifier for the user that created the announcement. Read-only.
"id": "A String", # Classroom-assigned identifier of this announcement, unique per course. Read-only.
"individualStudentsOptions": { # Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. # Identifiers of students with access to the announcement. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field can see the announcement.
"studentIds": [ # Identifiers for the students that have access to the coursework/announcement.
"A String",
],
},
"materials": [ # Additional materials. Announcements must have no more than 20 material items.
{ # Material attached to course work. When creating attachments, setting the `form`, `gem`, or `notebook` field is not supported.
"driveFile": { # Drive file that is used as material for course work. # Google Drive file material.
"driveFile": { # Representation of a Google Drive file. # Drive file details.
"alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
"id": "A String", # Drive API resource ID.
"thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
"title": "A String", # Title of the Drive item. Read-only.
},
"shareMode": "A String", # Mechanism by which students access the Drive item.
},
"form": { # Google Forms item. # Google Forms material. Read-only.
"formUrl": "A String", # URL of the form.
"responseUrl": "A String", # URL of the form responses document. Only set if responses have been recorded and only when the requesting user is an editor of the form. Read-only.
"thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
"title": "A String", # Title of the Form. Read-only.
},
"gem": { # Gemini Gem link. # Gemini Gem material. Read-only.
"id": "A String", # Gems resource id.
"title": "A String", # Title of the Gem. Read-only.
"url": "A String", # URL that can be used to access the Gem. Read-only.
},
"link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response.
"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.
"url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
},
"notebook": { # NotebookLM Notebook link. # NotebookLM Notebook material. Read-only.
"id": "A String", # Notebook resource id.
"title": "A String", # Title of the Notebook. Read-only.
"url": "A String", # URL that can be used to access the Notebook. Read-only.
},
"youtubeVideo": { # YouTube video item. # YouTube video material.
"alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
"id": "A String", # YouTube API resource ID.
"thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
"title": "A String", # Title of the YouTube video. Read-only.
},
},
],
"scheduledTime": "A String", # Optional timestamp when this announcement is scheduled to be published.
"state": "A String", # Status of this announcement. If unspecified, the default state is `DRAFT`.
"text": "A String", # Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters.
"updateTime": "A String", # Timestamp of the most recent change to this announcement. Read-only.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(courseId, id, x__xgafv=None)</code>
<pre>Deletes an announcement. 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 announcement item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding announcement, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested announcement has already been deleted. * `NOT_FOUND` if no course exists with the requested ID.
Args:
courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
id: string, Identifier of the announcement to delete. This identifier is a Classroom-assigned identifier. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 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); }
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(courseId, id, x__xgafv=None)</code>
<pre>Returns an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or announcement, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or announcement does not exist.
Args:
courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
id: string, Identifier of the announcement. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Announcement created by a teacher for students of the course
"alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
"assigneeMode": "A String", # Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.
"courseId": "A String", # Identifier of the course. Read-only.
"creationTime": "A String", # Timestamp when this announcement was created. Read-only.
"creatorUserId": "A String", # Identifier for the user that created the announcement. Read-only.
"id": "A String", # Classroom-assigned identifier of this announcement, unique per course. Read-only.
"individualStudentsOptions": { # Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. # Identifiers of students with access to the announcement. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field can see the announcement.
"studentIds": [ # Identifiers for the students that have access to the coursework/announcement.
"A String",
],
},
"materials": [ # Additional materials. Announcements must have no more than 20 material items.
{ # Material attached to course work. When creating attachments, setting the `form`, `gem`, or `notebook` field is not supported.
"driveFile": { # Drive file that is used as material for course work. # Google Drive file material.
"driveFile": { # Representation of a Google Drive file. # Drive file details.
"alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
"id": "A String", # Drive API resource ID.
"thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
"title": "A String", # Title of the Drive item. Read-only.
},
"shareMode": "A String", # Mechanism by which students access the Drive item.
},
"form": { # Google Forms item. # Google Forms material. Read-only.
"formUrl": "A String", # URL of the form.
"responseUrl": "A String", # URL of the form responses document. Only set if responses have been recorded and only when the requesting user is an editor of the form. Read-only.
"thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
"title": "A String", # Title of the Form. Read-only.
},
"gem": { # Gemini Gem link. # Gemini Gem material. Read-only.
"id": "A String", # Gems resource id.
"title": "A String", # Title of the Gem. Read-only.
"url": "A String", # URL that can be used to access the Gem. Read-only.
},
"link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response.
"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.
"url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
},
"notebook": { # NotebookLM Notebook link. # NotebookLM Notebook material. Read-only.
"id": "A String", # Notebook resource id.
"title": "A String", # Title of the Notebook. Read-only.
"url": "A String", # URL that can be used to access the Notebook. Read-only.
},
"youtubeVideo": { # YouTube video item. # YouTube video material.
"alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
"id": "A String", # YouTube API resource ID.
"thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
"title": "A String", # Title of the YouTube video. Read-only.
},
},
],
"scheduledTime": "A String", # Optional timestamp when this announcement is scheduled to be published.
"state": "A String", # Status of this announcement. If unspecified, the default state is `DRAFT`.
"text": "A String", # Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters.
"updateTime": "A String", # Timestamp of the most recent change to this announcement. Read-only.
}</pre>
</div>
<div class="method">
<code class="details" id="getAddOnContext">getAddOnContext(courseId, itemId, addOnToken=None, attachmentId=None, postId=None, x__xgafv=None)</code>
<pre>Gets metadata for Classroom add-ons in the context of a specific post. To maintain the integrity of its own data and permissions model, an add-on should call this to validate query parameters and the requesting user's role whenever the add-on is opened in an [iframe](https://developers.google.com/workspace/classroom/add-ons/get-started/iframes/iframes-overview). This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.
Args:
courseId: string, Required. Identifier of the course. (required)
itemId: string, Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. (required)
addOnToken: string, Optional. Token that authorizes the request. The token is passed as a query parameter when the user is redirected from Classroom to the add-on's URL. The authorization token is required when neither of the following is true: * The add-on has attachments on the post. * The developer project issuing the request is the same project that created the post.
attachmentId: string, Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/workspace/classroom/add-ons/get-started/iframes/attachment-discovery-iframe).
postId: string, Optional. Deprecated, use `item_id` instead.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Attachment-relevant metadata for Classroom add-ons in the context of a specific post.
"courseId": "A String", # Immutable. Identifier of the course.
"itemId": "A String", # Immutable. Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached.
"postId": "A String", # Immutable. Deprecated, use `item_id` instead.
"studentContext": { # Role-specific context if the requesting user is a student. # Add-on context corresponding to the requesting user's role as a student. Its presence implies that the requesting user is a student in the course.
"submissionId": "A String", # Requesting user's submission id to be used for grade passback and to identify the student when showing student work to the teacher. This is set exactly when `supportsStudentWork` is `true`.
},
"supportsStudentWork": True or False, # Optional. Whether the post allows the teacher to see student work and passback grades.
"teacherContext": { # Role-specific context if the requesting user is a teacher. # Add-on context corresponding to the requesting user's role as a teacher. Its presence implies that the requesting user is a teacher in the course.
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(courseId, announcementStates=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Returns a list of announcements that the requester is permitted to view. Course students may only view `PUBLISHED` announcements. Course teachers and domain administrators may view all announcements. 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. * `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)
announcementStates: string, Restriction on the `state` of announcements returned. If this argument is left unspecified, the default value is `PUBLISHED`. (repeated)
Allowed values
ANNOUNCEMENT_STATE_UNSPECIFIED - No state specified. This is never returned.
PUBLISHED - Status for announcement that has been published. This is the default state.
DRAFT - Status for an announcement that is not yet published. Announcement in this state is visible only to course teachers and domain administrators.
DELETED - Status for announcement that was published but is now deleted. Announcement in this state is visible only to course teachers and domain administrators. Announcement in this state is deleted after some time.
orderBy: string, Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported field is `updateTime`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `updateTime asc`, `updateTime`
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.
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.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response when listing course work.
"announcements": [ # Announcement items that match the request.
{ # Announcement created by a teacher for students of the course
"alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
"assigneeMode": "A String", # Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.
"courseId": "A String", # Identifier of the course. Read-only.
"creationTime": "A String", # Timestamp when this announcement was created. Read-only.
"creatorUserId": "A String", # Identifier for the user that created the announcement. Read-only.
"id": "A String", # Classroom-assigned identifier of this announcement, unique per course. Read-only.
"individualStudentsOptions": { # Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. # Identifiers of students with access to the announcement. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field can see the announcement.
"studentIds": [ # Identifiers for the students that have access to the coursework/announcement.
"A String",
],
},
"materials": [ # Additional materials. Announcements must have no more than 20 material items.
{ # Material attached to course work. When creating attachments, setting the `form`, `gem`, or `notebook` field is not supported.
"driveFile": { # Drive file that is used as material for course work. # Google Drive file material.
"driveFile": { # Representation of a Google Drive file. # Drive file details.
"alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
"id": "A String", # Drive API resource ID.
"thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
"title": "A String", # Title of the Drive item. Read-only.
},
"shareMode": "A String", # Mechanism by which students access the Drive item.
},
"form": { # Google Forms item. # Google Forms material. Read-only.
"formUrl": "A String", # URL of the form.
"responseUrl": "A String", # URL of the form responses document. Only set if responses have been recorded and only when the requesting user is an editor of the form. Read-only.
"thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
"title": "A String", # Title of the Form. Read-only.
},
"gem": { # Gemini Gem link. # Gemini Gem material. Read-only.
"id": "A String", # Gems resource id.
"title": "A String", # Title of the Gem. Read-only.
"url": "A String", # URL that can be used to access the Gem. Read-only.
},
"link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response.
"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.
"url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
},
"notebook": { # NotebookLM Notebook link. # NotebookLM Notebook material. Read-only.
"id": "A String", # Notebook resource id.
"title": "A String", # Title of the Notebook. Read-only.
"url": "A String", # URL that can be used to access the Notebook. Read-only.
},
"youtubeVideo": { # YouTube video item. # YouTube video material.
"alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
"id": "A String", # YouTube API resource ID.
"thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
"title": "A String", # Title of the YouTube video. Read-only.
},
},
],
"scheduledTime": "A String", # Optional timestamp when this announcement is scheduled to be published.
"state": "A String", # Status of this announcement. If unspecified, the default state is `DRAFT`.
"text": "A String", # Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters.
"updateTime": "A String", # Timestamp of the most recent change to this announcement. Read-only.
},
],
"nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</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="modifyAssignees">modifyAssignees(courseId, id, body=None, x__xgafv=None)</code>
<pre>Modifies assignee mode and options of an announcement. Only a teacher of the course that contains the announcement may call this method. 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 or course work does not exist.
Args:
courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
id: string, Identifier of the announcement. (required)
body: object, The request body.
The object takes the form of:
{ # Request to modify assignee mode and options of an announcement.
"assigneeMode": "A String", # Mode of the announcement describing whether it is accessible by all students or specified individual students.
"modifyIndividualStudentsOptions": { # Contains fields to add or remove students from a course work or announcement where the `assigneeMode` is set to `INDIVIDUAL_STUDENTS`. # Set which students can view or cannot view the announcement. Must be specified only when `assigneeMode` is `INDIVIDUAL_STUDENTS`.
"addStudentIds": [ # IDs of students to be added as having access to this coursework/announcement.
"A String",
],
"removeStudentIds": [ # IDs of students to be removed from having access to this coursework/announcement.
"A String",
],
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Announcement created by a teacher for students of the course
"alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
"assigneeMode": "A String", # Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.
"courseId": "A String", # Identifier of the course. Read-only.
"creationTime": "A String", # Timestamp when this announcement was created. Read-only.
"creatorUserId": "A String", # Identifier for the user that created the announcement. Read-only.
"id": "A String", # Classroom-assigned identifier of this announcement, unique per course. Read-only.
"individualStudentsOptions": { # Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. # Identifiers of students with access to the announcement. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field can see the announcement.
"studentIds": [ # Identifiers for the students that have access to the coursework/announcement.
"A String",
],
},
"materials": [ # Additional materials. Announcements must have no more than 20 material items.
{ # Material attached to course work. When creating attachments, setting the `form`, `gem`, or `notebook` field is not supported.
"driveFile": { # Drive file that is used as material for course work. # Google Drive file material.
"driveFile": { # Representation of a Google Drive file. # Drive file details.
"alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
"id": "A String", # Drive API resource ID.
"thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
"title": "A String", # Title of the Drive item. Read-only.
},
"shareMode": "A String", # Mechanism by which students access the Drive item.
},
"form": { # Google Forms item. # Google Forms material. Read-only.
"formUrl": "A String", # URL of the form.
"responseUrl": "A String", # URL of the form responses document. Only set if responses have been recorded and only when the requesting user is an editor of the form. Read-only.
"thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
"title": "A String", # Title of the Form. Read-only.
},
"gem": { # Gemini Gem link. # Gemini Gem material. Read-only.
"id": "A String", # Gems resource id.
"title": "A String", # Title of the Gem. Read-only.
"url": "A String", # URL that can be used to access the Gem. Read-only.
},
"link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response.
"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.
"url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
},
"notebook": { # NotebookLM Notebook link. # NotebookLM Notebook material. Read-only.
"id": "A String", # Notebook resource id.
"title": "A String", # Title of the Notebook. Read-only.
"url": "A String", # URL that can be used to access the Notebook. Read-only.
},
"youtubeVideo": { # YouTube video item. # YouTube video material.
"alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
"id": "A String", # YouTube API resource ID.
"thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
"title": "A String", # Title of the YouTube video. Read-only.
},
},
],
"scheduledTime": "A String", # Optional timestamp when this announcement is scheduled to be published.
"state": "A String", # Status of this announcement. If unspecified, the default state is `DRAFT`.
"text": "A String", # Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters.
"updateTime": "A String", # Timestamp of the most recent change to this announcement. Read-only.
}</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(courseId, id, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates one or more fields of an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding announcement or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested announcement has already been deleted. * `NOT_FOUND` if the requested course or announcement does not exist
Args:
courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
id: string, Identifier of the announcement. (required)
body: object, The request body.
The object takes the form of:
{ # Announcement created by a teacher for students of the course
"alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
"assigneeMode": "A String", # Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.
"courseId": "A String", # Identifier of the course. Read-only.
"creationTime": "A String", # Timestamp when this announcement was created. Read-only.
"creatorUserId": "A String", # Identifier for the user that created the announcement. Read-only.
"id": "A String", # Classroom-assigned identifier of this announcement, unique per course. Read-only.
"individualStudentsOptions": { # Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. # Identifiers of students with access to the announcement. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field can see the announcement.
"studentIds": [ # Identifiers for the students that have access to the coursework/announcement.
"A String",
],
},
"materials": [ # Additional materials. Announcements must have no more than 20 material items.
{ # Material attached to course work. When creating attachments, setting the `form`, `gem`, or `notebook` field is not supported.
"driveFile": { # Drive file that is used as material for course work. # Google Drive file material.
"driveFile": { # Representation of a Google Drive file. # Drive file details.
"alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
"id": "A String", # Drive API resource ID.
"thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
"title": "A String", # Title of the Drive item. Read-only.
},
"shareMode": "A String", # Mechanism by which students access the Drive item.
},
"form": { # Google Forms item. # Google Forms material. Read-only.
"formUrl": "A String", # URL of the form.
"responseUrl": "A String", # URL of the form responses document. Only set if responses have been recorded and only when the requesting user is an editor of the form. Read-only.
"thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
"title": "A String", # Title of the Form. Read-only.
},
"gem": { # Gemini Gem link. # Gemini Gem material. Read-only.
"id": "A String", # Gems resource id.
"title": "A String", # Title of the Gem. Read-only.
"url": "A String", # URL that can be used to access the Gem. Read-only.
},
"link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response.
"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.
"url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
},
"notebook": { # NotebookLM Notebook link. # NotebookLM Notebook material. Read-only.
"id": "A String", # Notebook resource id.
"title": "A String", # Title of the Notebook. Read-only.
"url": "A String", # URL that can be used to access the Notebook. Read-only.
},
"youtubeVideo": { # YouTube video item. # YouTube video material.
"alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
"id": "A String", # YouTube API resource ID.
"thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
"title": "A String", # Title of the YouTube video. Read-only.
},
},
],
"scheduledTime": "A String", # Optional timestamp when this announcement is scheduled to be published.
"state": "A String", # Status of this announcement. If unspecified, the default state is `DRAFT`.
"text": "A String", # Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters.
"updateTime": "A String", # Timestamp of the most recent change to this announcement. Read-only.
}
updateMask: string, Mask that identifies which fields on the announcement to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the Announcement object. If a field that does not support empty values is included in the update mask and not set in the Announcement object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `text` * `state` * `scheduled_time`
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Announcement created by a teacher for students of the course
"alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
"assigneeMode": "A String", # Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.
"courseId": "A String", # Identifier of the course. Read-only.
"creationTime": "A String", # Timestamp when this announcement was created. Read-only.
"creatorUserId": "A String", # Identifier for the user that created the announcement. Read-only.
"id": "A String", # Classroom-assigned identifier of this announcement, unique per course. Read-only.
"individualStudentsOptions": { # Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. # Identifiers of students with access to the announcement. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field can see the announcement.
"studentIds": [ # Identifiers for the students that have access to the coursework/announcement.
"A String",
],
},
"materials": [ # Additional materials. Announcements must have no more than 20 material items.
{ # Material attached to course work. When creating attachments, setting the `form`, `gem`, or `notebook` field is not supported.
"driveFile": { # Drive file that is used as material for course work. # Google Drive file material.
"driveFile": { # Representation of a Google Drive file. # Drive file details.
"alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
"id": "A String", # Drive API resource ID.
"thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
"title": "A String", # Title of the Drive item. Read-only.
},
"shareMode": "A String", # Mechanism by which students access the Drive item.
},
"form": { # Google Forms item. # Google Forms material. Read-only.
"formUrl": "A String", # URL of the form.
"responseUrl": "A String", # URL of the form responses document. Only set if responses have been recorded and only when the requesting user is an editor of the form. Read-only.
"thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
"title": "A String", # Title of the Form. Read-only.
},
"gem": { # Gemini Gem link. # Gemini Gem material. Read-only.
"id": "A String", # Gems resource id.
"title": "A String", # Title of the Gem. Read-only.
"url": "A String", # URL that can be used to access the Gem. Read-only.
},
"link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response.
"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.
"url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
},
"notebook": { # NotebookLM Notebook link. # NotebookLM Notebook material. Read-only.
"id": "A String", # Notebook resource id.
"title": "A String", # Title of the Notebook. Read-only.
"url": "A String", # URL that can be used to access the Notebook. Read-only.
},
"youtubeVideo": { # YouTube video item. # YouTube video material.
"alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
"id": "A String", # YouTube API resource ID.
"thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
"title": "A String", # Title of the YouTube video. Read-only.
},
},
],
"scheduledTime": "A String", # Optional timestamp when this announcement is scheduled to be published.
"state": "A String", # Status of this announcement. If unspecified, the default state is `DRAFT`.
"text": "A String", # Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters.
"updateTime": "A String", # Timestamp of the most recent change to this announcement. Read-only.
}</pre>
</div>
</body></html>
|
