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