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
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="classroom_v1.html">Google Classroom API</a> . <a href="classroom_v1.courses.html">courses</a> . <a href="classroom_v1.courses.courseWork.html">courseWork</a> . <a href="classroom_v1.courses.courseWork.rubrics.html">rubrics</a></h1>
<h2>Instance Methods</h2>
<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, courseWorkId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a rubric. The requesting user and course owner must have rubrics creation capabilities. For details, see [licensing requirements](https://developers.google.com/workspace/classroom/rubrics/limitations#license-requirements). For further details, see [Rubrics structure and known limitations](/classroom/rubrics/limitations). This request must be made by the Google Cloud console of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the parent course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user isn't permitted to create rubrics for course work in the requested course. * `INTERNAL` if the request has insufficient OAuth scopes. * `INVALID_ARGUMENT` if the request is malformed and for the following request error: * `RubricCriteriaInvalidFormat` * `NOT_FOUND` if the requested course or course work don't exist or the user doesn't have access to the course or course work. * `FAILED_PRECONDITION` for the following request error: * `AttachmentNotVisible`</p>
<p class="toc_element">
<code><a href="#delete">delete(courseId, courseWorkId, id, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a rubric. The requesting user and course owner must have rubrics creation capabilities. For details, see [licensing requirements](https://developers.google.com/workspace/classroom/rubrics/limitations#license-requirements). This request must be made by the Google Cloud console of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding rubric. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project didn't create the corresponding rubric, or if the requesting user isn't permitted to delete the requested rubric. * `NOT_FOUND` if no rubric exists with the requested ID or the user does not have access to the course, course work, or rubric. * `INVALID_ARGUMENT` if grading has already started on the rubric.</p>
<p class="toc_element">
<code><a href="#get">get(courseId, courseWorkId, id, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a rubric. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or rubric doesn't exist or if the user doesn't have access to the corresponding course work.</p>
<p class="toc_element">
<code><a href="#list">list(courseId, courseWorkId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a list of rubrics that the requester is permitted to view. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work doesn't exist or if the user doesn't have access to the corresponding course work.</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="#patch">patch(courseId, courseWorkId, id, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a rubric. See google.classroom.v1.Rubric for details of which fields can be updated. Rubric update capabilities are [limited](/classroom/rubrics/limitations) once grading has started. The requesting user and course owner must have rubrics creation capabilities. For details, see [licensing requirements](https://developers.google.com/workspace/classroom/rubrics/limitations#license-requirements). This request must be made by the Google Cloud console of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the parent course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project didn't create the corresponding course work, if the user isn't permitted to make the requested modification to the rubric, or for access errors. This error code is also returned if grading has already started on the rubric. * `INVALID_ARGUMENT` if the request is malformed and for the following request error: * `RubricCriteriaInvalidFormat` * `NOT_FOUND` if the requested course, course work, or rubric doesn't exist or if the user doesn't have access to the corresponding course work. * `INTERNAL` if grading has already started on the rubric.</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, courseWorkId, body=None, x__xgafv=None)</code>
<pre>Creates a rubric. The requesting user and course owner must have rubrics creation capabilities. For details, see [licensing requirements](https://developers.google.com/workspace/classroom/rubrics/limitations#license-requirements). For further details, see [Rubrics structure and known limitations](/classroom/rubrics/limitations). This request must be made by the Google Cloud console of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the parent course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user isn't permitted to create rubrics for course work in the requested course. * `INTERNAL` if the request has insufficient OAuth scopes. * `INVALID_ARGUMENT` if the request is malformed and for the following request error: * `RubricCriteriaInvalidFormat` * `NOT_FOUND` if the requested course or course work don't exist or the user doesn't have access to the course or course work. * `FAILED_PRECONDITION` for the following request error: * `AttachmentNotVisible`
Args:
courseId: string, Required. Identifier of the course. (required)
courseWorkId: string, Required. Identifier of the course work. (required)
body: object, The request body.
The object takes the form of:
{ # The rubric of the course work. A rubric is a scoring guide used to evaluate student work and give feedback. For further details, see [Rubrics structure and known limitations](/classroom/rubrics/limitations).
"courseId": "A String", # Identifier of the course. Read-only.
"courseWorkId": "A String", # Identifier for the course work this corresponds to. Read-only.
"creationTime": "A String", # Output only. Timestamp when this rubric was created. Read-only.
"criteria": [ # List of criteria. Each criterion is a dimension on which performance is rated.
{ # A rubric criterion. Each criterion is a dimension on which performance is rated.
"description": "A String", # The description of the criterion.
"id": "A String", # The criterion ID. On creation, an ID is assigned.
"levels": [ # The list of levels within this criterion.
{ # A level of the criterion.
"description": "A String", # The description of the level.
"id": "A String", # The level ID. On creation, an ID is assigned.
"points": 3.14, # Optional points associated with this level. If set, all levels within the rubric must specify points and the value must be distinct across all levels within a single criterion. 0 is distinct from no points.
"title": "A String", # The title of the level. If the level has no points set, title must be set.
},
],
"title": "A String", # The title of the criterion.
},
],
"id": "A String", # Classroom-assigned identifier for the rubric. This is unique among rubrics for the relevant course work. Read-only.
"sourceSpreadsheetId": "A String", # Input only. Immutable. Google Sheets ID of the spreadsheet. This spreadsheet must contain formatted rubric settings. See [Create or reuse a rubric for an assignment](https://support.google.com/edu/classroom/answer/9335069). Use of this field requires the `https://www.googleapis.com/auth/spreadsheets.readonly` or `https://www.googleapis.com/auth/spreadsheets` scope.
"updateTime": "A String", # Output only. Timestamp of the most recent change to this rubric. Read-only.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The rubric of the course work. A rubric is a scoring guide used to evaluate student work and give feedback. For further details, see [Rubrics structure and known limitations](/classroom/rubrics/limitations).
"courseId": "A String", # Identifier of the course. Read-only.
"courseWorkId": "A String", # Identifier for the course work this corresponds to. Read-only.
"creationTime": "A String", # Output only. Timestamp when this rubric was created. Read-only.
"criteria": [ # List of criteria. Each criterion is a dimension on which performance is rated.
{ # A rubric criterion. Each criterion is a dimension on which performance is rated.
"description": "A String", # The description of the criterion.
"id": "A String", # The criterion ID. On creation, an ID is assigned.
"levels": [ # The list of levels within this criterion.
{ # A level of the criterion.
"description": "A String", # The description of the level.
"id": "A String", # The level ID. On creation, an ID is assigned.
"points": 3.14, # Optional points associated with this level. If set, all levels within the rubric must specify points and the value must be distinct across all levels within a single criterion. 0 is distinct from no points.
"title": "A String", # The title of the level. If the level has no points set, title must be set.
},
],
"title": "A String", # The title of the criterion.
},
],
"id": "A String", # Classroom-assigned identifier for the rubric. This is unique among rubrics for the relevant course work. Read-only.
"sourceSpreadsheetId": "A String", # Input only. Immutable. Google Sheets ID of the spreadsheet. This spreadsheet must contain formatted rubric settings. See [Create or reuse a rubric for an assignment](https://support.google.com/edu/classroom/answer/9335069). Use of this field requires the `https://www.googleapis.com/auth/spreadsheets.readonly` or `https://www.googleapis.com/auth/spreadsheets` scope.
"updateTime": "A String", # Output only. Timestamp of the most recent change to this rubric. Read-only.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(courseId, courseWorkId, id, x__xgafv=None)</code>
<pre>Deletes a rubric. The requesting user and course owner must have rubrics creation capabilities. For details, see [licensing requirements](https://developers.google.com/workspace/classroom/rubrics/limitations#license-requirements). This request must be made by the Google Cloud console of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding rubric. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project didn't create the corresponding rubric, or if the requesting user isn't permitted to delete the requested rubric. * `NOT_FOUND` if no rubric exists with the requested ID or the user does not have access to the course, course work, or rubric. * `INVALID_ARGUMENT` if grading has already started on the rubric.
Args:
courseId: string, Required. Identifier of the course. (required)
courseWorkId: string, Required. Identifier of the course work. (required)
id: string, Required. Identifier of the rubric. (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, courseWorkId, id, x__xgafv=None)</code>
<pre>Returns a rubric. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or rubric doesn't exist or if the user doesn't have access to the corresponding course work.
Args:
courseId: string, Required. Identifier of the course. (required)
courseWorkId: string, Required. Identifier of the course work. (required)
id: string, Required. Identifier of the rubric. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The rubric of the course work. A rubric is a scoring guide used to evaluate student work and give feedback. For further details, see [Rubrics structure and known limitations](/classroom/rubrics/limitations).
"courseId": "A String", # Identifier of the course. Read-only.
"courseWorkId": "A String", # Identifier for the course work this corresponds to. Read-only.
"creationTime": "A String", # Output only. Timestamp when this rubric was created. Read-only.
"criteria": [ # List of criteria. Each criterion is a dimension on which performance is rated.
{ # A rubric criterion. Each criterion is a dimension on which performance is rated.
"description": "A String", # The description of the criterion.
"id": "A String", # The criterion ID. On creation, an ID is assigned.
"levels": [ # The list of levels within this criterion.
{ # A level of the criterion.
"description": "A String", # The description of the level.
"id": "A String", # The level ID. On creation, an ID is assigned.
"points": 3.14, # Optional points associated with this level. If set, all levels within the rubric must specify points and the value must be distinct across all levels within a single criterion. 0 is distinct from no points.
"title": "A String", # The title of the level. If the level has no points set, title must be set.
},
],
"title": "A String", # The title of the criterion.
},
],
"id": "A String", # Classroom-assigned identifier for the rubric. This is unique among rubrics for the relevant course work. Read-only.
"sourceSpreadsheetId": "A String", # Input only. Immutable. Google Sheets ID of the spreadsheet. This spreadsheet must contain formatted rubric settings. See [Create or reuse a rubric for an assignment](https://support.google.com/edu/classroom/answer/9335069). Use of this field requires the `https://www.googleapis.com/auth/spreadsheets.readonly` or `https://www.googleapis.com/auth/spreadsheets` scope.
"updateTime": "A String", # Output only. Timestamp of the most recent change to this rubric. Read-only.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(courseId, courseWorkId, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Returns a list of rubrics that the requester is permitted to view. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work doesn't exist or if the user doesn't have access to the corresponding course work.
Args:
courseId: string, Required. Identifier of the course. (required)
courseWorkId: string, Required. Identifier of the course work. (required)
pageSize: integer, The maximum number of rubrics to return. If unspecified, at most 1 rubric is returned. The maximum value is 1; values above 1 are coerced to 1.
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 rubrics.
"nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available.
"rubrics": [ # Rubrics that match the request.
{ # The rubric of the course work. A rubric is a scoring guide used to evaluate student work and give feedback. For further details, see [Rubrics structure and known limitations](/classroom/rubrics/limitations).
"courseId": "A String", # Identifier of the course. Read-only.
"courseWorkId": "A String", # Identifier for the course work this corresponds to. Read-only.
"creationTime": "A String", # Output only. Timestamp when this rubric was created. Read-only.
"criteria": [ # List of criteria. Each criterion is a dimension on which performance is rated.
{ # A rubric criterion. Each criterion is a dimension on which performance is rated.
"description": "A String", # The description of the criterion.
"id": "A String", # The criterion ID. On creation, an ID is assigned.
"levels": [ # The list of levels within this criterion.
{ # A level of the criterion.
"description": "A String", # The description of the level.
"id": "A String", # The level ID. On creation, an ID is assigned.
"points": 3.14, # Optional points associated with this level. If set, all levels within the rubric must specify points and the value must be distinct across all levels within a single criterion. 0 is distinct from no points.
"title": "A String", # The title of the level. If the level has no points set, title must be set.
},
],
"title": "A String", # The title of the criterion.
},
],
"id": "A String", # Classroom-assigned identifier for the rubric. This is unique among rubrics for the relevant course work. Read-only.
"sourceSpreadsheetId": "A String", # Input only. Immutable. Google Sheets ID of the spreadsheet. This spreadsheet must contain formatted rubric settings. See [Create or reuse a rubric for an assignment](https://support.google.com/edu/classroom/answer/9335069). Use of this field requires the `https://www.googleapis.com/auth/spreadsheets.readonly` or `https://www.googleapis.com/auth/spreadsheets` scope.
"updateTime": "A String", # Output only. Timestamp of the most recent change to this rubric. Read-only.
},
],
}</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="patch">patch(courseId, courseWorkId, id, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates a rubric. See google.classroom.v1.Rubric for details of which fields can be updated. Rubric update capabilities are [limited](/classroom/rubrics/limitations) once grading has started. The requesting user and course owner must have rubrics creation capabilities. For details, see [licensing requirements](https://developers.google.com/workspace/classroom/rubrics/limitations#license-requirements). This request must be made by the Google Cloud console of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the parent course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project didn't create the corresponding course work, if the user isn't permitted to make the requested modification to the rubric, or for access errors. This error code is also returned if grading has already started on the rubric. * `INVALID_ARGUMENT` if the request is malformed and for the following request error: * `RubricCriteriaInvalidFormat` * `NOT_FOUND` if the requested course, course work, or rubric doesn't exist or if the user doesn't have access to the corresponding course work. * `INTERNAL` if grading has already started on the rubric.
Args:
courseId: string, Required. Identifier of the course. (required)
courseWorkId: string, Required. Identifier of the course work. (required)
id: string, Optional. Identifier of the rubric. (required)
body: object, The request body.
The object takes the form of:
{ # The rubric of the course work. A rubric is a scoring guide used to evaluate student work and give feedback. For further details, see [Rubrics structure and known limitations](/classroom/rubrics/limitations).
"courseId": "A String", # Identifier of the course. Read-only.
"courseWorkId": "A String", # Identifier for the course work this corresponds to. Read-only.
"creationTime": "A String", # Output only. Timestamp when this rubric was created. Read-only.
"criteria": [ # List of criteria. Each criterion is a dimension on which performance is rated.
{ # A rubric criterion. Each criterion is a dimension on which performance is rated.
"description": "A String", # The description of the criterion.
"id": "A String", # The criterion ID. On creation, an ID is assigned.
"levels": [ # The list of levels within this criterion.
{ # A level of the criterion.
"description": "A String", # The description of the level.
"id": "A String", # The level ID. On creation, an ID is assigned.
"points": 3.14, # Optional points associated with this level. If set, all levels within the rubric must specify points and the value must be distinct across all levels within a single criterion. 0 is distinct from no points.
"title": "A String", # The title of the level. If the level has no points set, title must be set.
},
],
"title": "A String", # The title of the criterion.
},
],
"id": "A String", # Classroom-assigned identifier for the rubric. This is unique among rubrics for the relevant course work. Read-only.
"sourceSpreadsheetId": "A String", # Input only. Immutable. Google Sheets ID of the spreadsheet. This spreadsheet must contain formatted rubric settings. See [Create or reuse a rubric for an assignment](https://support.google.com/edu/classroom/answer/9335069). Use of this field requires the `https://www.googleapis.com/auth/spreadsheets.readonly` or `https://www.googleapis.com/auth/spreadsheets` scope.
"updateTime": "A String", # Output only. Timestamp of the most recent change to this rubric. Read-only.
}
updateMask: string, Optional. Mask that identifies which fields on the rubric to update. This field is required to do an update. The update fails if invalid fields are specified. There are multiple options to define the criteria of a rubric: the `source_spreadsheet_id` and the `criteria` list. Only one of these can be used at a time to define a rubric. The rubric `criteria` list is fully replaced by the rubric criteria specified in the update request. For example, if a criterion or level is missing from the request, it is deleted. New criteria and levels are added and an ID is assigned. Existing criteria and levels retain the previously assigned ID if the ID is specified in the request. The following fields can be specified by teachers: * `criteria` * `source_spreadsheet_id`
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The rubric of the course work. A rubric is a scoring guide used to evaluate student work and give feedback. For further details, see [Rubrics structure and known limitations](/classroom/rubrics/limitations).
"courseId": "A String", # Identifier of the course. Read-only.
"courseWorkId": "A String", # Identifier for the course work this corresponds to. Read-only.
"creationTime": "A String", # Output only. Timestamp when this rubric was created. Read-only.
"criteria": [ # List of criteria. Each criterion is a dimension on which performance is rated.
{ # A rubric criterion. Each criterion is a dimension on which performance is rated.
"description": "A String", # The description of the criterion.
"id": "A String", # The criterion ID. On creation, an ID is assigned.
"levels": [ # The list of levels within this criterion.
{ # A level of the criterion.
"description": "A String", # The description of the level.
"id": "A String", # The level ID. On creation, an ID is assigned.
"points": 3.14, # Optional points associated with this level. If set, all levels within the rubric must specify points and the value must be distinct across all levels within a single criterion. 0 is distinct from no points.
"title": "A String", # The title of the level. If the level has no points set, title must be set.
},
],
"title": "A String", # The title of the criterion.
},
],
"id": "A String", # Classroom-assigned identifier for the rubric. This is unique among rubrics for the relevant course work. Read-only.
"sourceSpreadsheetId": "A String", # Input only. Immutable. Google Sheets ID of the spreadsheet. This spreadsheet must contain formatted rubric settings. See [Create or reuse a rubric for an assignment](https://support.google.com/edu/classroom/answer/9335069). Use of this field requires the `https://www.googleapis.com/auth/spreadsheets.readonly` or `https://www.googleapis.com/auth/spreadsheets` scope.
"updateTime": "A String", # Output only. Timestamp of the most recent change to this rubric. Read-only.
}</pre>
</div>
</body></html>
|
