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
|
<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.topics.html">topics</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#create">create(courseId, body, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a topic.</p>
<p class="toc_element">
<code><a href="#delete">delete(courseId, id, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a topic.</p>
<p class="toc_element">
<code><a href="#get">get(courseId, id, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a topic.</p>
<p class="toc_element">
<code><a href="#list">list(courseId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the list of topics that the requester is permitted to view.</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(courseId, id, body, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates one or more fields of a topic.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(courseId, body, x__xgafv=None)</code>
<pre>Creates a topic.
This method returns the following error codes:
* `PERMISSION_DENIED` if the requesting user is not permitted to access the
requested course, create a topic in 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)
body: object, The request body. (required)
The object takes the form of:
{ # Topic created by a teacher for the course
"courseId": "A String", # Identifier of the course.
#
# Read-only.
"topicId": "A String", # Unique identifier for the topic.
#
# Read-only.
"updateTime": "A String", # The time the topic was last updated by the system.
#
# Read-only.
"name": "A String", # The name of the topic, generated by the user.
# Leading and trailing whitespaces, if any, will be trimmed. Also, multiple
# consecutive whitespaces will be collapsed into one inside the name. The
# result must be a non-empty string. Topic names are case sensitive, and must
# be no longer than 100 characters.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Topic created by a teacher for the course
"courseId": "A String", # Identifier of the course.
#
# Read-only.
"topicId": "A String", # Unique identifier for the topic.
#
# Read-only.
"updateTime": "A String", # The time the topic was last updated by the system.
#
# Read-only.
"name": "A String", # The name of the topic, generated by the user.
# Leading and trailing whitespaces, if any, will be trimmed. Also, multiple
# consecutive whitespaces will be collapsed into one inside the name. The
# result must be a non-empty string. Topic names are case sensitive, and must
# be no longer than 100 characters.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(courseId, id, x__xgafv=None)</code>
<pre>Deletes a topic.
This method returns the following error codes:
* `PERMISSION_DENIED` if the requesting user is not allowed to delete the
requested topic or for access errors.
* `FAILED_PRECONDITION` if the requested topic has already been
deleted.
* `NOT_FOUND` if no course or topic 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 topic to delete. (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);
# }
#
# The JSON representation for `Empty` is empty JSON object `{}`.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(courseId, id, x__xgafv=None)</code>
<pre>Returns a topic.
This method returns the following error codes:
* `PERMISSION_DENIED` if the requesting user is not permitted to access the
requested course or topic, or for access errors.
* `INVALID_ARGUMENT` if the request is malformed.
* `NOT_FOUND` if the requested course or topic does not exist.
Args:
courseId: string, Identifier of the course. (required)
id: string, Identifier of the topic. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Topic created by a teacher for the course
"courseId": "A String", # Identifier of the course.
#
# Read-only.
"topicId": "A String", # Unique identifier for the topic.
#
# Read-only.
"updateTime": "A String", # The time the topic was last updated by the system.
#
# Read-only.
"name": "A String", # The name of the topic, generated by the user.
# Leading and trailing whitespaces, if any, will be trimmed. Also, multiple
# consecutive whitespaces will be collapsed into one inside the name. The
# result must be a non-empty string. Topic names are case sensitive, and must
# be no longer than 100 characters.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(courseId, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Returns the list of topics that the requester is permitted to view.
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)
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 topics.
"nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further
# results are available.
"topic": [ # Topic items that match the request.
{ # Topic created by a teacher for the course
"courseId": "A String", # Identifier of the course.
#
# Read-only.
"topicId": "A String", # Unique identifier for the topic.
#
# Read-only.
"updateTime": "A String", # The time the topic was last updated by the system.
#
# Read-only.
"name": "A String", # The name of the topic, generated by the user.
# Leading and trailing whitespaces, if any, will be trimmed. Also, multiple
# consecutive whitespaces will be collapsed into one inside the name. The
# result must be a non-empty string. Topic names are case sensitive, and must
# be no longer than 100 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(courseId, id, body, updateMask=None, x__xgafv=None)</code>
<pre>Updates one or more fields of a topic.
This method returns the following error codes:
* `PERMISSION_DENIED` if the requesting developer project did not create
the corresponding topic or for access errors.
* `INVALID_ARGUMENT` if the request is malformed.
* `NOT_FOUND` if the requested course or topic 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 topic. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Topic created by a teacher for the course
"courseId": "A String", # Identifier of the course.
#
# Read-only.
"topicId": "A String", # Unique identifier for the topic.
#
# Read-only.
"updateTime": "A String", # The time the topic was last updated by the system.
#
# Read-only.
"name": "A String", # The name of the topic, generated by the user.
# Leading and trailing whitespaces, if any, will be trimmed. Also, multiple
# consecutive whitespaces will be collapsed into one inside the name. The
# result must be a non-empty string. Topic names are case sensitive, and must
# be no longer than 100 characters.
}
updateMask: string, Mask that identifies which fields on the topic 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 Topic object. If a
field that does not support empty values is included in the update mask and
not set in the Topic object, an `INVALID_ARGUMENT` error will be
returned.
The following fields may be specified:
* `name`
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Topic created by a teacher for the course
"courseId": "A String", # Identifier of the course.
#
# Read-only.
"topicId": "A String", # Unique identifier for the topic.
#
# Read-only.
"updateTime": "A String", # The time the topic was last updated by the system.
#
# Read-only.
"name": "A String", # The name of the topic, generated by the user.
# Leading and trailing whitespaces, if any, will be trimmed. Also, multiple
# consecutive whitespaces will be collapsed into one inside the name. The
# result must be a non-empty string. Topic names are case sensitive, and must
# be no longer than 100 characters.
}</pre>
</div>
</body></html>
|
