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></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="classroom_v1.courses.aliases.html">aliases()</a></code> 79</p> 80<p class="firstline">Returns the aliases Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="classroom_v1.courses.announcements.html">announcements()</a></code> 84</p> 85<p class="firstline">Returns the announcements Resource.</p> 86 87<p class="toc_element"> 88 <code><a href="classroom_v1.courses.courseWork.html">courseWork()</a></code> 89</p> 90<p class="firstline">Returns the courseWork Resource.</p> 91 92<p class="toc_element"> 93 <code><a href="classroom_v1.courses.courseWorkMaterials.html">courseWorkMaterials()</a></code> 94</p> 95<p class="firstline">Returns the courseWorkMaterials Resource.</p> 96 97<p class="toc_element"> 98 <code><a href="classroom_v1.courses.students.html">students()</a></code> 99</p> 100<p class="firstline">Returns the students Resource.</p> 101 102<p class="toc_element"> 103 <code><a href="classroom_v1.courses.teachers.html">teachers()</a></code> 104</p> 105<p class="firstline">Returns the teachers Resource.</p> 106 107<p class="toc_element"> 108 <code><a href="classroom_v1.courses.topics.html">topics()</a></code> 109</p> 110<p class="firstline">Returns the topics Resource.</p> 111 112<p class="toc_element"> 113 <code><a href="#close">close()</a></code></p> 114<p class="firstline">Close httplib2 connections.</p> 115<p class="toc_element"> 116 <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p> 117<p class="firstline">Creates a course. The user specified in `ownerId` is the owner of the created course and added as a teacher. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create courses or for access errors. * `NOT_FOUND` if the primary teacher is not a valid user. * `FAILED_PRECONDITION` if the course owner's account is disabled or for the following request errors: * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if an alias was specified in the `id` and already exists.</p> 118<p class="toc_element"> 119 <code><a href="#delete">delete(id, x__xgafv=None)</a></code></p> 120<p class="firstline">Deletes a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.</p> 121<p class="toc_element"> 122 <code><a href="#get">get(id, x__xgafv=None)</a></code></p> 123<p class="firstline">Returns a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.</p> 124<p class="toc_element"> 125 <code><a href="#list">list(courseStates=None, pageSize=None, pageToken=None, studentId=None, teacherId=None, x__xgafv=None)</a></code></p> 126<p class="firstline">Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. Returned courses are ordered by creation time, with the most recently created coming first. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the query argument is malformed. * `NOT_FOUND` if any users specified in the query arguments do not exist.</p> 127<p class="toc_element"> 128 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 129<p class="firstline">Retrieves the next page of results.</p> 130<p class="toc_element"> 131 <code><a href="#patch">patch(id, body=None, updateMask=None, x__xgafv=None)</a></code></p> 132<p class="firstline">Updates one or more fields in a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable</p> 133<p class="toc_element"> 134 <code><a href="#update">update(id, body=None, x__xgafv=None)</a></code></p> 135<p class="firstline">Updates a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable</p> 136<h3>Method Details</h3> 137<div class="method"> 138 <code class="details" id="close">close()</code> 139 <pre>Close httplib2 connections.</pre> 140</div> 141 142<div class="method"> 143 <code class="details" id="create">create(body=None, x__xgafv=None)</code> 144 <pre>Creates a course. The user specified in `ownerId` is the owner of the created course and added as a teacher. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create courses or for access errors. * `NOT_FOUND` if the primary teacher is not a valid user. * `FAILED_PRECONDITION` if the course owner's account is disabled or for the following request errors: * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if an alias was specified in the `id` and already exists. 145 146Args: 147 body: object, The request body. 148 The object takes the form of: 149 150{ # A Course in Classroom. 151 "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only. 152 "calendarId": "A String", # The Calendar ID for a calendar that all course members can see, to which Classroom adds events for course work and announcements in the course. Read-only. 153 "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only. 154 "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only. 155 { # A set of materials that appears on the "About" page of the course. These materials might include a syllabus, schedule, or other background information relating to the course as a whole. 156 "materials": [ # Materials attached to this set. 157 { # A material attached to a course as part of a material set. 158 "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment. 159 "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only. 160 "id": "A String", # Drive API resource ID. 161 "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only. 162 "title": "A String", # Title of the Drive item. Read-only. 163 }, 164 "form": { # Google Forms item. # Google Forms attachment. 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 atatchment. 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 attachment. 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 "title": "A String", # Title for this set. 184 }, 185 ], 186 "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`. 187 "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only. 188 "description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters. 189 "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters. 190 "enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only. 191 "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only. 192 "id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error. 193 "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string. 194 "ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Admins can also specify this field in a patch course request to transfer ownership. In other contexts, it is read-only. 195 "room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters. 196 "section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters. 197 "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only. 198 "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only. 199 "id": "A String", # Drive API resource ID. 200 "title": "A String", # Title of the Drive folder. Read-only. 201 }, 202 "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only. 203 "updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only. 204} 205 206 x__xgafv: string, V1 error format. 207 Allowed values 208 1 - v1 error format 209 2 - v2 error format 210 211Returns: 212 An object of the form: 213 214 { # A Course in Classroom. 215 "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only. 216 "calendarId": "A String", # The Calendar ID for a calendar that all course members can see, to which Classroom adds events for course work and announcements in the course. Read-only. 217 "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only. 218 "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only. 219 { # A set of materials that appears on the "About" page of the course. These materials might include a syllabus, schedule, or other background information relating to the course as a whole. 220 "materials": [ # Materials attached to this set. 221 { # A material attached to a course as part of a material set. 222 "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment. 223 "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only. 224 "id": "A String", # Drive API resource ID. 225 "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only. 226 "title": "A String", # Title of the Drive item. Read-only. 227 }, 228 "form": { # Google Forms item. # Google Forms attachment. 229 "formUrl": "A String", # URL of the form. 230 "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. 231 "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only. 232 "title": "A String", # Title of the Form. Read-only. 233 }, 234 "link": { # URL item. # Link atatchment. 235 "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only. 236 "title": "A String", # Title of the target of the URL. Read-only. 237 "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters. 238 }, 239 "youTubeVideo": { # YouTube video item. # Youtube video attachment. 240 "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only. 241 "id": "A String", # YouTube API resource ID. 242 "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only. 243 "title": "A String", # Title of the YouTube video. Read-only. 244 }, 245 }, 246 ], 247 "title": "A String", # Title for this set. 248 }, 249 ], 250 "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`. 251 "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only. 252 "description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters. 253 "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters. 254 "enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only. 255 "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only. 256 "id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error. 257 "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string. 258 "ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Admins can also specify this field in a patch course request to transfer ownership. In other contexts, it is read-only. 259 "room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters. 260 "section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters. 261 "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only. 262 "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only. 263 "id": "A String", # Drive API resource ID. 264 "title": "A String", # Title of the Drive folder. Read-only. 265 }, 266 "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only. 267 "updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only. 268}</pre> 269</div> 270 271<div class="method"> 272 <code class="details" id="delete">delete(id, x__xgafv=None)</code> 273 <pre>Deletes a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. 274 275Args: 276 id: string, Identifier of the course to delete. This identifier can be either the Classroom-assigned identifier or an alias. (required) 277 x__xgafv: string, V1 error format. 278 Allowed values 279 1 - v1 error format 280 2 - v2 error format 281 282Returns: 283 An object of the form: 284 285 { # 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 `{}`. 286}</pre> 287</div> 288 289<div class="method"> 290 <code class="details" id="get">get(id, x__xgafv=None)</code> 291 <pre>Returns a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. 292 293Args: 294 id: string, Identifier of the course to return. This identifier can be either the Classroom-assigned identifier or an alias. (required) 295 x__xgafv: string, V1 error format. 296 Allowed values 297 1 - v1 error format 298 2 - v2 error format 299 300Returns: 301 An object of the form: 302 303 { # A Course in Classroom. 304 "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only. 305 "calendarId": "A String", # The Calendar ID for a calendar that all course members can see, to which Classroom adds events for course work and announcements in the course. Read-only. 306 "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only. 307 "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only. 308 { # A set of materials that appears on the "About" page of the course. These materials might include a syllabus, schedule, or other background information relating to the course as a whole. 309 "materials": [ # Materials attached to this set. 310 { # A material attached to a course as part of a material set. 311 "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment. 312 "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only. 313 "id": "A String", # Drive API resource ID. 314 "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only. 315 "title": "A String", # Title of the Drive item. Read-only. 316 }, 317 "form": { # Google Forms item. # Google Forms attachment. 318 "formUrl": "A String", # URL of the form. 319 "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. 320 "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only. 321 "title": "A String", # Title of the Form. Read-only. 322 }, 323 "link": { # URL item. # Link atatchment. 324 "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only. 325 "title": "A String", # Title of the target of the URL. Read-only. 326 "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters. 327 }, 328 "youTubeVideo": { # YouTube video item. # Youtube video attachment. 329 "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only. 330 "id": "A String", # YouTube API resource ID. 331 "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only. 332 "title": "A String", # Title of the YouTube video. Read-only. 333 }, 334 }, 335 ], 336 "title": "A String", # Title for this set. 337 }, 338 ], 339 "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`. 340 "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only. 341 "description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters. 342 "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters. 343 "enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only. 344 "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only. 345 "id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error. 346 "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string. 347 "ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Admins can also specify this field in a patch course request to transfer ownership. In other contexts, it is read-only. 348 "room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters. 349 "section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters. 350 "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only. 351 "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only. 352 "id": "A String", # Drive API resource ID. 353 "title": "A String", # Title of the Drive folder. Read-only. 354 }, 355 "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only. 356 "updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only. 357}</pre> 358</div> 359 360<div class="method"> 361 <code class="details" id="list">list(courseStates=None, pageSize=None, pageToken=None, studentId=None, teacherId=None, x__xgafv=None)</code> 362 <pre>Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. Returned courses are ordered by creation time, with the most recently created coming first. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the query argument is malformed. * `NOT_FOUND` if any users specified in the query arguments do not exist. 363 364Args: 365 courseStates: string, Restricts returned courses to those in one of the specified states The default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED. (repeated) 366 Allowed values 367 COURSE_STATE_UNSPECIFIED - No course state. No returned Course message will use this value. 368 ACTIVE - The course is active. 369 ARCHIVED - The course has been archived. You cannot modify it except to change it to a different state. 370 PROVISIONED - The course has been created, but not yet activated. It is accessible by the primary teacher and domain administrators, who may modify it or change it to the `ACTIVE` or `DECLINED` states. A course may only be changed to `PROVISIONED` if it is in the `DECLINED` state. 371 DECLINED - The course has been created, but declined. It is accessible by the course owner and domain administrators, though it will not be displayed in the web UI. You cannot modify the course except to change it to the `PROVISIONED` state. A course may only be changed to `DECLINED` if it is in the `PROVISIONED` state. 372 SUSPENDED - The course has been suspended. You cannot modify the course, and only the user identified by the `owner_id` can view the course. A course may be placed in this state if it potentially violates the Terms of Service. 373 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. 374 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. 375 studentId: string, Restricts returned courses to those having a student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user 376 teacherId: string, Restricts returned courses to those having a teacher with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user 377 x__xgafv: string, V1 error format. 378 Allowed values 379 1 - v1 error format 380 2 - v2 error format 381 382Returns: 383 An object of the form: 384 385 { # Response when listing courses. 386 "courses": [ # Courses that match the list request. 387 { # A Course in Classroom. 388 "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only. 389 "calendarId": "A String", # The Calendar ID for a calendar that all course members can see, to which Classroom adds events for course work and announcements in the course. Read-only. 390 "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only. 391 "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only. 392 { # A set of materials that appears on the "About" page of the course. These materials might include a syllabus, schedule, or other background information relating to the course as a whole. 393 "materials": [ # Materials attached to this set. 394 { # A material attached to a course as part of a material set. 395 "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment. 396 "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only. 397 "id": "A String", # Drive API resource ID. 398 "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only. 399 "title": "A String", # Title of the Drive item. Read-only. 400 }, 401 "form": { # Google Forms item. # Google Forms attachment. 402 "formUrl": "A String", # URL of the form. 403 "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. 404 "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only. 405 "title": "A String", # Title of the Form. Read-only. 406 }, 407 "link": { # URL item. # Link atatchment. 408 "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only. 409 "title": "A String", # Title of the target of the URL. Read-only. 410 "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters. 411 }, 412 "youTubeVideo": { # YouTube video item. # Youtube video attachment. 413 "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only. 414 "id": "A String", # YouTube API resource ID. 415 "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only. 416 "title": "A String", # Title of the YouTube video. Read-only. 417 }, 418 }, 419 ], 420 "title": "A String", # Title for this set. 421 }, 422 ], 423 "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`. 424 "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only. 425 "description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters. 426 "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters. 427 "enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only. 428 "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only. 429 "id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error. 430 "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string. 431 "ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Admins can also specify this field in a patch course request to transfer ownership. In other contexts, it is read-only. 432 "room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters. 433 "section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters. 434 "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only. 435 "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only. 436 "id": "A String", # Drive API resource ID. 437 "title": "A String", # Title of the Drive folder. Read-only. 438 }, 439 "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only. 440 "updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only. 441 }, 442 ], 443 "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available. 444}</pre> 445</div> 446 447<div class="method"> 448 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 449 <pre>Retrieves the next page of results. 450 451Args: 452 previous_request: The request for the previous page. (required) 453 previous_response: The response from the request for the previous page. (required) 454 455Returns: 456 A request object that you can call 'execute()' on to request the next 457 page. Returns None if there are no more items in the collection. 458 </pre> 459</div> 460 461<div class="method"> 462 <code class="details" id="patch">patch(id, body=None, updateMask=None, x__xgafv=None)</code> 463 <pre>Updates one or more fields in a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable 464 465Args: 466 id: string, Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias. (required) 467 body: object, The request body. 468 The object takes the form of: 469 470{ # A Course in Classroom. 471 "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only. 472 "calendarId": "A String", # The Calendar ID for a calendar that all course members can see, to which Classroom adds events for course work and announcements in the course. Read-only. 473 "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only. 474 "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only. 475 { # A set of materials that appears on the "About" page of the course. These materials might include a syllabus, schedule, or other background information relating to the course as a whole. 476 "materials": [ # Materials attached to this set. 477 { # A material attached to a course as part of a material set. 478 "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment. 479 "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only. 480 "id": "A String", # Drive API resource ID. 481 "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only. 482 "title": "A String", # Title of the Drive item. Read-only. 483 }, 484 "form": { # Google Forms item. # Google Forms attachment. 485 "formUrl": "A String", # URL of the form. 486 "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. 487 "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only. 488 "title": "A String", # Title of the Form. Read-only. 489 }, 490 "link": { # URL item. # Link atatchment. 491 "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only. 492 "title": "A String", # Title of the target of the URL. Read-only. 493 "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters. 494 }, 495 "youTubeVideo": { # YouTube video item. # Youtube video attachment. 496 "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only. 497 "id": "A String", # YouTube API resource ID. 498 "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only. 499 "title": "A String", # Title of the YouTube video. Read-only. 500 }, 501 }, 502 ], 503 "title": "A String", # Title for this set. 504 }, 505 ], 506 "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`. 507 "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only. 508 "description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters. 509 "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters. 510 "enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only. 511 "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only. 512 "id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error. 513 "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string. 514 "ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Admins can also specify this field in a patch course request to transfer ownership. In other contexts, it is read-only. 515 "room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters. 516 "section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters. 517 "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only. 518 "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only. 519 "id": "A String", # Drive API resource ID. 520 "title": "A String", # Title of the Drive folder. Read-only. 521 }, 522 "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only. 523 "updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only. 524} 525 526 updateMask: string, Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: * `name` * `section` * `descriptionHeading` * `description` * `room` * `courseState` * `ownerId` Note: patches to ownerId are treated as being effective immediately, but in practice it may take some time for the ownership transfer of all affected resources to complete. When set in a query parameter, this field should be specified as `updateMask=,,...` 527 x__xgafv: string, V1 error format. 528 Allowed values 529 1 - v1 error format 530 2 - v2 error format 531 532Returns: 533 An object of the form: 534 535 { # A Course in Classroom. 536 "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only. 537 "calendarId": "A String", # The Calendar ID for a calendar that all course members can see, to which Classroom adds events for course work and announcements in the course. Read-only. 538 "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only. 539 "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only. 540 { # A set of materials that appears on the "About" page of the course. These materials might include a syllabus, schedule, or other background information relating to the course as a whole. 541 "materials": [ # Materials attached to this set. 542 { # A material attached to a course as part of a material set. 543 "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment. 544 "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only. 545 "id": "A String", # Drive API resource ID. 546 "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only. 547 "title": "A String", # Title of the Drive item. Read-only. 548 }, 549 "form": { # Google Forms item. # Google Forms attachment. 550 "formUrl": "A String", # URL of the form. 551 "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. 552 "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only. 553 "title": "A String", # Title of the Form. Read-only. 554 }, 555 "link": { # URL item. # Link atatchment. 556 "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only. 557 "title": "A String", # Title of the target of the URL. Read-only. 558 "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters. 559 }, 560 "youTubeVideo": { # YouTube video item. # Youtube video attachment. 561 "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only. 562 "id": "A String", # YouTube API resource ID. 563 "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only. 564 "title": "A String", # Title of the YouTube video. Read-only. 565 }, 566 }, 567 ], 568 "title": "A String", # Title for this set. 569 }, 570 ], 571 "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`. 572 "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only. 573 "description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters. 574 "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters. 575 "enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only. 576 "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only. 577 "id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error. 578 "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string. 579 "ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Admins can also specify this field in a patch course request to transfer ownership. In other contexts, it is read-only. 580 "room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters. 581 "section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters. 582 "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only. 583 "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only. 584 "id": "A String", # Drive API resource ID. 585 "title": "A String", # Title of the Drive folder. Read-only. 586 }, 587 "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only. 588 "updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only. 589}</pre> 590</div> 591 592<div class="method"> 593 <code class="details" id="update">update(id, body=None, x__xgafv=None)</code> 594 <pre>Updates a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable 595 596Args: 597 id: string, Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias. (required) 598 body: object, The request body. 599 The object takes the form of: 600 601{ # A Course in Classroom. 602 "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only. 603 "calendarId": "A String", # The Calendar ID for a calendar that all course members can see, to which Classroom adds events for course work and announcements in the course. Read-only. 604 "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only. 605 "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only. 606 { # A set of materials that appears on the "About" page of the course. These materials might include a syllabus, schedule, or other background information relating to the course as a whole. 607 "materials": [ # Materials attached to this set. 608 { # A material attached to a course as part of a material set. 609 "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment. 610 "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only. 611 "id": "A String", # Drive API resource ID. 612 "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only. 613 "title": "A String", # Title of the Drive item. Read-only. 614 }, 615 "form": { # Google Forms item. # Google Forms attachment. 616 "formUrl": "A String", # URL of the form. 617 "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. 618 "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only. 619 "title": "A String", # Title of the Form. Read-only. 620 }, 621 "link": { # URL item. # Link atatchment. 622 "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only. 623 "title": "A String", # Title of the target of the URL. Read-only. 624 "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters. 625 }, 626 "youTubeVideo": { # YouTube video item. # Youtube video attachment. 627 "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only. 628 "id": "A String", # YouTube API resource ID. 629 "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only. 630 "title": "A String", # Title of the YouTube video. Read-only. 631 }, 632 }, 633 ], 634 "title": "A String", # Title for this set. 635 }, 636 ], 637 "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`. 638 "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only. 639 "description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters. 640 "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters. 641 "enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only. 642 "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only. 643 "id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error. 644 "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string. 645 "ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Admins can also specify this field in a patch course request to transfer ownership. In other contexts, it is read-only. 646 "room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters. 647 "section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters. 648 "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only. 649 "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only. 650 "id": "A String", # Drive API resource ID. 651 "title": "A String", # Title of the Drive folder. Read-only. 652 }, 653 "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only. 654 "updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only. 655} 656 657 x__xgafv: string, V1 error format. 658 Allowed values 659 1 - v1 error format 660 2 - v2 error format 661 662Returns: 663 An object of the form: 664 665 { # A Course in Classroom. 666 "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only. 667 "calendarId": "A String", # The Calendar ID for a calendar that all course members can see, to which Classroom adds events for course work and announcements in the course. Read-only. 668 "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only. 669 "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only. 670 { # A set of materials that appears on the "About" page of the course. These materials might include a syllabus, schedule, or other background information relating to the course as a whole. 671 "materials": [ # Materials attached to this set. 672 { # A material attached to a course as part of a material set. 673 "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment. 674 "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only. 675 "id": "A String", # Drive API resource ID. 676 "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only. 677 "title": "A String", # Title of the Drive item. Read-only. 678 }, 679 "form": { # Google Forms item. # Google Forms attachment. 680 "formUrl": "A String", # URL of the form. 681 "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. 682 "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only. 683 "title": "A String", # Title of the Form. Read-only. 684 }, 685 "link": { # URL item. # Link atatchment. 686 "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only. 687 "title": "A String", # Title of the target of the URL. Read-only. 688 "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters. 689 }, 690 "youTubeVideo": { # YouTube video item. # Youtube video attachment. 691 "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only. 692 "id": "A String", # YouTube API resource ID. 693 "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only. 694 "title": "A String", # Title of the YouTube video. Read-only. 695 }, 696 }, 697 ], 698 "title": "A String", # Title for this set. 699 }, 700 ], 701 "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`. 702 "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only. 703 "description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters. 704 "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters. 705 "enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only. 706 "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only. 707 "id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error. 708 "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string. 709 "ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Admins can also specify this field in a patch course request to transfer ownership. In other contexts, it is read-only. 710 "room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters. 711 "section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters. 712 "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only. 713 "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only. 714 "id": "A String", # Drive API resource ID. 715 "title": "A String", # Title of the Drive folder. Read-only. 716 }, 717 "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only. 718 "updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only. 719}</pre> 720</div> 721 722</body></html>