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