Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c30d2b5d4478b230246dcaaa9f1c533ca3304387 / . / docs / dyn / classroom_v1.courses.html
blob: 35adde3626cf5d69fc9d2263ef80fcc42e06a1b7 [file] [log] [blame]
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="classroom_v1.html">Google Classroom API</a> . <a href="classroom_v1.courses.html">courses</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="classroom_v1.courses.aliases.html">aliases()</a></code>
79</p>
80<p class="firstline">Returns the aliases Resource.</p>
81
82<p class="toc_element">
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]83 <code><a href="classroom_v1.courses.courseWork.html">courseWork()</a></code>
84</p>
85<p class="firstline">Returns the courseWork Resource.</p>
86
87<p class="toc_element">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]88 <code><a href="classroom_v1.courses.students.html">students()</a></code>
89</p>
90<p class="firstline">Returns the students Resource.</p>
91
92<p class="toc_element">
93 <code><a href="classroom_v1.courses.teachers.html">teachers()</a></code>
94</p>
95<p class="firstline">Returns the teachers Resource.</p>
96
97<p class="toc_element">
98 <code><a href="#create">create(body, x__xgafv=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]99<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 Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]100<p class="toc_element">
101 <code><a href="#delete">delete(id, x__xgafv=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]102<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 Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]103<p class="toc_element">
104 <code><a href="#get">get(id, x__xgafv=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]105<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 Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]106<p class="toc_element">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]107 <code><a href="#list">list(studentId=None, pageSize=None, courseStates=None, teacherId=None, pageToken=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]108<p class="firstline">Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. 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 Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]109<p class="toc_element">
110 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
111<p class="firstline">Retrieves the next page of results.</p>
112<p class="toc_element">
113 <code><a href="#patch">patch(id, body, updateMask=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]114<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 Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]115<p class="toc_element">
116 <code><a href="#update">update(id, body, x__xgafv=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]117<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 Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]118<h3>Method Details</h3>
119<div class="method">
120 <code class="details" id="create">create(body, x__xgafv=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]121 <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 Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]122
123Args:
124 body: object, The request body. (required)
125 The object takes the form of:
126
127{ # A Course in Classroom.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]128 "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.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]129 "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]130 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]131 "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]132 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]133 "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.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]134 "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.
135 "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
136 "id": "A String", # Drive API resource ID.
137 "title": "A String", # Title of the Drive folder. Read-only.
138 },
139 "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]140 "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.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]141 "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.
142 "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
143 { # 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.
144 "materials": [ # Materials attached to this set.
145 { # A material attached to a course as part of a material set.
146 "link": { # URL item. # Link atatchment.
147 "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
148 "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
149 "title": "A String", # Title of the target of the URL. Read-only.
150 },
151 "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
152 "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
153 "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
154 "id": "A String", # Drive API resource ID.
155 "title": "A String", # Title of the Drive item. Read-only.
156 },
157 "youTubeVideo": { # YouTube video item. # Youtube video attachment.
158 "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
159 "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
160 "id": "A String", # YouTube API resource ID.
161 "title": "A String", # Title of the YouTube video. Read-only.
162 },
163 "form": { # Google Forms item. # Google Forms attachment.
164 "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
165 "formUrl": "A String", # URL of the form.
166 "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
167 "title": "A String", # Title of the Form. Read-only.
168 },
169 },
170 ],
171 "title": "A String", # Title for this set.
172 },
173 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]174 "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]175 "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.
176 "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. Specifying this field in a course update mask results in an `INVALID_ARGUMENT` error.
177 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]178 "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.
179 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]180}
181
182 x__xgafv: string, V1 error format.
183
184Returns:
185 An object of the form:
186
187 { # A Course in Classroom.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]188 "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.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]189 "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]190 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]191 "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]192 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]193 "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.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]194 "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.
195 "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
196 "id": "A String", # Drive API resource ID.
197 "title": "A String", # Title of the Drive folder. Read-only.
198 },
199 "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]200 "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.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]201 "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.
202 "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
203 { # 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.
204 "materials": [ # Materials attached to this set.
205 { # A material attached to a course as part of a material set.
206 "link": { # URL item. # Link atatchment.
207 "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
208 "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
209 "title": "A String", # Title of the target of the URL. Read-only.
210 },
211 "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
212 "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
213 "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
214 "id": "A String", # Drive API resource ID.
215 "title": "A String", # Title of the Drive item. Read-only.
216 },
217 "youTubeVideo": { # YouTube video item. # Youtube video attachment.
218 "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
219 "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
220 "id": "A String", # YouTube API resource ID.
221 "title": "A String", # Title of the YouTube video. Read-only.
222 },
223 "form": { # Google Forms item. # Google Forms attachment.
224 "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
225 "formUrl": "A String", # URL of the form.
226 "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.
227 "title": "A String", # Title of the Form. Read-only.
228 },
229 },
230 ],
231 "title": "A String", # Title for this set.
232 },
233 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]234 "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]235 "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.
236 "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. Specifying this field in a course update mask results in an `INVALID_ARGUMENT` error.
237 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]238 "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.
239 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]240 }</pre>
241</div>
242
243<div class="method">
244 <code class="details" id="delete">delete(id, x__xgafv=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]245 <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 Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]246
247Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]248 id: string, Identifier of the course to delete. This identifier can be either the Classroom-assigned identifier or an alias. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]249 x__xgafv: string, V1 error format.
250
251Returns:
252 An object of the form:
253
254 { # 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 `{}`.
255 }</pre>
256</div>
257
258<div class="method">
259 <code class="details" id="get">get(id, x__xgafv=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]260 <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 Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]261
262Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]263 id: string, Identifier of the course to return. This identifier can be either the Classroom-assigned identifier or an alias. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]264 x__xgafv: string, V1 error format.
265
266Returns:
267 An object of the form:
268
269 { # A Course in Classroom.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]270 "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.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]271 "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]272 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]273 "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]274 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]275 "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.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]276 "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.
277 "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
278 "id": "A String", # Drive API resource ID.
279 "title": "A String", # Title of the Drive folder. Read-only.
280 },
281 "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]282 "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.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]283 "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.
284 "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
285 { # 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.
286 "materials": [ # Materials attached to this set.
287 { # A material attached to a course as part of a material set.
288 "link": { # URL item. # Link atatchment.
289 "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
290 "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
291 "title": "A String", # Title of the target of the URL. Read-only.
292 },
293 "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
294 "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
295 "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
296 "id": "A String", # Drive API resource ID.
297 "title": "A String", # Title of the Drive item. Read-only.
298 },
299 "youTubeVideo": { # YouTube video item. # Youtube video attachment.
300 "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
301 "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
302 "id": "A String", # YouTube API resource ID.
303 "title": "A String", # Title of the YouTube video. Read-only.
304 },
305 "form": { # Google Forms item. # Google Forms attachment.
306 "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
307 "formUrl": "A String", # URL of the form.
308 "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.
309 "title": "A String", # Title of the Form. Read-only.
310 },
311 },
312 ],
313 "title": "A String", # Title for this set.
314 },
315 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]316 "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]317 "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.
318 "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. Specifying this field in a course update mask results in an `INVALID_ARGUMENT` error.
319 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]320 "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.
321 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]322 }</pre>
323</div>
324
325<div class="method">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]326 <code class="details" id="list">list(studentId=None, pageSize=None, courseStates=None, teacherId=None, pageToken=None, x__xgafv=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]327 <pre>Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. 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 Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]328
329Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]330 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
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]331 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.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]332 courseStates: string, Restricts returned courses to those in one of the specified states (repeated)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]333 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
334 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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]335 x__xgafv: string, V1 error format.
336
337Returns:
338 An object of the form:
339
340 { # Response when listing courses.
341 "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]342 "courses": [ # Courses that match the list request.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]343 { # A Course in Classroom.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]344 "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.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]345 "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]346 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]347 "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]348 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]349 "section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]350 "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only.
351 "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
352 "id": "A String", # Drive API resource ID.
353 "title": "A String", # Title of the Drive folder. Read-only.
354 },
355 "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]356 "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.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]357 "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.
358 "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
359 { # 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.
360 "materials": [ # Materials attached to this set.
361 { # A material attached to a course as part of a material set.
362 "link": { # URL item. # Link atatchment.
363 "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
364 "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
365 "title": "A String", # Title of the target of the URL. Read-only.
366 },
367 "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
368 "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
369 "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
370 "id": "A String", # Drive API resource ID.
371 "title": "A String", # Title of the Drive item. Read-only.
372 },
373 "youTubeVideo": { # YouTube video item. # Youtube video attachment.
374 "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
375 "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
376 "id": "A String", # YouTube API resource ID.
377 "title": "A String", # Title of the YouTube video. Read-only.
378 },
379 "form": { # Google Forms item. # Google Forms attachment.
380 "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
381 "formUrl": "A String", # URL of the form.
382 "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.
383 "title": "A String", # Title of the Form. Read-only.
384 },
385 },
386 ],
387 "title": "A String", # Title for this set.
388 },
389 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]390 "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]391 "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.
392 "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. Specifying this field in a course update mask results in an `INVALID_ARGUMENT` error.
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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]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 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]396 },
397 ],
398 }</pre>
399</div>
400
401<div class="method">
402 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
403 <pre>Retrieves the next page of results.
404
405Args:
406 previous_request: The request for the previous page. (required)
407 previous_response: The response from the request for the previous page. (required)
408
409Returns:
410 A request object that you can call 'execute()' on to request the next
411 page. Returns None if there are no more items in the collection.
412 </pre>
413</div>
414
415<div class="method">
416 <code class="details" id="patch">patch(id, body, updateMask=None, x__xgafv=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]417 <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 Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]418
419Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]420 id: string, Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]421 body: object, The request body. (required)
422 The object takes the form of:
423
424{ # A Course in Classroom.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]425 "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.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]426 "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]427 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]428 "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]429 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]430 "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.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]431 "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.
432 "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
433 "id": "A String", # Drive API resource ID.
434 "title": "A String", # Title of the Drive folder. Read-only.
435 },
436 "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]437 "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.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]438 "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.
439 "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
440 { # 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.
441 "materials": [ # Materials attached to this set.
442 { # A material attached to a course as part of a material set.
443 "link": { # URL item. # Link atatchment.
444 "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
445 "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
446 "title": "A String", # Title of the target of the URL. Read-only.
447 },
448 "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
449 "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
450 "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
451 "id": "A String", # Drive API resource ID.
452 "title": "A String", # Title of the Drive item. Read-only.
453 },
454 "youTubeVideo": { # YouTube video item. # Youtube video attachment.
455 "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
456 "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
457 "id": "A String", # YouTube API resource ID.
458 "title": "A String", # Title of the YouTube video. Read-only.
459 },
460 "form": { # Google Forms item. # Google Forms attachment.
461 "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
462 "formUrl": "A String", # URL of the form.
463 "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.
464 "title": "A String", # Title of the Form. Read-only.
465 },
466 },
467 ],
468 "title": "A String", # Title for this set.
469 },
470 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]471 "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]472 "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.
473 "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. Specifying this field in a course update mask results in an `INVALID_ARGUMENT` error.
474 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]475 "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.
476 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]477}
478
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]479 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` When set in a query parameter, this field should be specified as `updateMask=,,...`
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]480 x__xgafv: string, V1 error format.
481
482Returns:
483 An object of the form:
484
485 { # A Course in Classroom.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]486 "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.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]487 "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]488 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]489 "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]490 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]491 "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.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]492 "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.
493 "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
494 "id": "A String", # Drive API resource ID.
495 "title": "A String", # Title of the Drive folder. Read-only.
496 },
497 "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]498 "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.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]499 "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.
500 "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
501 { # 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.
502 "materials": [ # Materials attached to this set.
503 { # A material attached to a course as part of a material set.
504 "link": { # URL item. # Link atatchment.
505 "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
506 "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
507 "title": "A String", # Title of the target of the URL. Read-only.
508 },
509 "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
510 "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
511 "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
512 "id": "A String", # Drive API resource ID.
513 "title": "A String", # Title of the Drive item. Read-only.
514 },
515 "youTubeVideo": { # YouTube video item. # Youtube video attachment.
516 "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
517 "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
518 "id": "A String", # YouTube API resource ID.
519 "title": "A String", # Title of the YouTube video. Read-only.
520 },
521 "form": { # Google Forms item. # Google Forms attachment.
522 "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
523 "formUrl": "A String", # URL of the form.
524 "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.
525 "title": "A String", # Title of the Form. Read-only.
526 },
527 },
528 ],
529 "title": "A String", # Title for this set.
530 },
531 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]532 "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]533 "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.
534 "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. Specifying this field in a course update mask results in an `INVALID_ARGUMENT` error.
535 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]536 "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.
537 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]538 }</pre>
539</div>
540
541<div class="method">
542 <code class="details" id="update">update(id, body, x__xgafv=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]543 <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 Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]544
545Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]546 id: string, Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]547 body: object, The request body. (required)
548 The object takes the form of:
549
550{ # A Course in Classroom.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]551 "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.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]552 "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]553 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]554 "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]555 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]556 "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.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]557 "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.
558 "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
559 "id": "A String", # Drive API resource ID.
560 "title": "A String", # Title of the Drive folder. Read-only.
561 },
562 "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]563 "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.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]564 "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.
565 "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
566 { # 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.
567 "materials": [ # Materials attached to this set.
568 { # A material attached to a course as part of a material set.
569 "link": { # URL item. # Link atatchment.
570 "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
571 "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
572 "title": "A String", # Title of the target of the URL. Read-only.
573 },
574 "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
575 "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
576 "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
577 "id": "A String", # Drive API resource ID.
578 "title": "A String", # Title of the Drive item. Read-only.
579 },
580 "youTubeVideo": { # YouTube video item. # Youtube video attachment.
581 "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
582 "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
583 "id": "A String", # YouTube API resource ID.
584 "title": "A String", # Title of the YouTube video. Read-only.
585 },
586 "form": { # Google Forms item. # Google Forms attachment.
587 "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
588 "formUrl": "A String", # URL of the form.
589 "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.
590 "title": "A String", # Title of the Form. Read-only.
591 },
592 },
593 ],
594 "title": "A String", # Title for this set.
595 },
596 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]597 "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]598 "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.
599 "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. Specifying this field in a course update mask results in an `INVALID_ARGUMENT` error.
600 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]601 "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.
602 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]603}
604
605 x__xgafv: string, V1 error format.
606
607Returns:
608 An object of the form:
609
610 { # A Course in Classroom.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]611 "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.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]612 "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]613 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]614 "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]615 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]616 "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.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]617 "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.
618 "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
619 "id": "A String", # Drive API resource ID.
620 "title": "A String", # Title of the Drive folder. Read-only.
621 },
622 "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]623 "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.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]624 "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.
625 "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
626 { # 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.
627 "materials": [ # Materials attached to this set.
628 { # A material attached to a course as part of a material set.
629 "link": { # URL item. # Link atatchment.
630 "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
631 "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
632 "title": "A String", # Title of the target of the URL. Read-only.
633 },
634 "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
635 "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
636 "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
637 "id": "A String", # Drive API resource ID.
638 "title": "A String", # Title of the Drive item. Read-only.
639 },
640 "youTubeVideo": { # YouTube video item. # Youtube video attachment.
641 "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
642 "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
643 "id": "A String", # YouTube API resource ID.
644 "title": "A String", # Title of the YouTube video. Read-only.
645 },
646 "form": { # Google Forms item. # Google Forms attachment.
647 "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
648 "formUrl": "A String", # URL of the form.
649 "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.
650 "title": "A String", # Title of the Form. Read-only.
651 },
652 },
653 ],
654 "title": "A String", # Title for this set.
655 },
656 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]657 "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]658 "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.
659 "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. Specifying this field in a course update mask results in an `INVALID_ARGUMENT` error.
660 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]661 "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.
662 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]663 }</pre>
664</div>
665
666</body></html>