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