1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<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></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="classroom_v1.courses.courseWork.studentSubmissions.html">studentSubmissions()</a></code> 79</p> 80<p class="firstline">Returns the studentSubmissions Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="#close">close()</a></code></p> 84<p class="firstline">Close httplib2 connections.</p> 85<p class="toc_element"> 86 <code><a href="#create">create(courseId, body=None, x__xgafv=None)</a></code></p> 87<p class="firstline">Creates course work. The resulting course work (and corresponding student submissions) are associated with the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to make the request. Classroom API requests to modify course work and student submissions must be made with an OAuth client ID from the associated Developer Console project. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create course work 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> 88<p class="toc_element"> 89 <code><a href="#delete">delete(courseId, id, x__xgafv=None)</a></code></p> 90<p class="firstline">Deletes a course work. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if no course exists with the requested ID.</p> 91<p class="toc_element"> 92 <code><a href="#get">get(courseId, id, x__xgafv=None)</a></code></p> 93<p class="firstline">Returns course work. 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> 94<p class="toc_element"> 95 <code><a href="#list">list(courseId, courseWorkStates=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 96<p class="firstline">Returns a list of course work that the requester is permitted to view. Course students may only view `PUBLISHED` course work. Course teachers and domain administrators may view all course work. 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> 97<p class="toc_element"> 98 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 99<p class="firstline">Retrieves the next page of results.</p> 100<p class="toc_element"> 101 <code><a href="#modifyAssignees">modifyAssignees(courseId, id, body=None, x__xgafv=None)</a></code></p> 102<p class="firstline">Modifies assignee mode and options of a coursework. Only a teacher of the course that contains the coursework 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> 103<p class="toc_element"> 104 <code><a href="#patch">patch(courseId, id, body=None, updateMask=None, x__xgafv=None)</a></code></p> 105<p class="firstline">Updates one or more fields of a course work. See google.classroom.v1.CourseWork for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.</p> 106<h3>Method Details</h3> 107<div class="method"> 108 <code class="details" id="close">close()</code> 109 <pre>Close httplib2 connections.</pre> 110</div> 111 112<div class="method"> 113 <code class="details" id="create">create(courseId, body=None, x__xgafv=None)</code> 114 <pre>Creates course work. The resulting course work (and corresponding student submissions) are associated with the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to make the request. Classroom API requests to modify course work and student submissions must be made with an OAuth client ID from the associated Developer Console project. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create course work 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 115 116Args: 117 courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required) 118 body: object, The request body. 119 The object takes the form of: 120 121{ # Course work created by a teacher for students of the course. 122 "alternateLink": "A String", # Absolute link to this course work in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only. 123 "assigneeMode": "A String", # Assignee mode of the coursework. If unspecified, the default value is `ALL_STUDENTS`. 124 "assignment": { # Additional details for assignments. # Assignment details. This is populated only when `work_type` is `ASSIGNMENT`. Read-only. 125 "studentWorkFolder": { # Representation of a Google Drive folder. # Drive folder where attachments from student submissions are placed. This is only populated for course teachers and administrators. 126 "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only. 127 "id": "A String", # Drive API resource ID. 128 "title": "A String", # Title of the Drive folder. Read-only. 129 }, 130 }, 131 "associatedWithDeveloper": True or False, # Whether this course work item is associated with the Developer Console project making the request. See CreateCourseWork for more details. Read-only. 132 "courseId": "A String", # Identifier of the course. Read-only. 133 "creationTime": "A String", # Timestamp when this course work was created. Read-only. 134 "creatorUserId": "A String", # Identifier for the user that created the coursework. Read-only. 135 "description": "A String", # Optional description of this course work. If set, the description must be a valid UTF-8 string containing no more than 30,000 characters. 136 "dueDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Optional date, in UTC, that submissions for this course work are due. This must be specified if `due_time` is specified. 137 "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. 138 "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. 139 "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. 140 }, 141 "dueTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional time of day, in UTC, that submissions for this course work are due. This must be specified if `due_date` is specified. 142 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. 143 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. 144 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. 145 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. 146 }, 147 "id": "A String", # Classroom-assigned identifier of this course work, unique per course. Read-only. 148 "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 coursework. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field are assigned the coursework. 149 "studentIds": [ # Identifiers for the students that have access to the coursework/announcement. 150 "A String", 151 ], 152 }, 153 "materials": [ # Additional materials. CourseWork must have no more than 20 material items. 154 { # Material attached to course work. When creating attachments, setting the `form` field is not supported. 155 "driveFile": { # Drive file that is used as material for course work. # Google Drive file material. 156 "driveFile": { # Representation of a Google Drive file. # Drive file details. 157 "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only. 158 "id": "A String", # Drive API resource ID. 159 "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only. 160 "title": "A String", # Title of the Drive item. Read-only. 161 }, 162 "shareMode": "A String", # Mechanism by which students access the Drive item. 163 }, 164 "form": { # Google Forms item. # Google Forms material. 165 "formUrl": "A String", # URL of the form. 166 "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. 167 "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only. 168 "title": "A String", # Title of the Form. Read-only. 169 }, 170 "link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response. 171 "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only. 172 "title": "A String", # Title of the target of the URL. Read-only. 173 "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters. 174 }, 175 "youtubeVideo": { # YouTube video item. # YouTube video material. 176 "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only. 177 "id": "A String", # YouTube API resource ID. 178 "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only. 179 "title": "A String", # Title of the YouTube video. Read-only. 180 }, 181 }, 182 ], 183 "maxPoints": 3.14, # Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value. 184 "multipleChoiceQuestion": { # Additional details for multiple-choice questions. # Multiple choice question details. For read operations, this field is populated only when `work_type` is `MULTIPLE_CHOICE_QUESTION`. For write operations, this field must be specified when creating course work with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be set otherwise. 185 "choices": [ # Possible choices. 186 "A String", 187 ], 188 }, 189 "scheduledTime": "A String", # Optional timestamp when this course work is scheduled to be published. 190 "state": "A String", # Status of this course work. If unspecified, the default state is `DRAFT`. 191 "submissionModificationMode": "A String", # Setting to determine when students are allowed to modify submissions. If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`. 192 "title": "A String", # Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters. 193 "topicId": "A String", # Identifier for the topic that this coursework is associated with. Must match an existing topic in the course. 194 "updateTime": "A String", # Timestamp of the most recent change to this course work. Read-only. 195 "workType": "A String", # Type of this course work. The type is set when the course work is created and cannot be changed. 196} 197 198 x__xgafv: string, V1 error format. 199 Allowed values 200 1 - v1 error format 201 2 - v2 error format 202 203Returns: 204 An object of the form: 205 206 { # Course work created by a teacher for students of the course. 207 "alternateLink": "A String", # Absolute link to this course work in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only. 208 "assigneeMode": "A String", # Assignee mode of the coursework. If unspecified, the default value is `ALL_STUDENTS`. 209 "assignment": { # Additional details for assignments. # Assignment details. This is populated only when `work_type` is `ASSIGNMENT`. Read-only. 210 "studentWorkFolder": { # Representation of a Google Drive folder. # Drive folder where attachments from student submissions are placed. This is only populated for course teachers and administrators. 211 "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only. 212 "id": "A String", # Drive API resource ID. 213 "title": "A String", # Title of the Drive folder. Read-only. 214 }, 215 }, 216 "associatedWithDeveloper": True or False, # Whether this course work item is associated with the Developer Console project making the request. See CreateCourseWork for more details. Read-only. 217 "courseId": "A String", # Identifier of the course. Read-only. 218 "creationTime": "A String", # Timestamp when this course work was created. Read-only. 219 "creatorUserId": "A String", # Identifier for the user that created the coursework. Read-only. 220 "description": "A String", # Optional description of this course work. If set, the description must be a valid UTF-8 string containing no more than 30,000 characters. 221 "dueDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Optional date, in UTC, that submissions for this course work are due. This must be specified if `due_time` is specified. 222 "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. 223 "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. 224 "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. 225 }, 226 "dueTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional time of day, in UTC, that submissions for this course work are due. This must be specified if `due_date` is specified. 227 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. 228 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. 229 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. 230 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. 231 }, 232 "id": "A String", # Classroom-assigned identifier of this course work, unique per course. Read-only. 233 "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 coursework. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field are assigned the coursework. 234 "studentIds": [ # Identifiers for the students that have access to the coursework/announcement. 235 "A String", 236 ], 237 }, 238 "materials": [ # Additional materials. CourseWork must have no more than 20 material items. 239 { # Material attached to course work. When creating attachments, setting the `form` field is not supported. 240 "driveFile": { # Drive file that is used as material for course work. # Google Drive file material. 241 "driveFile": { # Representation of a Google Drive file. # Drive file details. 242 "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only. 243 "id": "A String", # Drive API resource ID. 244 "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only. 245 "title": "A String", # Title of the Drive item. Read-only. 246 }, 247 "shareMode": "A String", # Mechanism by which students access the Drive item. 248 }, 249 "form": { # Google Forms item. # Google Forms material. 250 "formUrl": "A String", # URL of the form. 251 "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. 252 "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only. 253 "title": "A String", # Title of the Form. Read-only. 254 }, 255 "link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response. 256 "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only. 257 "title": "A String", # Title of the target of the URL. Read-only. 258 "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters. 259 }, 260 "youtubeVideo": { # YouTube video item. # YouTube video material. 261 "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only. 262 "id": "A String", # YouTube API resource ID. 263 "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only. 264 "title": "A String", # Title of the YouTube video. Read-only. 265 }, 266 }, 267 ], 268 "maxPoints": 3.14, # Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value. 269 "multipleChoiceQuestion": { # Additional details for multiple-choice questions. # Multiple choice question details. For read operations, this field is populated only when `work_type` is `MULTIPLE_CHOICE_QUESTION`. For write operations, this field must be specified when creating course work with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be set otherwise. 270 "choices": [ # Possible choices. 271 "A String", 272 ], 273 }, 274 "scheduledTime": "A String", # Optional timestamp when this course work is scheduled to be published. 275 "state": "A String", # Status of this course work. If unspecified, the default state is `DRAFT`. 276 "submissionModificationMode": "A String", # Setting to determine when students are allowed to modify submissions. If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`. 277 "title": "A String", # Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters. 278 "topicId": "A String", # Identifier for the topic that this coursework is associated with. Must match an existing topic in the course. 279 "updateTime": "A String", # Timestamp of the most recent change to this course work. Read-only. 280 "workType": "A String", # Type of this course work. The type is set when the course work is created and cannot be changed. 281}</pre> 282</div> 283 284<div class="method"> 285 <code class="details" id="delete">delete(courseId, id, x__xgafv=None)</code> 286 <pre>Deletes a course work. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if no course exists with the requested ID. 287 288Args: 289 courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required) 290 id: string, Identifier of the course work to delete. This identifier is a Classroom-assigned identifier. (required) 291 x__xgafv: string, V1 error format. 292 Allowed values 293 1 - v1 error format 294 2 - v2 error format 295 296Returns: 297 An object of the form: 298 299 { # 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 `{}`. 300}</pre> 301</div> 302 303<div class="method"> 304 <code class="details" id="get">get(courseId, id, x__xgafv=None)</code> 305 <pre>Returns course work. 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. 306 307Args: 308 courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required) 309 id: string, Identifier of the course work. (required) 310 x__xgafv: string, V1 error format. 311 Allowed values 312 1 - v1 error format 313 2 - v2 error format 314 315Returns: 316 An object of the form: 317 318 { # Course work created by a teacher for students of the course. 319 "alternateLink": "A String", # Absolute link to this course work in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only. 320 "assigneeMode": "A String", # Assignee mode of the coursework. If unspecified, the default value is `ALL_STUDENTS`. 321 "assignment": { # Additional details for assignments. # Assignment details. This is populated only when `work_type` is `ASSIGNMENT`. Read-only. 322 "studentWorkFolder": { # Representation of a Google Drive folder. # Drive folder where attachments from student submissions are placed. This is only populated for course teachers and administrators. 323 "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only. 324 "id": "A String", # Drive API resource ID. 325 "title": "A String", # Title of the Drive folder. Read-only. 326 }, 327 }, 328 "associatedWithDeveloper": True or False, # Whether this course work item is associated with the Developer Console project making the request. See CreateCourseWork for more details. Read-only. 329 "courseId": "A String", # Identifier of the course. Read-only. 330 "creationTime": "A String", # Timestamp when this course work was created. Read-only. 331 "creatorUserId": "A String", # Identifier for the user that created the coursework. Read-only. 332 "description": "A String", # Optional description of this course work. If set, the description must be a valid UTF-8 string containing no more than 30,000 characters. 333 "dueDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Optional date, in UTC, that submissions for this course work are due. This must be specified if `due_time` is specified. 334 "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. 335 "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. 336 "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. 337 }, 338 "dueTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional time of day, in UTC, that submissions for this course work are due. This must be specified if `due_date` is specified. 339 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. 340 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. 341 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. 342 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. 343 }, 344 "id": "A String", # Classroom-assigned identifier of this course work, unique per course. Read-only. 345 "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 coursework. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field are assigned the coursework. 346 "studentIds": [ # Identifiers for the students that have access to the coursework/announcement. 347 "A String", 348 ], 349 }, 350 "materials": [ # Additional materials. CourseWork must have no more than 20 material items. 351 { # Material attached to course work. When creating attachments, setting the `form` field is not supported. 352 "driveFile": { # Drive file that is used as material for course work. # Google Drive file material. 353 "driveFile": { # Representation of a Google Drive file. # Drive file details. 354 "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only. 355 "id": "A String", # Drive API resource ID. 356 "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only. 357 "title": "A String", # Title of the Drive item. Read-only. 358 }, 359 "shareMode": "A String", # Mechanism by which students access the Drive item. 360 }, 361 "form": { # Google Forms item. # Google Forms material. 362 "formUrl": "A String", # URL of the form. 363 "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. 364 "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only. 365 "title": "A String", # Title of the Form. Read-only. 366 }, 367 "link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response. 368 "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only. 369 "title": "A String", # Title of the target of the URL. Read-only. 370 "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters. 371 }, 372 "youtubeVideo": { # YouTube video item. # YouTube video material. 373 "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only. 374 "id": "A String", # YouTube API resource ID. 375 "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only. 376 "title": "A String", # Title of the YouTube video. Read-only. 377 }, 378 }, 379 ], 380 "maxPoints": 3.14, # Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value. 381 "multipleChoiceQuestion": { # Additional details for multiple-choice questions. # Multiple choice question details. For read operations, this field is populated only when `work_type` is `MULTIPLE_CHOICE_QUESTION`. For write operations, this field must be specified when creating course work with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be set otherwise. 382 "choices": [ # Possible choices. 383 "A String", 384 ], 385 }, 386 "scheduledTime": "A String", # Optional timestamp when this course work is scheduled to be published. 387 "state": "A String", # Status of this course work. If unspecified, the default state is `DRAFT`. 388 "submissionModificationMode": "A String", # Setting to determine when students are allowed to modify submissions. If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`. 389 "title": "A String", # Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters. 390 "topicId": "A String", # Identifier for the topic that this coursework is associated with. Must match an existing topic in the course. 391 "updateTime": "A String", # Timestamp of the most recent change to this course work. Read-only. 392 "workType": "A String", # Type of this course work. The type is set when the course work is created and cannot be changed. 393}</pre> 394</div> 395 396<div class="method"> 397 <code class="details" id="list">list(courseId, courseWorkStates=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 398 <pre>Returns a list of course work that the requester is permitted to view. Course students may only view `PUBLISHED` course work. Course teachers and domain administrators may view all course work. 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. 399 400Args: 401 courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required) 402 courseWorkStates: string, Restriction on the work status to return. Only courseWork that matches is returned. If unspecified, items with a work status of `PUBLISHED` is returned. (repeated) 403 Allowed values 404 COURSE_WORK_STATE_UNSPECIFIED - No state specified. This is never returned. 405 PUBLISHED - Status for work that has been published. This is the default state. 406 DRAFT - Status for work that is not yet published. Work in this state is visible only to course teachers and domain administrators. 407 DELETED - Status for work that was published but is now deleted. Work in this state is visible only to course teachers and domain administrators. Work in this state is deleted after some time. 408 orderBy: string, Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported fields are `updateTime` and `dueDate`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc` 409 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. 410 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. 411 x__xgafv: string, V1 error format. 412 Allowed values 413 1 - v1 error format 414 2 - v2 error format 415 416Returns: 417 An object of the form: 418 419 { # Response when listing course work. 420 "courseWork": [ # Course work items that match the request. 421 { # Course work created by a teacher for students of the course. 422 "alternateLink": "A String", # Absolute link to this course work in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only. 423 "assigneeMode": "A String", # Assignee mode of the coursework. If unspecified, the default value is `ALL_STUDENTS`. 424 "assignment": { # Additional details for assignments. # Assignment details. This is populated only when `work_type` is `ASSIGNMENT`. Read-only. 425 "studentWorkFolder": { # Representation of a Google Drive folder. # Drive folder where attachments from student submissions are placed. This is only populated for course teachers and administrators. 426 "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only. 427 "id": "A String", # Drive API resource ID. 428 "title": "A String", # Title of the Drive folder. Read-only. 429 }, 430 }, 431 "associatedWithDeveloper": True or False, # Whether this course work item is associated with the Developer Console project making the request. See CreateCourseWork for more details. Read-only. 432 "courseId": "A String", # Identifier of the course. Read-only. 433 "creationTime": "A String", # Timestamp when this course work was created. Read-only. 434 "creatorUserId": "A String", # Identifier for the user that created the coursework. Read-only. 435 "description": "A String", # Optional description of this course work. If set, the description must be a valid UTF-8 string containing no more than 30,000 characters. 436 "dueDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Optional date, in UTC, that submissions for this course work are due. This must be specified if `due_time` is specified. 437 "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. 438 "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. 439 "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. 440 }, 441 "dueTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional time of day, in UTC, that submissions for this course work are due. This must be specified if `due_date` is specified. 442 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. 443 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. 444 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. 445 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. 446 }, 447 "id": "A String", # Classroom-assigned identifier of this course work, unique per course. Read-only. 448 "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 coursework. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field are assigned the coursework. 449 "studentIds": [ # Identifiers for the students that have access to the coursework/announcement. 450 "A String", 451 ], 452 }, 453 "materials": [ # Additional materials. CourseWork must have no more than 20 material items. 454 { # Material attached to course work. When creating attachments, setting the `form` field is not supported. 455 "driveFile": { # Drive file that is used as material for course work. # Google Drive file material. 456 "driveFile": { # Representation of a Google Drive file. # Drive file details. 457 "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only. 458 "id": "A String", # Drive API resource ID. 459 "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only. 460 "title": "A String", # Title of the Drive item. Read-only. 461 }, 462 "shareMode": "A String", # Mechanism by which students access the Drive item. 463 }, 464 "form": { # Google Forms item. # Google Forms material. 465 "formUrl": "A String", # URL of the form. 466 "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. 467 "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only. 468 "title": "A String", # Title of the Form. Read-only. 469 }, 470 "link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response. 471 "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only. 472 "title": "A String", # Title of the target of the URL. Read-only. 473 "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters. 474 }, 475 "youtubeVideo": { # YouTube video item. # YouTube video material. 476 "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only. 477 "id": "A String", # YouTube API resource ID. 478 "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only. 479 "title": "A String", # Title of the YouTube video. Read-only. 480 }, 481 }, 482 ], 483 "maxPoints": 3.14, # Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value. 484 "multipleChoiceQuestion": { # Additional details for multiple-choice questions. # Multiple choice question details. For read operations, this field is populated only when `work_type` is `MULTIPLE_CHOICE_QUESTION`. For write operations, this field must be specified when creating course work with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be set otherwise. 485 "choices": [ # Possible choices. 486 "A String", 487 ], 488 }, 489 "scheduledTime": "A String", # Optional timestamp when this course work is scheduled to be published. 490 "state": "A String", # Status of this course work. If unspecified, the default state is `DRAFT`. 491 "submissionModificationMode": "A String", # Setting to determine when students are allowed to modify submissions. If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`. 492 "title": "A String", # Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters. 493 "topicId": "A String", # Identifier for the topic that this coursework is associated with. Must match an existing topic in the course. 494 "updateTime": "A String", # Timestamp of the most recent change to this course work. Read-only. 495 "workType": "A String", # Type of this course work. The type is set when the course work is created and cannot be changed. 496 }, 497 ], 498 "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available. 499}</pre> 500</div> 501 502<div class="method"> 503 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 504 <pre>Retrieves the next page of results. 505 506Args: 507 previous_request: The request for the previous page. (required) 508 previous_response: The response from the request for the previous page. (required) 509 510Returns: 511 A request object that you can call 'execute()' on to request the next 512 page. Returns None if there are no more items in the collection. 513 </pre> 514</div> 515 516<div class="method"> 517 <code class="details" id="modifyAssignees">modifyAssignees(courseId, id, body=None, x__xgafv=None)</code> 518 <pre>Modifies assignee mode and options of a coursework. Only a teacher of the course that contains the coursework 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. 519 520Args: 521 courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required) 522 id: string, Identifier of the coursework. (required) 523 body: object, The request body. 524 The object takes the form of: 525 526{ # Request to modify assignee mode and options of a coursework. 527 "assigneeMode": "A String", # Mode of the coursework describing whether it will be assigned to all students or specified individual students. 528 "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 are assigned or not assigned to the coursework. Must be specified only when `assigneeMode` is `INDIVIDUAL_STUDENTS`. 529 "addStudentIds": [ # IDs of students to be added as having access to this coursework/announcement. 530 "A String", 531 ], 532 "removeStudentIds": [ # IDs of students to be removed from having access to this coursework/announcement. 533 "A String", 534 ], 535 }, 536} 537 538 x__xgafv: string, V1 error format. 539 Allowed values 540 1 - v1 error format 541 2 - v2 error format 542 543Returns: 544 An object of the form: 545 546 { # Course work created by a teacher for students of the course. 547 "alternateLink": "A String", # Absolute link to this course work in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only. 548 "assigneeMode": "A String", # Assignee mode of the coursework. If unspecified, the default value is `ALL_STUDENTS`. 549 "assignment": { # Additional details for assignments. # Assignment details. This is populated only when `work_type` is `ASSIGNMENT`. Read-only. 550 "studentWorkFolder": { # Representation of a Google Drive folder. # Drive folder where attachments from student submissions are placed. This is only populated for course teachers and administrators. 551 "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only. 552 "id": "A String", # Drive API resource ID. 553 "title": "A String", # Title of the Drive folder. Read-only. 554 }, 555 }, 556 "associatedWithDeveloper": True or False, # Whether this course work item is associated with the Developer Console project making the request. See CreateCourseWork for more details. Read-only. 557 "courseId": "A String", # Identifier of the course. Read-only. 558 "creationTime": "A String", # Timestamp when this course work was created. Read-only. 559 "creatorUserId": "A String", # Identifier for the user that created the coursework. Read-only. 560 "description": "A String", # Optional description of this course work. If set, the description must be a valid UTF-8 string containing no more than 30,000 characters. 561 "dueDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Optional date, in UTC, that submissions for this course work are due. This must be specified if `due_time` is specified. 562 "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. 563 "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. 564 "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. 565 }, 566 "dueTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional time of day, in UTC, that submissions for this course work are due. This must be specified if `due_date` is specified. 567 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. 568 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. 569 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. 570 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. 571 }, 572 "id": "A String", # Classroom-assigned identifier of this course work, unique per course. Read-only. 573 "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 coursework. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field are assigned the coursework. 574 "studentIds": [ # Identifiers for the students that have access to the coursework/announcement. 575 "A String", 576 ], 577 }, 578 "materials": [ # Additional materials. CourseWork must have no more than 20 material items. 579 { # Material attached to course work. When creating attachments, setting the `form` field is not supported. 580 "driveFile": { # Drive file that is used as material for course work. # Google Drive file material. 581 "driveFile": { # Representation of a Google Drive file. # Drive file details. 582 "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only. 583 "id": "A String", # Drive API resource ID. 584 "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only. 585 "title": "A String", # Title of the Drive item. Read-only. 586 }, 587 "shareMode": "A String", # Mechanism by which students access the Drive item. 588 }, 589 "form": { # Google Forms item. # Google Forms material. 590 "formUrl": "A String", # URL of the form. 591 "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. 592 "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only. 593 "title": "A String", # Title of the Form. Read-only. 594 }, 595 "link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response. 596 "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only. 597 "title": "A String", # Title of the target of the URL. Read-only. 598 "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters. 599 }, 600 "youtubeVideo": { # YouTube video item. # YouTube video material. 601 "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only. 602 "id": "A String", # YouTube API resource ID. 603 "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only. 604 "title": "A String", # Title of the YouTube video. Read-only. 605 }, 606 }, 607 ], 608 "maxPoints": 3.14, # Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value. 609 "multipleChoiceQuestion": { # Additional details for multiple-choice questions. # Multiple choice question details. For read operations, this field is populated only when `work_type` is `MULTIPLE_CHOICE_QUESTION`. For write operations, this field must be specified when creating course work with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be set otherwise. 610 "choices": [ # Possible choices. 611 "A String", 612 ], 613 }, 614 "scheduledTime": "A String", # Optional timestamp when this course work is scheduled to be published. 615 "state": "A String", # Status of this course work. If unspecified, the default state is `DRAFT`. 616 "submissionModificationMode": "A String", # Setting to determine when students are allowed to modify submissions. If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`. 617 "title": "A String", # Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters. 618 "topicId": "A String", # Identifier for the topic that this coursework is associated with. Must match an existing topic in the course. 619 "updateTime": "A String", # Timestamp of the most recent change to this course work. Read-only. 620 "workType": "A String", # Type of this course work. The type is set when the course work is created and cannot be changed. 621}</pre> 622</div> 623 624<div class="method"> 625 <code class="details" id="patch">patch(courseId, id, body=None, updateMask=None, x__xgafv=None)</code> 626 <pre>Updates one or more fields of a course work. See google.classroom.v1.CourseWork for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if the requested course, course work, or student submission does not exist. 627 628Args: 629 courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required) 630 id: string, Identifier of the course work. (required) 631 body: object, The request body. 632 The object takes the form of: 633 634{ # Course work created by a teacher for students of the course. 635 "alternateLink": "A String", # Absolute link to this course work in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only. 636 "assigneeMode": "A String", # Assignee mode of the coursework. If unspecified, the default value is `ALL_STUDENTS`. 637 "assignment": { # Additional details for assignments. # Assignment details. This is populated only when `work_type` is `ASSIGNMENT`. Read-only. 638 "studentWorkFolder": { # Representation of a Google Drive folder. # Drive folder where attachments from student submissions are placed. This is only populated for course teachers and administrators. 639 "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only. 640 "id": "A String", # Drive API resource ID. 641 "title": "A String", # Title of the Drive folder. Read-only. 642 }, 643 }, 644 "associatedWithDeveloper": True or False, # Whether this course work item is associated with the Developer Console project making the request. See CreateCourseWork for more details. Read-only. 645 "courseId": "A String", # Identifier of the course. Read-only. 646 "creationTime": "A String", # Timestamp when this course work was created. Read-only. 647 "creatorUserId": "A String", # Identifier for the user that created the coursework. Read-only. 648 "description": "A String", # Optional description of this course work. If set, the description must be a valid UTF-8 string containing no more than 30,000 characters. 649 "dueDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Optional date, in UTC, that submissions for this course work are due. This must be specified if `due_time` is specified. 650 "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. 651 "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. 652 "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. 653 }, 654 "dueTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional time of day, in UTC, that submissions for this course work are due. This must be specified if `due_date` is specified. 655 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. 656 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. 657 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. 658 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. 659 }, 660 "id": "A String", # Classroom-assigned identifier of this course work, unique per course. Read-only. 661 "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 coursework. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field are assigned the coursework. 662 "studentIds": [ # Identifiers for the students that have access to the coursework/announcement. 663 "A String", 664 ], 665 }, 666 "materials": [ # Additional materials. CourseWork must have no more than 20 material items. 667 { # Material attached to course work. When creating attachments, setting the `form` field is not supported. 668 "driveFile": { # Drive file that is used as material for course work. # Google Drive file material. 669 "driveFile": { # Representation of a Google Drive file. # Drive file details. 670 "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only. 671 "id": "A String", # Drive API resource ID. 672 "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only. 673 "title": "A String", # Title of the Drive item. Read-only. 674 }, 675 "shareMode": "A String", # Mechanism by which students access the Drive item. 676 }, 677 "form": { # Google Forms item. # Google Forms material. 678 "formUrl": "A String", # URL of the form. 679 "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. 680 "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only. 681 "title": "A String", # Title of the Form. Read-only. 682 }, 683 "link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response. 684 "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only. 685 "title": "A String", # Title of the target of the URL. Read-only. 686 "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters. 687 }, 688 "youtubeVideo": { # YouTube video item. # YouTube video material. 689 "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only. 690 "id": "A String", # YouTube API resource ID. 691 "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only. 692 "title": "A String", # Title of the YouTube video. Read-only. 693 }, 694 }, 695 ], 696 "maxPoints": 3.14, # Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value. 697 "multipleChoiceQuestion": { # Additional details for multiple-choice questions. # Multiple choice question details. For read operations, this field is populated only when `work_type` is `MULTIPLE_CHOICE_QUESTION`. For write operations, this field must be specified when creating course work with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be set otherwise. 698 "choices": [ # Possible choices. 699 "A String", 700 ], 701 }, 702 "scheduledTime": "A String", # Optional timestamp when this course work is scheduled to be published. 703 "state": "A String", # Status of this course work. If unspecified, the default state is `DRAFT`. 704 "submissionModificationMode": "A String", # Setting to determine when students are allowed to modify submissions. If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`. 705 "title": "A String", # Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters. 706 "topicId": "A String", # Identifier for the topic that this coursework is associated with. Must match an existing topic in the course. 707 "updateTime": "A String", # Timestamp of the most recent change to this course work. Read-only. 708 "workType": "A String", # Type of this course work. The type is set when the course work is created and cannot be changed. 709} 710 711 updateMask: string, Mask that identifies which fields on the course work 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 CourseWork object. If a field that does not support empty values is included in the update mask and not set in the CourseWork object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `due_date` * `due_time` * `max_points` * `scheduled_time` * `submission_modification_mode` * `topic_id` 712 x__xgafv: string, V1 error format. 713 Allowed values 714 1 - v1 error format 715 2 - v2 error format 716 717Returns: 718 An object of the form: 719 720 { # Course work created by a teacher for students of the course. 721 "alternateLink": "A String", # Absolute link to this course work in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only. 722 "assigneeMode": "A String", # Assignee mode of the coursework. If unspecified, the default value is `ALL_STUDENTS`. 723 "assignment": { # Additional details for assignments. # Assignment details. This is populated only when `work_type` is `ASSIGNMENT`. Read-only. 724 "studentWorkFolder": { # Representation of a Google Drive folder. # Drive folder where attachments from student submissions are placed. This is only populated for course teachers and administrators. 725 "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only. 726 "id": "A String", # Drive API resource ID. 727 "title": "A String", # Title of the Drive folder. Read-only. 728 }, 729 }, 730 "associatedWithDeveloper": True or False, # Whether this course work item is associated with the Developer Console project making the request. See CreateCourseWork for more details. Read-only. 731 "courseId": "A String", # Identifier of the course. Read-only. 732 "creationTime": "A String", # Timestamp when this course work was created. Read-only. 733 "creatorUserId": "A String", # Identifier for the user that created the coursework. Read-only. 734 "description": "A String", # Optional description of this course work. If set, the description must be a valid UTF-8 string containing no more than 30,000 characters. 735 "dueDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Optional date, in UTC, that submissions for this course work are due. This must be specified if `due_time` is specified. 736 "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. 737 "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. 738 "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. 739 }, 740 "dueTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional time of day, in UTC, that submissions for this course work are due. This must be specified if `due_date` is specified. 741 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. 742 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. 743 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. 744 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. 745 }, 746 "id": "A String", # Classroom-assigned identifier of this course work, unique per course. Read-only. 747 "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 coursework. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field are assigned the coursework. 748 "studentIds": [ # Identifiers for the students that have access to the coursework/announcement. 749 "A String", 750 ], 751 }, 752 "materials": [ # Additional materials. CourseWork must have no more than 20 material items. 753 { # Material attached to course work. When creating attachments, setting the `form` field is not supported. 754 "driveFile": { # Drive file that is used as material for course work. # Google Drive file material. 755 "driveFile": { # Representation of a Google Drive file. # Drive file details. 756 "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only. 757 "id": "A String", # Drive API resource ID. 758 "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only. 759 "title": "A String", # Title of the Drive item. Read-only. 760 }, 761 "shareMode": "A String", # Mechanism by which students access the Drive item. 762 }, 763 "form": { # Google Forms item. # Google Forms material. 764 "formUrl": "A String", # URL of the form. 765 "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. 766 "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only. 767 "title": "A String", # Title of the Form. Read-only. 768 }, 769 "link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response. 770 "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only. 771 "title": "A String", # Title of the target of the URL. Read-only. 772 "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters. 773 }, 774 "youtubeVideo": { # YouTube video item. # YouTube video material. 775 "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only. 776 "id": "A String", # YouTube API resource ID. 777 "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only. 778 "title": "A String", # Title of the YouTube video. Read-only. 779 }, 780 }, 781 ], 782 "maxPoints": 3.14, # Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value. 783 "multipleChoiceQuestion": { # Additional details for multiple-choice questions. # Multiple choice question details. For read operations, this field is populated only when `work_type` is `MULTIPLE_CHOICE_QUESTION`. For write operations, this field must be specified when creating course work with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be set otherwise. 784 "choices": [ # Possible choices. 785 "A String", 786 ], 787 }, 788 "scheduledTime": "A String", # Optional timestamp when this course work is scheduled to be published. 789 "state": "A String", # Status of this course work. If unspecified, the default state is `DRAFT`. 790 "submissionModificationMode": "A String", # Setting to determine when students are allowed to modify submissions. If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`. 791 "title": "A String", # Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters. 792 "topicId": "A String", # Identifier for the topic that this coursework is associated with. Must match an existing topic in the course. 793 "updateTime": "A String", # Timestamp of the most recent change to this course work. Read-only. 794 "workType": "A String", # Type of this course work. The type is set when the course work is created and cannot be changed. 795}</pre> 796</div> 797 798</body></html>