1 <html><body> 2 <style> 3 4 body, 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 15 body { 16 font-size: 13px; 17 padding: 1em; 18 } 19 20 h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23 } 24 25 h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28 } 29 30 h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34 } 35 36 pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39 } 40 41 pre { 42 margin-top: 0.5em; 43 } 44 45 h1, h2, h3, p { 46 font-family: Arial, sans serif; 47 } 48 49 h1, 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.courseWork.html">courseWork()</a></code> 84 </p> 85 <p class="firstline">Returns the courseWork Resource.</p> 86 87 <p class="toc_element"> 88 <code><a href="classroom_v1.courses.students.html">students()</a></code> 89 </p> 90 <p class="firstline">Returns the students Resource.</p> 91 92 <p class="toc_element"> 93 <code><a href="classroom_v1.courses.teachers.html">teachers()</a></code> 94 </p> 95 <p class="firstline">Returns the teachers Resource.</p> 96 97 <p class="toc_element"> 98 <code><a href="#create">create(body, x__xgafv=None)</a></code></p> 99 <p class="firstline">Creates a course.</p> 100 <p class="toc_element"> 101 <code><a href="#delete">delete(id, x__xgafv=None)</a></code></p> 102 <p class="firstline">Deletes a course.</p> 103 <p class="toc_element"> 104 <code><a href="#get">get(id, x__xgafv=None)</a></code></p> 105 <p class="firstline">Returns a course.</p> 106 <p class="toc_element"> 107 <code><a href="#list">list(studentId=None, pageSize=None, courseStates=None, teacherId=None, pageToken=None, x__xgafv=None)</a></code></p> 108 <p class="firstline">Returns a list of courses that the requesting user is permitted to view,</p> 109 <p class="toc_element"> 110 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 111 <p class="firstline">Retrieves the next page of results.</p> 112 <p class="toc_element"> 113 <code><a href="#patch">patch(id, body, updateMask=None, x__xgafv=None)</a></code></p> 114 <p class="firstline">Updates one or more fields in a course.</p> 115 <p class="toc_element"> 116 <code><a href="#update">update(id, body, x__xgafv=None)</a></code></p> 117 <p class="firstline">Updates a course.</p> 118 <h3>Method Details</h3> 119 <div class="method"> 120 <code class="details" id="create">create(body, x__xgafv=None)</code> 121 <pre>Creates a course. 122 123 The user specified in `ownerId` is the owner of the created course 124 and added as a teacher. 125 126 This method returns the following error codes: 127 128 * `PERMISSION_DENIED` if the requesting user is not permitted to create 129 courses or for access errors. 130 * `NOT_FOUND` if the primary teacher is not a valid user. 131 * `FAILED_PRECONDITION` if the course owner's account is disabled or for 132 the following request errors: 133 * UserGroupsMembershipLimitReached 134 * `ALREADY_EXISTS` if an alias was specified in the `id` and 135 already exists. 136 137 Args: 138 body: object, The request body. (required) 139 The object takes the form of: 140 141 { # A Course in Classroom. 142 "updateTime": "A String", # Time of the most recent update to this course. 143 # Specifying this field in a course update mask results in an error. 144 # 145 # Read-only. 146 "room": "A String", # Optional room location. 147 # For example, "301". 148 # If set, this field must be a valid UTF-8 string and no longer than 650 149 # characters. 150 "name": "A String", # Name of the course. 151 # For example, "10th Grade Biology". 152 # The name is required. It must be between 1 and 750 characters and a valid 153 # UTF-8 string. 154 "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. 155 # 156 # Read-only. 157 "enrollmentCode": "A String", # Enrollment code to use when joining this course. 158 # Specifying this field in a course update mask results in an error. 159 # 160 # Read-only. 161 "section": "A String", # Section of the course. 162 # For example, "Period 2". 163 # If set, this field must be a valid UTF-8 string and no longer than 2800 164 # characters. 165 "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. 166 # 167 # Read-only. 168 "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. 169 # This group does not accept email and can only be used for permissions. 170 # 171 # Read-only. 172 "creationTime": "A String", # Creation time of the course. 173 # Specifying this field in a course update mask results in an error. 174 # 175 # Read-only. 176 "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. 177 # This group does not accept email and can only be used for permissions. 178 # 179 # Read-only. 180 "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. 181 # 182 # Read-only. 183 { # A set of materials that appears on the "About" page of the course. 184 # These materials might include a syllabus, schedule, or other background 185 # information relating to the course as a whole. 186 "materials": [ # Materials attached to this set. 187 { # A material attached to a course as part of a material set. 188 "link": { # URL item. # Link atatchment. 189 "url": "A String", # URL to link to. 190 # This must be a valid UTF-8 string containing between 1 and 2024 characters. 191 "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. 192 # 193 # Read-only. 194 "title": "A String", # Title of the target of the URL. 195 # 196 # Read-only. 197 }, 198 "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment. 199 "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. 200 # 201 # Read-only. 202 "alternateLink": "A String", # URL that can be used to access the Drive item. 203 # 204 # Read-only. 205 "id": "A String", # Drive API resource ID. 206 "title": "A String", # Title of the Drive item. 207 # 208 # Read-only. 209 }, 210 "youTubeVideo": { # YouTube video item. # Youtube video attachment. 211 "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. 212 # 213 # Read-only. 214 "alternateLink": "A String", # URL that can be used to view the YouTube video. 215 # 216 # Read-only. 217 "id": "A String", # YouTube API resource ID. 218 "title": "A String", # Title of the YouTube video. 219 # 220 # Read-only. 221 }, 222 "form": { # Google Forms item. # Google Forms attachment. 223 "formUrl": "A String", # URL of the form. 224 "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. 225 # 226 # Read-only. 227 "responseUrl": "A String", # URL of the form responses document. 228 # Only set if respsonses have been recorded and only when the 229 # requesting user is an editor of the form. 230 # 231 # Read-only. 232 "title": "A String", # Title of the Form. 233 # 234 # Read-only. 235 }, 236 }, 237 ], 238 "title": "A String", # Title for this set. 239 }, 240 ], 241 "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the 242 # course. 243 # 244 # This field will only be set for teachers of the course and domain administrators. 245 # 246 # Read-only. 247 "alternateLink": "A String", # URL that can be used to access the Drive folder. 248 # 249 # Read-only. 250 "id": "A String", # Drive API resource ID. 251 "title": "A String", # Title of the Drive folder. 252 # 253 # Read-only. 254 }, 255 "ownerId": "A String", # The identifier of the owner of a course. 256 # 257 # When specified as a parameter of a 258 # create course request, this 259 # field is required. 260 # The identifier can be one of the following: 261 # 262 # * the numeric identifier for the user 263 # * the email address of the user 264 # * the string literal `"me"`, indicating the requesting user 265 # 266 # This must be set in a create request. Specifying this field in a course 267 # update mask results in an `INVALID_ARGUMENT` error. 268 "courseState": "A String", # State of the course. 269 # If unspecified, the default state is `PROVISIONED`. 270 "id": "A String", # Identifier for this course assigned by Classroom. 271 # 272 # When 273 # creating a course, 274 # you may optionally set this identifier to an 275 # alias string in the 276 # request to create a corresponding alias. The `id` is still assigned by 277 # Classroom and cannot be updated after the course is created. 278 # 279 # Specifying this field in a course update mask results in an error. 280 "descriptionHeading": "A String", # Optional heading for the description. 281 # For example, "Welcome to 10th Grade Biology." 282 # If set, this field must be a valid UTF-8 string and no longer than 3600 283 # characters. 284 "description": "A String", # Optional description. 285 # For example, "We'll be learning about the structure of living 286 # creatures from a combination of textbooks, guest lectures, and lab work. 287 # Expect to be excited!" 288 # If set, this field must be a valid UTF-8 string and no longer than 30,000 289 # characters. 290 } 291 292 x__xgafv: string, V1 error format. 293 Allowed values 294 1 - v1 error format 295 2 - v2 error format 296 297 Returns: 298 An object of the form: 299 300 { # A Course in Classroom. 301 "updateTime": "A String", # Time of the most recent update to this course. 302 # Specifying this field in a course update mask results in an error. 303 # 304 # Read-only. 305 "room": "A String", # Optional room location. 306 # For example, "301". 307 # If set, this field must be a valid UTF-8 string and no longer than 650 308 # characters. 309 "name": "A String", # Name of the course. 310 # For example, "10th Grade Biology". 311 # The name is required. It must be between 1 and 750 characters and a valid 312 # UTF-8 string. 313 "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. 314 # 315 # Read-only. 316 "enrollmentCode": "A String", # Enrollment code to use when joining this course. 317 # Specifying this field in a course update mask results in an error. 318 # 319 # Read-only. 320 "section": "A String", # Section of the course. 321 # For example, "Period 2". 322 # If set, this field must be a valid UTF-8 string and no longer than 2800 323 # characters. 324 "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. 325 # 326 # Read-only. 327 "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. 328 # This group does not accept email and can only be used for permissions. 329 # 330 # Read-only. 331 "creationTime": "A String", # Creation time of the course. 332 # Specifying this field in a course update mask results in an error. 333 # 334 # Read-only. 335 "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. 336 # This group does not accept email and can only be used for permissions. 337 # 338 # Read-only. 339 "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. 340 # 341 # Read-only. 342 { # A set of materials that appears on the "About" page of the course. 343 # These materials might include a syllabus, schedule, or other background 344 # information relating to the course as a whole. 345 "materials": [ # Materials attached to this set. 346 { # A material attached to a course as part of a material set. 347 "link": { # URL item. # Link atatchment. 348 "url": "A String", # URL to link to. 349 # This must be a valid UTF-8 string containing between 1 and 2024 characters. 350 "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. 351 # 352 # Read-only. 353 "title": "A String", # Title of the target of the URL. 354 # 355 # Read-only. 356 }, 357 "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment. 358 "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. 359 # 360 # Read-only. 361 "alternateLink": "A String", # URL that can be used to access the Drive item. 362 # 363 # Read-only. 364 "id": "A String", # Drive API resource ID. 365 "title": "A String", # Title of the Drive item. 366 # 367 # Read-only. 368 }, 369 "youTubeVideo": { # YouTube video item. # Youtube video attachment. 370 "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. 371 # 372 # Read-only. 373 "alternateLink": "A String", # URL that can be used to view the YouTube video. 374 # 375 # Read-only. 376 "id": "A String", # YouTube API resource ID. 377 "title": "A String", # Title of the YouTube video. 378 # 379 # Read-only. 380 }, 381 "form": { # Google Forms item. # Google Forms attachment. 382 "formUrl": "A String", # URL of the form. 383 "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. 384 # 385 # Read-only. 386 "responseUrl": "A String", # URL of the form responses document. 387 # Only set if respsonses have been recorded and only when the 388 # requesting user is an editor of the form. 389 # 390 # Read-only. 391 "title": "A String", # Title of the Form. 392 # 393 # Read-only. 394 }, 395 }, 396 ], 397 "title": "A String", # Title for this set. 398 }, 399 ], 400 "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the 401 # course. 402 # 403 # This field will only be set for teachers of the course and domain administrators. 404 # 405 # Read-only. 406 "alternateLink": "A String", # URL that can be used to access the Drive folder. 407 # 408 # Read-only. 409 "id": "A String", # Drive API resource ID. 410 "title": "A String", # Title of the Drive folder. 411 # 412 # Read-only. 413 }, 414 "ownerId": "A String", # The identifier of the owner of a course. 415 # 416 # When specified as a parameter of a 417 # create course request, this 418 # field is required. 419 # The identifier can be one of the following: 420 # 421 # * the numeric identifier for the user 422 # * the email address of the user 423 # * the string literal `"me"`, indicating the requesting user 424 # 425 # This must be set in a create request. Specifying this field in a course 426 # update mask results in an `INVALID_ARGUMENT` error. 427 "courseState": "A String", # State of the course. 428 # If unspecified, the default state is `PROVISIONED`. 429 "id": "A String", # Identifier for this course assigned by Classroom. 430 # 431 # When 432 # creating a course, 433 # you may optionally set this identifier to an 434 # alias string in the 435 # request to create a corresponding alias. The `id` is still assigned by 436 # Classroom and cannot be updated after the course is created. 437 # 438 # Specifying this field in a course update mask results in an error. 439 "descriptionHeading": "A String", # Optional heading for the description. 440 # For example, "Welcome to 10th Grade Biology." 441 # If set, this field must be a valid UTF-8 string and no longer than 3600 442 # characters. 443 "description": "A String", # Optional description. 444 # For example, "We'll be learning about the structure of living 445 # creatures from a combination of textbooks, guest lectures, and lab work. 446 # Expect to be excited!" 447 # If set, this field must be a valid UTF-8 string and no longer than 30,000 448 # characters. 449 }</pre> 450 </div> 451 452 <div class="method"> 453 <code class="details" id="delete">delete(id, x__xgafv=None)</code> 454 <pre>Deletes a course. 455 456 This method returns the following error codes: 457 458 * `PERMISSION_DENIED` if the requesting user is not permitted to delete the 459 requested course or for access errors. 460 * `NOT_FOUND` if no course exists with the requested ID. 461 462 Args: 463 id: string, Identifier of the course to delete. 464 This identifier can be either the Classroom-assigned identifier or an 465 alias. (required) 466 x__xgafv: string, V1 error format. 467 Allowed values 468 1 - v1 error format 469 2 - v2 error format 470 471 Returns: 472 An object of the form: 473 474 { # A generic empty message that you can re-use to avoid defining duplicated 475 # empty messages in your APIs. A typical example is to use it as the request 476 # or the response type of an API method. For instance: 477 # 478 # service Foo { 479 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); 480 # } 481 # 482 # The JSON representation for `Empty` is empty JSON object `{}`. 483 }</pre> 484 </div> 485 486 <div class="method"> 487 <code class="details" id="get">get(id, x__xgafv=None)</code> 488 <pre>Returns a course. 489 490 This method returns the following error codes: 491 492 * `PERMISSION_DENIED` if the requesting user is not permitted to access the 493 requested course or for access errors. 494 * `NOT_FOUND` if no course exists with the requested ID. 495 496 Args: 497 id: string, Identifier of the course to return. 498 This identifier can be either the Classroom-assigned identifier or an 499 alias. (required) 500 x__xgafv: string, V1 error format. 501 Allowed values 502 1 - v1 error format 503 2 - v2 error format 504 505 Returns: 506 An object of the form: 507 508 { # A Course in Classroom. 509 "updateTime": "A String", # Time of the most recent update to this course. 510 # Specifying this field in a course update mask results in an error. 511 # 512 # Read-only. 513 "room": "A String", # Optional room location. 514 # For example, "301". 515 # If set, this field must be a valid UTF-8 string and no longer than 650 516 # characters. 517 "name": "A String", # Name of the course. 518 # For example, "10th Grade Biology". 519 # The name is required. It must be between 1 and 750 characters and a valid 520 # UTF-8 string. 521 "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. 522 # 523 # Read-only. 524 "enrollmentCode": "A String", # Enrollment code to use when joining this course. 525 # Specifying this field in a course update mask results in an error. 526 # 527 # Read-only. 528 "section": "A String", # Section of the course. 529 # For example, "Period 2". 530 # If set, this field must be a valid UTF-8 string and no longer than 2800 531 # characters. 532 "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. 533 # 534 # Read-only. 535 "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. 536 # This group does not accept email and can only be used for permissions. 537 # 538 # Read-only. 539 "creationTime": "A String", # Creation time of the course. 540 # Specifying this field in a course update mask results in an error. 541 # 542 # Read-only. 543 "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. 544 # This group does not accept email and can only be used for permissions. 545 # 546 # Read-only. 547 "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. 548 # 549 # Read-only. 550 { # A set of materials that appears on the "About" page of the course. 551 # These materials might include a syllabus, schedule, or other background 552 # information relating to the course as a whole. 553 "materials": [ # Materials attached to this set. 554 { # A material attached to a course as part of a material set. 555 "link": { # URL item. # Link atatchment. 556 "url": "A String", # URL to link to. 557 # This must be a valid UTF-8 string containing between 1 and 2024 characters. 558 "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. 559 # 560 # Read-only. 561 "title": "A String", # Title of the target of the URL. 562 # 563 # Read-only. 564 }, 565 "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment. 566 "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. 567 # 568 # Read-only. 569 "alternateLink": "A String", # URL that can be used to access the Drive item. 570 # 571 # Read-only. 572 "id": "A String", # Drive API resource ID. 573 "title": "A String", # Title of the Drive item. 574 # 575 # Read-only. 576 }, 577 "youTubeVideo": { # YouTube video item. # Youtube video attachment. 578 "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. 579 # 580 # Read-only. 581 "alternateLink": "A String", # URL that can be used to view the YouTube video. 582 # 583 # Read-only. 584 "id": "A String", # YouTube API resource ID. 585 "title": "A String", # Title of the YouTube video. 586 # 587 # Read-only. 588 }, 589 "form": { # Google Forms item. # Google Forms attachment. 590 "formUrl": "A String", # URL of the form. 591 "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. 592 # 593 # Read-only. 594 "responseUrl": "A String", # URL of the form responses document. 595 # Only set if respsonses have been recorded and only when the 596 # requesting user is an editor of the form. 597 # 598 # Read-only. 599 "title": "A String", # Title of the Form. 600 # 601 # Read-only. 602 }, 603 }, 604 ], 605 "title": "A String", # Title for this set. 606 }, 607 ], 608 "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the 609 # course. 610 # 611 # This field will only be set for teachers of the course and domain administrators. 612 # 613 # Read-only. 614 "alternateLink": "A String", # URL that can be used to access the Drive folder. 615 # 616 # Read-only. 617 "id": "A String", # Drive API resource ID. 618 "title": "A String", # Title of the Drive folder. 619 # 620 # Read-only. 621 }, 622 "ownerId": "A String", # The identifier of the owner of a course. 623 # 624 # When specified as a parameter of a 625 # create course request, this 626 # field is required. 627 # The identifier can be one of the following: 628 # 629 # * the numeric identifier for the user 630 # * the email address of the user 631 # * the string literal `"me"`, indicating the requesting user 632 # 633 # This must be set in a create request. Specifying this field in a course 634 # update mask results in an `INVALID_ARGUMENT` error. 635 "courseState": "A String", # State of the course. 636 # If unspecified, the default state is `PROVISIONED`. 637 "id": "A String", # Identifier for this course assigned by Classroom. 638 # 639 # When 640 # creating a course, 641 # you may optionally set this identifier to an 642 # alias string in the 643 # request to create a corresponding alias. The `id` is still assigned by 644 # Classroom and cannot be updated after the course is created. 645 # 646 # Specifying this field in a course update mask results in an error. 647 "descriptionHeading": "A String", # Optional heading for the description. 648 # For example, "Welcome to 10th Grade Biology." 649 # If set, this field must be a valid UTF-8 string and no longer than 3600 650 # characters. 651 "description": "A String", # Optional description. 652 # For example, "We'll be learning about the structure of living 653 # creatures from a combination of textbooks, guest lectures, and lab work. 654 # Expect to be excited!" 655 # If set, this field must be a valid UTF-8 string and no longer than 30,000 656 # characters. 657 }</pre> 658 </div> 659 660 <div class="method"> 661 <code class="details" id="list">list(studentId=None, pageSize=None, courseStates=None, teacherId=None, pageToken=None, x__xgafv=None)</code> 662 <pre>Returns a list of courses that the requesting user is permitted to view, 663 restricted to those that match the request. 664 665 This method returns the following error codes: 666 667 * `PERMISSION_DENIED` for access errors. 668 * `INVALID_ARGUMENT` if the query argument is malformed. 669 * `NOT_FOUND` if any users specified in the query arguments do not exist. 670 671 Args: 672 studentId: string, Restricts returned courses to those having a student with the specified 673 identifier. The identifier can be one of the following: 674 675 * the numeric identifier for the user 676 * the email address of the user 677 * the string literal `"me"`, indicating the requesting user 678 pageSize: integer, Maximum number of items to return. Zero or unspecified indicates that the 679 server may assign a maximum. 680 681 The server may return fewer than the specified number of results. 682 courseStates: string, Restricts returned courses to those in one of the specified states 683 The default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED. (repeated) 684 teacherId: string, Restricts returned courses to those having a teacher with the specified 685 identifier. The identifier can be one of the following: 686 687 * the numeric identifier for the user 688 * the email address of the user 689 * the string literal `"me"`, indicating the requesting user 690 pageToken: string, nextPageToken 691 value returned from a previous 692 list call, 693 indicating that the subsequent page of results should be returned. 694 695 The list request must be 696 otherwise identical to the one that resulted in this token. 697 x__xgafv: string, V1 error format. 698 Allowed values 699 1 - v1 error format 700 2 - v2 error format 701 702 Returns: 703 An object of the form: 704 705 { # Response when listing courses. 706 "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further 707 # results are available. 708 "courses": [ # Courses that match the list request. 709 { # A Course in Classroom. 710 "updateTime": "A String", # Time of the most recent update to this course. 711 # Specifying this field in a course update mask results in an error. 712 # 713 # Read-only. 714 "room": "A String", # Optional room location. 715 # For example, "301". 716 # If set, this field must be a valid UTF-8 string and no longer than 650 717 # characters. 718 "name": "A String", # Name of the course. 719 # For example, "10th Grade Biology". 720 # The name is required. It must be between 1 and 750 characters and a valid 721 # UTF-8 string. 722 "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. 723 # 724 # Read-only. 725 "enrollmentCode": "A String", # Enrollment code to use when joining this course. 726 # Specifying this field in a course update mask results in an error. 727 # 728 # Read-only. 729 "section": "A String", # Section of the course. 730 # For example, "Period 2". 731 # If set, this field must be a valid UTF-8 string and no longer than 2800 732 # characters. 733 "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. 734 # 735 # Read-only. 736 "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. 737 # This group does not accept email and can only be used for permissions. 738 # 739 # Read-only. 740 "creationTime": "A String", # Creation time of the course. 741 # Specifying this field in a course update mask results in an error. 742 # 743 # Read-only. 744 "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. 745 # This group does not accept email and can only be used for permissions. 746 # 747 # Read-only. 748 "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. 749 # 750 # Read-only. 751 { # A set of materials that appears on the "About" page of the course. 752 # These materials might include a syllabus, schedule, or other background 753 # information relating to the course as a whole. 754 "materials": [ # Materials attached to this set. 755 { # A material attached to a course as part of a material set. 756 "link": { # URL item. # Link atatchment. 757 "url": "A String", # URL to link to. 758 # This must be a valid UTF-8 string containing between 1 and 2024 characters. 759 "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. 760 # 761 # Read-only. 762 "title": "A String", # Title of the target of the URL. 763 # 764 # Read-only. 765 }, 766 "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment. 767 "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. 768 # 769 # Read-only. 770 "alternateLink": "A String", # URL that can be used to access the Drive item. 771 # 772 # Read-only. 773 "id": "A String", # Drive API resource ID. 774 "title": "A String", # Title of the Drive item. 775 # 776 # Read-only. 777 }, 778 "youTubeVideo": { # YouTube video item. # Youtube video attachment. 779 "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. 780 # 781 # Read-only. 782 "alternateLink": "A String", # URL that can be used to view the YouTube video. 783 # 784 # Read-only. 785 "id": "A String", # YouTube API resource ID. 786 "title": "A String", # Title of the YouTube video. 787 # 788 # Read-only. 789 }, 790 "form": { # Google Forms item. # Google Forms attachment. 791 "formUrl": "A String", # URL of the form. 792 "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. 793 # 794 # Read-only. 795 "responseUrl": "A String", # URL of the form responses document. 796 # Only set if respsonses have been recorded and only when the 797 # requesting user is an editor of the form. 798 # 799 # Read-only. 800 "title": "A String", # Title of the Form. 801 # 802 # Read-only. 803 }, 804 }, 805 ], 806 "title": "A String", # Title for this set. 807 }, 808 ], 809 "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the 810 # course. 811 # 812 # This field will only be set for teachers of the course and domain administrators. 813 # 814 # Read-only. 815 "alternateLink": "A String", # URL that can be used to access the Drive folder. 816 # 817 # Read-only. 818 "id": "A String", # Drive API resource ID. 819 "title": "A String", # Title of the Drive folder. 820 # 821 # Read-only. 822 }, 823 "ownerId": "A String", # The identifier of the owner of a course. 824 # 825 # When specified as a parameter of a 826 # create course request, this 827 # field is required. 828 # The identifier can be one of the following: 829 # 830 # * the numeric identifier for the user 831 # * the email address of the user 832 # * the string literal `"me"`, indicating the requesting user 833 # 834 # This must be set in a create request. Specifying this field in a course 835 # update mask results in an `INVALID_ARGUMENT` error. 836 "courseState": "A String", # State of the course. 837 # If unspecified, the default state is `PROVISIONED`. 838 "id": "A String", # Identifier for this course assigned by Classroom. 839 # 840 # When 841 # creating a course, 842 # you may optionally set this identifier to an 843 # alias string in the 844 # request to create a corresponding alias. The `id` is still assigned by 845 # Classroom and cannot be updated after the course is created. 846 # 847 # Specifying this field in a course update mask results in an error. 848 "descriptionHeading": "A String", # Optional heading for the description. 849 # For example, "Welcome to 10th Grade Biology." 850 # If set, this field must be a valid UTF-8 string and no longer than 3600 851 # characters. 852 "description": "A String", # Optional description. 853 # For example, "We'll be learning about the structure of living 854 # creatures from a combination of textbooks, guest lectures, and lab work. 855 # Expect to be excited!" 856 # If set, this field must be a valid UTF-8 string and no longer than 30,000 857 # characters. 858 }, 859 ], 860 }</pre> 861 </div> 862 863 <div class="method"> 864 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 865 <pre>Retrieves the next page of results. 866 867 Args: 868 previous_request: The request for the previous page. (required) 869 previous_response: The response from the request for the previous page. (required) 870 871 Returns: 872 A request object that you can call 'execute()' on to request the next 873 page. Returns None if there are no more items in the collection. 874 </pre> 875 </div> 876 877 <div class="method"> 878 <code class="details" id="patch">patch(id, body, updateMask=None, x__xgafv=None)</code> 879 <pre>Updates one or more fields in a course. 880 881 This method returns the following error codes: 882 883 * `PERMISSION_DENIED` if the requesting user is not permitted to modify the 884 requested course or for access errors. 885 * `NOT_FOUND` if no course exists with the requested ID. 886 * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or 887 if no update mask is supplied. 888 * `FAILED_PRECONDITION` for the following request errors: 889 * CourseNotModifiable 890 891 Args: 892 id: string, Identifier of the course to update. 893 This identifier can be either the Classroom-assigned identifier or an 894 alias. (required) 895 body: object, The request body. (required) 896 The object takes the form of: 897 898 { # A Course in Classroom. 899 "updateTime": "A String", # Time of the most recent update to this course. 900 # Specifying this field in a course update mask results in an error. 901 # 902 # Read-only. 903 "room": "A String", # Optional room location. 904 # For example, "301". 905 # If set, this field must be a valid UTF-8 string and no longer than 650 906 # characters. 907 "name": "A String", # Name of the course. 908 # For example, "10th Grade Biology". 909 # The name is required. It must be between 1 and 750 characters and a valid 910 # UTF-8 string. 911 "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. 912 # 913 # Read-only. 914 "enrollmentCode": "A String", # Enrollment code to use when joining this course. 915 # Specifying this field in a course update mask results in an error. 916 # 917 # Read-only. 918 "section": "A String", # Section of the course. 919 # For example, "Period 2". 920 # If set, this field must be a valid UTF-8 string and no longer than 2800 921 # characters. 922 "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. 923 # 924 # Read-only. 925 "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. 926 # This group does not accept email and can only be used for permissions. 927 # 928 # Read-only. 929 "creationTime": "A String", # Creation time of the course. 930 # Specifying this field in a course update mask results in an error. 931 # 932 # Read-only. 933 "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. 934 # This group does not accept email and can only be used for permissions. 935 # 936 # Read-only. 937 "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. 938 # 939 # Read-only. 940 { # A set of materials that appears on the "About" page of the course. 941 # These materials might include a syllabus, schedule, or other background 942 # information relating to the course as a whole. 943 "materials": [ # Materials attached to this set. 944 { # A material attached to a course as part of a material set. 945 "link": { # URL item. # Link atatchment. 946 "url": "A String", # URL to link to. 947 # This must be a valid UTF-8 string containing between 1 and 2024 characters. 948 "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. 949 # 950 # Read-only. 951 "title": "A String", # Title of the target of the URL. 952 # 953 # Read-only. 954 }, 955 "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment. 956 "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. 957 # 958 # Read-only. 959 "alternateLink": "A String", # URL that can be used to access the Drive item. 960 # 961 # Read-only. 962 "id": "A String", # Drive API resource ID. 963 "title": "A String", # Title of the Drive item. 964 # 965 # Read-only. 966 }, 967 "youTubeVideo": { # YouTube video item. # Youtube video attachment. 968 "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. 969 # 970 # Read-only. 971 "alternateLink": "A String", # URL that can be used to view the YouTube video. 972 # 973 # Read-only. 974 "id": "A String", # YouTube API resource ID. 975 "title": "A String", # Title of the YouTube video. 976 # 977 # Read-only. 978 }, 979 "form": { # Google Forms item. # Google Forms attachment. 980 "formUrl": "A String", # URL of the form. 981 "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. 982 # 983 # Read-only. 984 "responseUrl": "A String", # URL of the form responses document. 985 # Only set if respsonses have been recorded and only when the 986 # requesting user is an editor of the form. 987 # 988 # Read-only. 989 "title": "A String", # Title of the Form. 990 # 991 # Read-only. 992 }, 993 }, 994 ], 995 "title": "A String", # Title for this set. 996 }, 997 ], 998 "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the 999 # course. 1000 # 1001 # This field will only be set for teachers of the course and domain administrators. 1002 # 1003 # Read-only. 1004 "alternateLink": "A String", # URL that can be used to access the Drive folder. 1005 # 1006 # Read-only. 1007 "id": "A String", # Drive API resource ID. 1008 "title": "A String", # Title of the Drive folder. 1009 # 1010 # Read-only. 1011 }, 1012 "ownerId": "A String", # The identifier of the owner of a course. 1013 # 1014 # When specified as a parameter of a 1015 # create course request, this 1016 # field is required. 1017 # The identifier can be one of the following: 1018 # 1019 # * the numeric identifier for the user 1020 # * the email address of the user 1021 # * the string literal `"me"`, indicating the requesting user 1022 # 1023 # This must be set in a create request. Specifying this field in a course 1024 # update mask results in an `INVALID_ARGUMENT` error. 1025 "courseState": "A String", # State of the course. 1026 # If unspecified, the default state is `PROVISIONED`. 1027 "id": "A String", # Identifier for this course assigned by Classroom. 1028 # 1029 # When 1030 # creating a course, 1031 # you may optionally set this identifier to an 1032 # alias string in the 1033 # request to create a corresponding alias. The `id` is still assigned by 1034 # Classroom and cannot be updated after the course is created. 1035 # 1036 # Specifying this field in a course update mask results in an error. 1037 "descriptionHeading": "A String", # Optional heading for the description. 1038 # For example, "Welcome to 10th Grade Biology." 1039 # If set, this field must be a valid UTF-8 string and no longer than 3600 1040 # characters. 1041 "description": "A String", # Optional description. 1042 # For example, "We'll be learning about the structure of living 1043 # creatures from a combination of textbooks, guest lectures, and lab work. 1044 # Expect to be excited!" 1045 # If set, this field must be a valid UTF-8 string and no longer than 30,000 1046 # characters. 1047 } 1048 1049 updateMask: string, Mask that identifies which fields on the course to update. 1050 This field is required to do an update. The update will fail if invalid 1051 fields are specified. The following fields are valid: 1052 1053 * `name` 1054 * `section` 1055 * `descriptionHeading` 1056 * `description` 1057 * `room` 1058 * `courseState` 1059 1060 When set in a query parameter, this field should be specified as 1061 1062 `updateMask=<field1>,<field2>,...` 1063 x__xgafv: string, V1 error format. 1064 Allowed values 1065 1 - v1 error format 1066 2 - v2 error format 1067 1068 Returns: 1069 An object of the form: 1070 1071 { # A Course in Classroom. 1072 "updateTime": "A String", # Time of the most recent update to this course. 1073 # Specifying this field in a course update mask results in an error. 1074 # 1075 # Read-only. 1076 "room": "A String", # Optional room location. 1077 # For example, "301". 1078 # If set, this field must be a valid UTF-8 string and no longer than 650 1079 # characters. 1080 "name": "A String", # Name of the course. 1081 # For example, "10th Grade Biology". 1082 # The name is required. It must be between 1 and 750 characters and a valid 1083 # UTF-8 string. 1084 "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. 1085 # 1086 # Read-only. 1087 "enrollmentCode": "A String", # Enrollment code to use when joining this course. 1088 # Specifying this field in a course update mask results in an error. 1089 # 1090 # Read-only. 1091 "section": "A String", # Section of the course. 1092 # For example, "Period 2". 1093 # If set, this field must be a valid UTF-8 string and no longer than 2800 1094 # characters. 1095 "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. 1096 # 1097 # Read-only. 1098 "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. 1099 # This group does not accept email and can only be used for permissions. 1100 # 1101 # Read-only. 1102 "creationTime": "A String", # Creation time of the course. 1103 # Specifying this field in a course update mask results in an error. 1104 # 1105 # Read-only. 1106 "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. 1107 # This group does not accept email and can only be used for permissions. 1108 # 1109 # Read-only. 1110 "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. 1111 # 1112 # Read-only. 1113 { # A set of materials that appears on the "About" page of the course. 1114 # These materials might include a syllabus, schedule, or other background 1115 # information relating to the course as a whole. 1116 "materials": [ # Materials attached to this set. 1117 { # A material attached to a course as part of a material set. 1118 "link": { # URL item. # Link atatchment. 1119 "url": "A String", # URL to link to. 1120 # This must be a valid UTF-8 string containing between 1 and 2024 characters. 1121 "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. 1122 # 1123 # Read-only. 1124 "title": "A String", # Title of the target of the URL. 1125 # 1126 # Read-only. 1127 }, 1128 "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment. 1129 "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. 1130 # 1131 # Read-only. 1132 "alternateLink": "A String", # URL that can be used to access the Drive item. 1133 # 1134 # Read-only. 1135 "id": "A String", # Drive API resource ID. 1136 "title": "A String", # Title of the Drive item. 1137 # 1138 # Read-only. 1139 }, 1140 "youTubeVideo": { # YouTube video item. # Youtube video attachment. 1141 "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. 1142 # 1143 # Read-only. 1144 "alternateLink": "A String", # URL that can be used to view the YouTube video. 1145 # 1146 # Read-only. 1147 "id": "A String", # YouTube API resource ID. 1148 "title": "A String", # Title of the YouTube video. 1149 # 1150 # Read-only. 1151 }, 1152 "form": { # Google Forms item. # Google Forms attachment. 1153 "formUrl": "A String", # URL of the form. 1154 "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. 1155 # 1156 # Read-only. 1157 "responseUrl": "A String", # URL of the form responses document. 1158 # Only set if respsonses have been recorded and only when the 1159 # requesting user is an editor of the form. 1160 # 1161 # Read-only. 1162 "title": "A String", # Title of the Form. 1163 # 1164 # Read-only. 1165 }, 1166 }, 1167 ], 1168 "title": "A String", # Title for this set. 1169 }, 1170 ], 1171 "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the 1172 # course. 1173 # 1174 # This field will only be set for teachers of the course and domain administrators. 1175 # 1176 # Read-only. 1177 "alternateLink": "A String", # URL that can be used to access the Drive folder. 1178 # 1179 # Read-only. 1180 "id": "A String", # Drive API resource ID. 1181 "title": "A String", # Title of the Drive folder. 1182 # 1183 # Read-only. 1184 }, 1185 "ownerId": "A String", # The identifier of the owner of a course. 1186 # 1187 # When specified as a parameter of a 1188 # create course request, this 1189 # field is required. 1190 # The identifier can be one of the following: 1191 # 1192 # * the numeric identifier for the user 1193 # * the email address of the user 1194 # * the string literal `"me"`, indicating the requesting user 1195 # 1196 # This must be set in a create request. Specifying this field in a course 1197 # update mask results in an `INVALID_ARGUMENT` error. 1198 "courseState": "A String", # State of the course. 1199 # If unspecified, the default state is `PROVISIONED`. 1200 "id": "A String", # Identifier for this course assigned by Classroom. 1201 # 1202 # When 1203 # creating a course, 1204 # you may optionally set this identifier to an 1205 # alias string in the 1206 # request to create a corresponding alias. The `id` is still assigned by 1207 # Classroom and cannot be updated after the course is created. 1208 # 1209 # Specifying this field in a course update mask results in an error. 1210 "descriptionHeading": "A String", # Optional heading for the description. 1211 # For example, "Welcome to 10th Grade Biology." 1212 # If set, this field must be a valid UTF-8 string and no longer than 3600 1213 # characters. 1214 "description": "A String", # Optional description. 1215 # For example, "We'll be learning about the structure of living 1216 # creatures from a combination of textbooks, guest lectures, and lab work. 1217 # Expect to be excited!" 1218 # If set, this field must be a valid UTF-8 string and no longer than 30,000 1219 # characters. 1220 }</pre> 1221 </div> 1222 1223 <div class="method"> 1224 <code class="details" id="update">update(id, body, x__xgafv=None)</code> 1225 <pre>Updates a course. 1226 1227 This method returns the following error codes: 1228 1229 * `PERMISSION_DENIED` if the requesting user is not permitted to modify the 1230 requested course or for access errors. 1231 * `NOT_FOUND` if no course exists with the requested ID. 1232 * `FAILED_PRECONDITION` for the following request errors: 1233 * CourseNotModifiable 1234 1235 Args: 1236 id: string, Identifier of the course to update. 1237 This identifier can be either the Classroom-assigned identifier or an 1238 alias. (required) 1239 body: object, The request body. (required) 1240 The object takes the form of: 1241 1242 { # A Course in Classroom. 1243 "updateTime": "A String", # Time of the most recent update to this course. 1244 # Specifying this field in a course update mask results in an error. 1245 # 1246 # Read-only. 1247 "room": "A String", # Optional room location. 1248 # For example, "301". 1249 # If set, this field must be a valid UTF-8 string and no longer than 650 1250 # characters. 1251 "name": "A String", # Name of the course. 1252 # For example, "10th Grade Biology". 1253 # The name is required. It must be between 1 and 750 characters and a valid 1254 # UTF-8 string. 1255 "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. 1256 # 1257 # Read-only. 1258 "enrollmentCode": "A String", # Enrollment code to use when joining this course. 1259 # Specifying this field in a course update mask results in an error. 1260 # 1261 # Read-only. 1262 "section": "A String", # Section of the course. 1263 # For example, "Period 2". 1264 # If set, this field must be a valid UTF-8 string and no longer than 2800 1265 # characters. 1266 "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. 1267 # 1268 # Read-only. 1269 "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. 1270 # This group does not accept email and can only be used for permissions. 1271 # 1272 # Read-only. 1273 "creationTime": "A String", # Creation time of the course. 1274 # Specifying this field in a course update mask results in an error. 1275 # 1276 # Read-only. 1277 "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. 1278 # This group does not accept email and can only be used for permissions. 1279 # 1280 # Read-only. 1281 "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. 1282 # 1283 # Read-only. 1284 { # A set of materials that appears on the "About" page of the course. 1285 # These materials might include a syllabus, schedule, or other background 1286 # information relating to the course as a whole. 1287 "materials": [ # Materials attached to this set. 1288 { # A material attached to a course as part of a material set. 1289 "link": { # URL item. # Link atatchment. 1290 "url": "A String", # URL to link to. 1291 # This must be a valid UTF-8 string containing between 1 and 2024 characters. 1292 "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. 1293 # 1294 # Read-only. 1295 "title": "A String", # Title of the target of the URL. 1296 # 1297 # Read-only. 1298 }, 1299 "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment. 1300 "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. 1301 # 1302 # Read-only. 1303 "alternateLink": "A String", # URL that can be used to access the Drive item. 1304 # 1305 # Read-only. 1306 "id": "A String", # Drive API resource ID. 1307 "title": "A String", # Title of the Drive item. 1308 # 1309 # Read-only. 1310 }, 1311 "youTubeVideo": { # YouTube video item. # Youtube video attachment. 1312 "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. 1313 # 1314 # Read-only. 1315 "alternateLink": "A String", # URL that can be used to view the YouTube video. 1316 # 1317 # Read-only. 1318 "id": "A String", # YouTube API resource ID. 1319 "title": "A String", # Title of the YouTube video. 1320 # 1321 # Read-only. 1322 }, 1323 "form": { # Google Forms item. # Google Forms attachment. 1324 "formUrl": "A String", # URL of the form. 1325 "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. 1326 # 1327 # Read-only. 1328 "responseUrl": "A String", # URL of the form responses document. 1329 # Only set if respsonses have been recorded and only when the 1330 # requesting user is an editor of the form. 1331 # 1332 # Read-only. 1333 "title": "A String", # Title of the Form. 1334 # 1335 # Read-only. 1336 }, 1337 }, 1338 ], 1339 "title": "A String", # Title for this set. 1340 }, 1341 ], 1342 "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the 1343 # course. 1344 # 1345 # This field will only be set for teachers of the course and domain administrators. 1346 # 1347 # Read-only. 1348 "alternateLink": "A String", # URL that can be used to access the Drive folder. 1349 # 1350 # Read-only. 1351 "id": "A String", # Drive API resource ID. 1352 "title": "A String", # Title of the Drive folder. 1353 # 1354 # Read-only. 1355 }, 1356 "ownerId": "A String", # The identifier of the owner of a course. 1357 # 1358 # When specified as a parameter of a 1359 # create course request, this 1360 # field is required. 1361 # The identifier can be one of the following: 1362 # 1363 # * the numeric identifier for the user 1364 # * the email address of the user 1365 # * the string literal `"me"`, indicating the requesting user 1366 # 1367 # This must be set in a create request. Specifying this field in a course 1368 # update mask results in an `INVALID_ARGUMENT` error. 1369 "courseState": "A String", # State of the course. 1370 # If unspecified, the default state is `PROVISIONED`. 1371 "id": "A String", # Identifier for this course assigned by Classroom. 1372 # 1373 # When 1374 # creating a course, 1375 # you may optionally set this identifier to an 1376 # alias string in the 1377 # request to create a corresponding alias. The `id` is still assigned by 1378 # Classroom and cannot be updated after the course is created. 1379 # 1380 # Specifying this field in a course update mask results in an error. 1381 "descriptionHeading": "A String", # Optional heading for the description. 1382 # For example, "Welcome to 10th Grade Biology." 1383 # If set, this field must be a valid UTF-8 string and no longer than 3600 1384 # characters. 1385 "description": "A String", # Optional description. 1386 # For example, "We'll be learning about the structure of living 1387 # creatures from a combination of textbooks, guest lectures, and lab work. 1388 # Expect to be excited!" 1389 # If set, this field must be a valid UTF-8 string and no longer than 30,000 1390 # characters. 1391 } 1392 1393 x__xgafv: string, V1 error format. 1394 Allowed values 1395 1 - v1 error format 1396 2 - v2 error format 1397 1398 Returns: 1399 An object of the form: 1400 1401 { # A Course in Classroom. 1402 "updateTime": "A String", # Time of the most recent update to this course. 1403 # Specifying this field in a course update mask results in an error. 1404 # 1405 # Read-only. 1406 "room": "A String", # Optional room location. 1407 # For example, "301". 1408 # If set, this field must be a valid UTF-8 string and no longer than 650 1409 # characters. 1410 "name": "A String", # Name of the course. 1411 # For example, "10th Grade Biology". 1412 # The name is required. It must be between 1 and 750 characters and a valid 1413 # UTF-8 string. 1414 "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. 1415 # 1416 # Read-only. 1417 "enrollmentCode": "A String", # Enrollment code to use when joining this course. 1418 # Specifying this field in a course update mask results in an error. 1419 # 1420 # Read-only. 1421 "section": "A String", # Section of the course. 1422 # For example, "Period 2". 1423 # If set, this field must be a valid UTF-8 string and no longer than 2800 1424 # characters. 1425 "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. 1426 # 1427 # Read-only. 1428 "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. 1429 # This group does not accept email and can only be used for permissions. 1430 # 1431 # Read-only. 1432 "creationTime": "A String", # Creation time of the course. 1433 # Specifying this field in a course update mask results in an error. 1434 # 1435 # Read-only. 1436 "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. 1437 # This group does not accept email and can only be used for permissions. 1438 # 1439 # Read-only. 1440 "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. 1441 # 1442 # Read-only. 1443 { # A set of materials that appears on the "About" page of the course. 1444 # These materials might include a syllabus, schedule, or other background 1445 # information relating to the course as a whole. 1446 "materials": [ # Materials attached to this set. 1447 { # A material attached to a course as part of a material set. 1448 "link": { # URL item. # Link atatchment. 1449 "url": "A String", # URL to link to. 1450 # This must be a valid UTF-8 string containing between 1 and 2024 characters. 1451 "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. 1452 # 1453 # Read-only. 1454 "title": "A String", # Title of the target of the URL. 1455 # 1456 # Read-only. 1457 }, 1458 "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment. 1459 "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. 1460 # 1461 # Read-only. 1462 "alternateLink": "A String", # URL that can be used to access the Drive item. 1463 # 1464 # Read-only. 1465 "id": "A String", # Drive API resource ID. 1466 "title": "A String", # Title of the Drive item. 1467 # 1468 # Read-only. 1469 }, 1470 "youTubeVideo": { # YouTube video item. # Youtube video attachment. 1471 "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. 1472 # 1473 # Read-only. 1474 "alternateLink": "A String", # URL that can be used to view the YouTube video. 1475 # 1476 # Read-only. 1477 "id": "A String", # YouTube API resource ID. 1478 "title": "A String", # Title of the YouTube video. 1479 # 1480 # Read-only. 1481 }, 1482 "form": { # Google Forms item. # Google Forms attachment. 1483 "formUrl": "A String", # URL of the form. 1484 "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. 1485 # 1486 # Read-only. 1487 "responseUrl": "A String", # URL of the form responses document. 1488 # Only set if respsonses have been recorded and only when the 1489 # requesting user is an editor of the form. 1490 # 1491 # Read-only. 1492 "title": "A String", # Title of the Form. 1493 # 1494 # Read-only. 1495 }, 1496 }, 1497 ], 1498 "title": "A String", # Title for this set. 1499 }, 1500 ], 1501 "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the 1502 # course. 1503 # 1504 # This field will only be set for teachers of the course and domain administrators. 1505 # 1506 # Read-only. 1507 "alternateLink": "A String", # URL that can be used to access the Drive folder. 1508 # 1509 # Read-only. 1510 "id": "A String", # Drive API resource ID. 1511 "title": "A String", # Title of the Drive folder. 1512 # 1513 # Read-only. 1514 }, 1515 "ownerId": "A String", # The identifier of the owner of a course. 1516 # 1517 # When specified as a parameter of a 1518 # create course request, this 1519 # field is required. 1520 # The identifier can be one of the following: 1521 # 1522 # * the numeric identifier for the user 1523 # * the email address of the user 1524 # * the string literal `"me"`, indicating the requesting user 1525 # 1526 # This must be set in a create request. Specifying this field in a course 1527 # update mask results in an `INVALID_ARGUMENT` error. 1528 "courseState": "A String", # State of the course. 1529 # If unspecified, the default state is `PROVISIONED`. 1530 "id": "A String", # Identifier for this course assigned by Classroom. 1531 # 1532 # When 1533 # creating a course, 1534 # you may optionally set this identifier to an 1535 # alias string in the 1536 # request to create a corresponding alias. The `id` is still assigned by 1537 # Classroom and cannot be updated after the course is created. 1538 # 1539 # Specifying this field in a course update mask results in an error. 1540 "descriptionHeading": "A String", # Optional heading for the description. 1541 # For example, "Welcome to 10th Grade Biology." 1542 # If set, this field must be a valid UTF-8 string and no longer than 3600 1543 # characters. 1544 "description": "A String", # Optional description. 1545 # For example, "We'll be learning about the structure of living 1546 # creatures from a combination of textbooks, guest lectures, and lab work. 1547 # Expect to be excited!" 1548 # If set, this field must be a valid UTF-8 string and no longer than 30,000 1549 # characters. 1550 }</pre> 1551 </div> 1552 1553 </body></html>
