docs: update docs/dyn (#1096)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/6f0f288a-a1e8-4b2d-a85f-00b1c6150185/targets
- [ ] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/synthtool/commit/39b7149da4026765385403632db3c6f63db96b2c
Source-Link: https://github.com/googleapis/synthtool/commit/9a7d9fbb7045c34c9d3d22c1ff766eeae51f04c9
Source-Link: https://github.com/googleapis/synthtool/commit/dc9903a8c30c3662b6098f0e4a97f221d67268b2
Source-Link: https://github.com/googleapis/synthtool/commit/7fcc405a579d5d53a726ff3da1b7c8c08f0f2d58
Source-Link: https://github.com/googleapis/synthtool/commit/d5fc0bcf9ea9789c5b0e3154a9e3b29e5cea6116
Source-Link: https://github.com/googleapis/synthtool/commit/e89175cf074dccc4babb4eca66ae913696e47a71
Source-Link: https://github.com/googleapis/synthtool/commit/7d652819519dfa24da9e14548232e4aaba71a11c
Source-Link: https://github.com/googleapis/synthtool/commit/7db8a6c5ffb12a6e4c2f799c18f00f7f3d60e279
Source-Link: https://github.com/googleapis/synthtool/commit/1f1148d3c7a7a52f0c98077f976bd9b3c948ee2b
Source-Link: https://github.com/googleapis/synthtool/commit/2c8aecedd55b0480fb4e123b6e07fa5b12953862
Source-Link: https://github.com/googleapis/synthtool/commit/3d3e94c4e02370f307a9a200b0c743c3d8d19f29
Source-Link: https://github.com/googleapis/synthtool/commit/c7824ea48ff6d4d42dfae0849aec8a85acd90bd9
Source-Link: https://github.com/googleapis/synthtool/commit/ba9918cd22874245b55734f57470c719b577e591
Source-Link: https://github.com/googleapis/synthtool/commit/b19b401571e77192f8dd38eab5fb2300a0de9324
Source-Link: https://github.com/googleapis/synthtool/commit/6542bd723403513626f61642fc02ddca528409aa
diff --git a/docs/dyn/classroom_v1.courses.html b/docs/dyn/classroom_v1.courses.html
index 4169e2e..c5f9269 100644
--- a/docs/dyn/classroom_v1.courses.html
+++ b/docs/dyn/classroom_v1.courses.html
@@ -122,7 +122,7 @@
<code><a href="#get">get(id, x__xgafv=None)</a></code></p>
<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>
<p class="toc_element">
- <code><a href="#list">list(pageToken=None, teacherId=None, studentId=None, courseStates=None, pageSize=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(teacherId=None, studentId=None, pageToken=None, courseStates=None, pageSize=None, x__xgafv=None)</a></code></p>
<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>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -148,60 +148,60 @@
The object takes the form of:
{ # A Course in Classroom.
- "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.
- "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
- "id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive folder. Read-only.
- },
- "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.
- "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.
- "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.
- "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
- "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.
- "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.
- "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
- { # 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.
- "title": "A String", # Title for this set.
- "materials": [ # Materials attached to this set.
- { # A material attached to a course as part of a material set.
- "form": { # Google Forms item. # Google Forms attachment.
- "title": "A String", # Title of the Form. Read-only.
- "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.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
- "formUrl": "A String", # URL of the form.
+ "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
+ { # 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.
+ "title": "A String", # Title for this set.
+ "materials": [ # Materials attached to this set.
+ { # A material attached to a course as part of a material set.
+ "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
+ "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
+ "id": "A String", # Drive API resource ID.
+ "title": "A String", # Title of the Drive item. Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
+ },
+ "link": { # URL item. # Link atatchment.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
+ "title": "A String", # Title of the target of the URL. Read-only.
+ "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
+ },
+ "form": { # Google Forms item. # Google Forms attachment.
+ "title": "A String", # Title of the Form. Read-only.
+ "formUrl": "A String", # URL of the form.
+ "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.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
+ },
+ "youTubeVideo": { # YouTube video item. # Youtube video attachment.
+ "id": "A String", # YouTube API resource ID.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
+ "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
+ "title": "A String", # Title of the YouTube video. Read-only.
+ },
},
- "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
- "title": "A String", # Title of the Drive item. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
- "id": "A String", # Drive API resource ID.
- },
- "youTubeVideo": { # YouTube video item. # Youtube video attachment.
- "title": "A String", # Title of the YouTube video. Read-only.
- "id": "A String", # YouTube API resource ID.
- "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
- },
- "link": { # URL item. # Link atatchment.
- "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
- "title": "A String", # Title of the target of the URL. Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
- },
- },
- ],
+ ],
+ },
+ ],
+ "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
+ "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.
+ "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.
+ "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.
+ "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.
+ "title": "A String", # Title of the Drive folder. Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
+ "id": "A String", # Drive API resource ID.
},
- ],
- "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.
- "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.
- "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
- "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.
- "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.
- "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.
- "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
- "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.
- "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
- "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.
-}
+ "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.
+ "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.
+ "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.
+ "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.
+ "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.
+ "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.
+ "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.
+ "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
+ "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.
+ "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
+ "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
+ "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.
+ }
x__xgafv: string, V1 error format.
Allowed values
@@ -212,60 +212,60 @@
An object of the form:
{ # A Course in Classroom.
- "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.
- "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
- "id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive folder. Read-only.
- },
- "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.
- "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.
- "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.
- "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
- "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.
- "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.
- "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
- { # 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.
- "title": "A String", # Title for this set.
- "materials": [ # Materials attached to this set.
- { # A material attached to a course as part of a material set.
- "form": { # Google Forms item. # Google Forms attachment.
- "title": "A String", # Title of the Form. Read-only.
- "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.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
- "formUrl": "A String", # URL of the form.
+ "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
+ { # 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.
+ "title": "A String", # Title for this set.
+ "materials": [ # Materials attached to this set.
+ { # A material attached to a course as part of a material set.
+ "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
+ "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
+ "id": "A String", # Drive API resource ID.
+ "title": "A String", # Title of the Drive item. Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
+ },
+ "link": { # URL item. # Link atatchment.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
+ "title": "A String", # Title of the target of the URL. Read-only.
+ "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
+ },
+ "form": { # Google Forms item. # Google Forms attachment.
+ "title": "A String", # Title of the Form. Read-only.
+ "formUrl": "A String", # URL of the form.
+ "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.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
+ },
+ "youTubeVideo": { # YouTube video item. # Youtube video attachment.
+ "id": "A String", # YouTube API resource ID.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
+ "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
+ "title": "A String", # Title of the YouTube video. Read-only.
+ },
},
- "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
- "title": "A String", # Title of the Drive item. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
- "id": "A String", # Drive API resource ID.
- },
- "youTubeVideo": { # YouTube video item. # Youtube video attachment.
- "title": "A String", # Title of the YouTube video. Read-only.
- "id": "A String", # YouTube API resource ID.
- "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
- },
- "link": { # URL item. # Link atatchment.
- "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
- "title": "A String", # Title of the target of the URL. Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
- },
- },
- ],
+ ],
+ },
+ ],
+ "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
+ "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.
+ "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.
+ "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.
+ "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.
+ "title": "A String", # Title of the Drive folder. Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
+ "id": "A String", # Drive API resource ID.
},
- ],
- "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.
- "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.
- "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
- "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.
- "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.
- "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.
- "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
- "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.
- "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
- "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.
- }</pre>
+ "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.
+ "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.
+ "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.
+ "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.
+ "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.
+ "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.
+ "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.
+ "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
+ "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.
+ "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
+ "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
+ "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.
+ }</pre>
</div>
<div class="method">
@@ -301,70 +301,70 @@
An object of the form:
{ # A Course in Classroom.
- "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.
- "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
- "id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive folder. Read-only.
- },
- "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.
- "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.
- "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.
- "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
- "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.
- "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.
- "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
- { # 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.
- "title": "A String", # Title for this set.
- "materials": [ # Materials attached to this set.
- { # A material attached to a course as part of a material set.
- "form": { # Google Forms item. # Google Forms attachment.
- "title": "A String", # Title of the Form. Read-only.
- "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.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
- "formUrl": "A String", # URL of the form.
+ "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
+ { # 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.
+ "title": "A String", # Title for this set.
+ "materials": [ # Materials attached to this set.
+ { # A material attached to a course as part of a material set.
+ "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
+ "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
+ "id": "A String", # Drive API resource ID.
+ "title": "A String", # Title of the Drive item. Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
+ },
+ "link": { # URL item. # Link atatchment.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
+ "title": "A String", # Title of the target of the URL. Read-only.
+ "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
+ },
+ "form": { # Google Forms item. # Google Forms attachment.
+ "title": "A String", # Title of the Form. Read-only.
+ "formUrl": "A String", # URL of the form.
+ "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.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
+ },
+ "youTubeVideo": { # YouTube video item. # Youtube video attachment.
+ "id": "A String", # YouTube API resource ID.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
+ "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
+ "title": "A String", # Title of the YouTube video. Read-only.
+ },
},
- "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
- "title": "A String", # Title of the Drive item. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
- "id": "A String", # Drive API resource ID.
- },
- "youTubeVideo": { # YouTube video item. # Youtube video attachment.
- "title": "A String", # Title of the YouTube video. Read-only.
- "id": "A String", # YouTube API resource ID.
- "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
- },
- "link": { # URL item. # Link atatchment.
- "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
- "title": "A String", # Title of the target of the URL. Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
- },
- },
- ],
+ ],
+ },
+ ],
+ "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
+ "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.
+ "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.
+ "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.
+ "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.
+ "title": "A String", # Title of the Drive folder. Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
+ "id": "A String", # Drive API resource ID.
},
- ],
- "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.
- "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.
- "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
- "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.
- "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.
- "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.
- "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
- "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.
- "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
- "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.
- }</pre>
+ "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.
+ "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.
+ "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.
+ "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.
+ "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.
+ "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.
+ "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.
+ "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
+ "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.
+ "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
+ "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
+ "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.
+ }</pre>
</div>
<div class="method">
- <code class="details" id="list">list(pageToken=None, teacherId=None, studentId=None, courseStates=None, pageSize=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(teacherId=None, studentId=None, pageToken=None, courseStates=None, pageSize=None, x__xgafv=None)</code>
<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.
Args:
- 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.
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
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
+ 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.
courseStates: string, Restricts returned courses to those in one of the specified states The default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED. (repeated)
Allowed values
COURSE_STATE_UNSPECIFIED - No course state. No returned Course message will use this value.
@@ -385,60 +385,60 @@
{ # Response when listing courses.
"courses": [ # Courses that match the list request.
{ # A Course in Classroom.
- "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.
- "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
- "id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive folder. Read-only.
- },
- "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.
- "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.
- "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.
- "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
- "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.
- "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.
- "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
- { # 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.
- "title": "A String", # Title for this set.
- "materials": [ # Materials attached to this set.
- { # A material attached to a course as part of a material set.
- "form": { # Google Forms item. # Google Forms attachment.
- "title": "A String", # Title of the Form. Read-only.
- "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.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
- "formUrl": "A String", # URL of the form.
+ "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
+ { # 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.
+ "title": "A String", # Title for this set.
+ "materials": [ # Materials attached to this set.
+ { # A material attached to a course as part of a material set.
+ "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
+ "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
+ "id": "A String", # Drive API resource ID.
+ "title": "A String", # Title of the Drive item. Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
+ },
+ "link": { # URL item. # Link atatchment.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
+ "title": "A String", # Title of the target of the URL. Read-only.
+ "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
+ },
+ "form": { # Google Forms item. # Google Forms attachment.
+ "title": "A String", # Title of the Form. Read-only.
+ "formUrl": "A String", # URL of the form.
+ "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.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
+ },
+ "youTubeVideo": { # YouTube video item. # Youtube video attachment.
+ "id": "A String", # YouTube API resource ID.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
+ "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
+ "title": "A String", # Title of the YouTube video. Read-only.
+ },
},
- "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
- "title": "A String", # Title of the Drive item. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
- "id": "A String", # Drive API resource ID.
- },
- "youTubeVideo": { # YouTube video item. # Youtube video attachment.
- "title": "A String", # Title of the YouTube video. Read-only.
- "id": "A String", # YouTube API resource ID.
- "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
- },
- "link": { # URL item. # Link atatchment.
- "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
- "title": "A String", # Title of the target of the URL. Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
- },
- },
- ],
+ ],
+ },
+ ],
+ "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
+ "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.
+ "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.
+ "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.
+ "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.
+ "title": "A String", # Title of the Drive folder. Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
+ "id": "A String", # Drive API resource ID.
},
- ],
- "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.
- "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.
- "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
- "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.
- "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.
- "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.
- "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
- "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.
- "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
- "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.
- },
+ "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.
+ "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.
+ "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.
+ "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.
+ "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.
+ "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.
+ "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.
+ "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
+ "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.
+ "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
+ "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
+ "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.
+ },
],
"nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available.
}</pre>
@@ -468,60 +468,60 @@
The object takes the form of:
{ # A Course in Classroom.
- "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.
- "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
- "id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive folder. Read-only.
- },
- "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.
- "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.
- "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.
- "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
- "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.
- "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.
- "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
- { # 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.
- "title": "A String", # Title for this set.
- "materials": [ # Materials attached to this set.
- { # A material attached to a course as part of a material set.
- "form": { # Google Forms item. # Google Forms attachment.
- "title": "A String", # Title of the Form. Read-only.
- "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.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
- "formUrl": "A String", # URL of the form.
+ "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
+ { # 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.
+ "title": "A String", # Title for this set.
+ "materials": [ # Materials attached to this set.
+ { # A material attached to a course as part of a material set.
+ "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
+ "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
+ "id": "A String", # Drive API resource ID.
+ "title": "A String", # Title of the Drive item. Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
+ },
+ "link": { # URL item. # Link atatchment.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
+ "title": "A String", # Title of the target of the URL. Read-only.
+ "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
+ },
+ "form": { # Google Forms item. # Google Forms attachment.
+ "title": "A String", # Title of the Form. Read-only.
+ "formUrl": "A String", # URL of the form.
+ "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.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
+ },
+ "youTubeVideo": { # YouTube video item. # Youtube video attachment.
+ "id": "A String", # YouTube API resource ID.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
+ "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
+ "title": "A String", # Title of the YouTube video. Read-only.
+ },
},
- "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
- "title": "A String", # Title of the Drive item. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
- "id": "A String", # Drive API resource ID.
- },
- "youTubeVideo": { # YouTube video item. # Youtube video attachment.
- "title": "A String", # Title of the YouTube video. Read-only.
- "id": "A String", # YouTube API resource ID.
- "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
- },
- "link": { # URL item. # Link atatchment.
- "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
- "title": "A String", # Title of the target of the URL. Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
- },
- },
- ],
+ ],
+ },
+ ],
+ "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
+ "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.
+ "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.
+ "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.
+ "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.
+ "title": "A String", # Title of the Drive folder. Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
+ "id": "A String", # Drive API resource ID.
},
- ],
- "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.
- "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.
- "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
- "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.
- "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.
- "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.
- "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
- "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.
- "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
- "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.
-}
+ "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.
+ "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.
+ "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.
+ "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.
+ "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.
+ "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.
+ "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.
+ "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
+ "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.
+ "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
+ "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
+ "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.
+ }
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=,,...`
x__xgafv: string, V1 error format.
@@ -533,60 +533,60 @@
An object of the form:
{ # A Course in Classroom.
- "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.
- "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
- "id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive folder. Read-only.
- },
- "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.
- "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.
- "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.
- "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
- "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.
- "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.
- "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
- { # 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.
- "title": "A String", # Title for this set.
- "materials": [ # Materials attached to this set.
- { # A material attached to a course as part of a material set.
- "form": { # Google Forms item. # Google Forms attachment.
- "title": "A String", # Title of the Form. Read-only.
- "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.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
- "formUrl": "A String", # URL of the form.
+ "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
+ { # 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.
+ "title": "A String", # Title for this set.
+ "materials": [ # Materials attached to this set.
+ { # A material attached to a course as part of a material set.
+ "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
+ "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
+ "id": "A String", # Drive API resource ID.
+ "title": "A String", # Title of the Drive item. Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
+ },
+ "link": { # URL item. # Link atatchment.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
+ "title": "A String", # Title of the target of the URL. Read-only.
+ "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
+ },
+ "form": { # Google Forms item. # Google Forms attachment.
+ "title": "A String", # Title of the Form. Read-only.
+ "formUrl": "A String", # URL of the form.
+ "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.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
+ },
+ "youTubeVideo": { # YouTube video item. # Youtube video attachment.
+ "id": "A String", # YouTube API resource ID.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
+ "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
+ "title": "A String", # Title of the YouTube video. Read-only.
+ },
},
- "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
- "title": "A String", # Title of the Drive item. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
- "id": "A String", # Drive API resource ID.
- },
- "youTubeVideo": { # YouTube video item. # Youtube video attachment.
- "title": "A String", # Title of the YouTube video. Read-only.
- "id": "A String", # YouTube API resource ID.
- "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
- },
- "link": { # URL item. # Link atatchment.
- "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
- "title": "A String", # Title of the target of the URL. Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
- },
- },
- ],
+ ],
+ },
+ ],
+ "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
+ "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.
+ "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.
+ "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.
+ "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.
+ "title": "A String", # Title of the Drive folder. Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
+ "id": "A String", # Drive API resource ID.
},
- ],
- "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.
- "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.
- "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
- "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.
- "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.
- "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.
- "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
- "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.
- "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
- "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.
- }</pre>
+ "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.
+ "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.
+ "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.
+ "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.
+ "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.
+ "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.
+ "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.
+ "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
+ "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.
+ "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
+ "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
+ "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.
+ }</pre>
</div>
<div class="method">
@@ -599,60 +599,60 @@
The object takes the form of:
{ # A Course in Classroom.
- "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.
- "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
- "id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive folder. Read-only.
- },
- "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.
- "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.
- "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.
- "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
- "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.
- "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.
- "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
- { # 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.
- "title": "A String", # Title for this set.
- "materials": [ # Materials attached to this set.
- { # A material attached to a course as part of a material set.
- "form": { # Google Forms item. # Google Forms attachment.
- "title": "A String", # Title of the Form. Read-only.
- "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.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
- "formUrl": "A String", # URL of the form.
+ "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
+ { # 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.
+ "title": "A String", # Title for this set.
+ "materials": [ # Materials attached to this set.
+ { # A material attached to a course as part of a material set.
+ "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
+ "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
+ "id": "A String", # Drive API resource ID.
+ "title": "A String", # Title of the Drive item. Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
+ },
+ "link": { # URL item. # Link atatchment.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
+ "title": "A String", # Title of the target of the URL. Read-only.
+ "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
+ },
+ "form": { # Google Forms item. # Google Forms attachment.
+ "title": "A String", # Title of the Form. Read-only.
+ "formUrl": "A String", # URL of the form.
+ "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.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
+ },
+ "youTubeVideo": { # YouTube video item. # Youtube video attachment.
+ "id": "A String", # YouTube API resource ID.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
+ "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
+ "title": "A String", # Title of the YouTube video. Read-only.
+ },
},
- "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
- "title": "A String", # Title of the Drive item. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
- "id": "A String", # Drive API resource ID.
- },
- "youTubeVideo": { # YouTube video item. # Youtube video attachment.
- "title": "A String", # Title of the YouTube video. Read-only.
- "id": "A String", # YouTube API resource ID.
- "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
- },
- "link": { # URL item. # Link atatchment.
- "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
- "title": "A String", # Title of the target of the URL. Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
- },
- },
- ],
+ ],
+ },
+ ],
+ "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
+ "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.
+ "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.
+ "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.
+ "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.
+ "title": "A String", # Title of the Drive folder. Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
+ "id": "A String", # Drive API resource ID.
},
- ],
- "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.
- "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.
- "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
- "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.
- "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.
- "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.
- "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
- "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.
- "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
- "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.
-}
+ "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.
+ "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.
+ "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.
+ "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.
+ "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.
+ "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.
+ "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.
+ "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
+ "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.
+ "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
+ "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
+ "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.
+ }
x__xgafv: string, V1 error format.
Allowed values
@@ -663,60 +663,60 @@
An object of the form:
{ # A Course in Classroom.
- "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.
- "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
- "id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive folder. Read-only.
- },
- "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.
- "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.
- "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.
- "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
- "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.
- "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.
- "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
- { # 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.
- "title": "A String", # Title for this set.
- "materials": [ # Materials attached to this set.
- { # A material attached to a course as part of a material set.
- "form": { # Google Forms item. # Google Forms attachment.
- "title": "A String", # Title of the Form. Read-only.
- "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.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
- "formUrl": "A String", # URL of the form.
+ "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
+ { # 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.
+ "title": "A String", # Title for this set.
+ "materials": [ # Materials attached to this set.
+ { # A material attached to a course as part of a material set.
+ "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
+ "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
+ "id": "A String", # Drive API resource ID.
+ "title": "A String", # Title of the Drive item. Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
+ },
+ "link": { # URL item. # Link atatchment.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
+ "title": "A String", # Title of the target of the URL. Read-only.
+ "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
+ },
+ "form": { # Google Forms item. # Google Forms attachment.
+ "title": "A String", # Title of the Form. Read-only.
+ "formUrl": "A String", # URL of the form.
+ "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.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
+ },
+ "youTubeVideo": { # YouTube video item. # Youtube video attachment.
+ "id": "A String", # YouTube API resource ID.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
+ "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
+ "title": "A String", # Title of the YouTube video. Read-only.
+ },
},
- "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
- "title": "A String", # Title of the Drive item. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
- "id": "A String", # Drive API resource ID.
- },
- "youTubeVideo": { # YouTube video item. # Youtube video attachment.
- "title": "A String", # Title of the YouTube video. Read-only.
- "id": "A String", # YouTube API resource ID.
- "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
- },
- "link": { # URL item. # Link atatchment.
- "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
- "title": "A String", # Title of the target of the URL. Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
- },
- },
- ],
+ ],
+ },
+ ],
+ "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
+ "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.
+ "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.
+ "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.
+ "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.
+ "title": "A String", # Title of the Drive folder. Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
+ "id": "A String", # Drive API resource ID.
},
- ],
- "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.
- "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.
- "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
- "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.
- "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.
- "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.
- "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
- "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.
- "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
- "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.
- }</pre>
+ "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.
+ "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.
+ "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.
+ "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.
+ "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.
+ "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.
+ "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.
+ "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
+ "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.
+ "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
+ "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
+ "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.
+ }</pre>
</div>
</body></html>
\ No newline at end of file