docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/classroom_v1.courses.html b/docs/dyn/classroom_v1.courses.html
index bb1def8..9fd7ca2 100644
--- a/docs/dyn/classroom_v1.courses.html
+++ b/docs/dyn/classroom_v1.courses.html
@@ -114,7 +114,7 @@
<code><a href="#get">get(id, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a course.</p>
<p class="toc_element">
- <code><a href="#list">list(studentId=None, pageSize=None, courseStates=None, teacherId=None, pageToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(studentId=None, pageToken=None, pageSize=None, teacherId=None, courseStates=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a list of courses that the requesting user is permitted to view,</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -138,7 +138,7 @@
* `PERMISSION_DENIED` if the requesting user is not permitted to create
courses or for access errors.
* `NOT_FOUND` if the primary teacher is not a valid user.
-* `FAILED_PRECONDITION` if the course owner's account is disabled or for
+* `FAILED_PRECONDITION` if the course owner's account is disabled or for
the following request errors:
* UserGroupsMembershipLimitReached
* `ALREADY_EXISTS` if an alias was specified in the `id` and
@@ -149,143 +149,11 @@
The object takes the form of:
{ # A Course in Classroom.
- "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.
- "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.
- "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.
- "alternateLink": "A String", # Absolute link to this course in the Classroom web UI.
- #
- # 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.
- "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.
- "section": "A String", # Section of the course.
- # For example, "Period 2".
+ "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.
- "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course.
- #
- # Read-only.
- "creationTime": "A String", # Creation time of the course.
- # Specifying this field in a course update mask results in an error.
- #
- # 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.
- "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.
- "materials": [ # Materials attached to this set.
- { # A material attached to a course as part of a material set.
- "youTubeVideo": { # YouTube video item. # Youtube video attachment.
- "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.
- "id": "A String", # YouTube API resource ID.
- "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.
- "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.
- },
- "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.
- "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.
- },
- "form": { # Google Forms item. # Google Forms attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image 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.
- "title": "A String", # Title of the Form.
- #
- # Read-only.
- },
- },
- ],
- "title": "A String", # Title for this set.
- },
- ],
- "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.
- "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.
- },
- "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.
- "courseState": "A String", # State of the course.
- # If unspecified, the default state is `PROVISIONED`.
- "id": "A String", # Identifier for this course assigned by Classroom.
+ "id": "A String", # Identifier for this course assigned by Classroom.
#
# When
# creating a course,
@@ -295,14 +163,146 @@
# 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.
- "room": "A String", # Optional room location.
- # For example, "301".
+ "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.
+ "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.
+ "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.
+ "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.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.
+ #
+ # Read-only.
+ "id": "A String", # Drive API resource ID.
+ },
+ "youTubeVideo": { # YouTube video item. # Youtube video attachment.
+ "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.
+ "id": "A String", # YouTube API resource ID.
+ "title": "A String", # Title of the YouTube video.
+ #
+ # Read-only.
+ },
+ "form": { # Google Forms item. # Google Forms attachment.
+ "title": "A String", # Title of the Form.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image 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.
+ "formUrl": "A String", # URL of the form.
+ },
+ "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.
+ },
+ },
+ ],
+ },
+ ],
+ "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.
+ "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.
+ "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.
+ "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.
+ "alternateLink": "A String", # Absolute link to this course in the Classroom web UI.
+ #
+ # Read-only.
+ "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course.
+ #
+ # Read-only.
+ "courseState": "A String", # State of the course.
+ # If unspecified, the default state is `PROVISIONED`.
+ "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.
+ "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.
+ "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.
+ "creationTime": "A String", # Creation time of the course.
+ # Specifying this field in a course update mask results in an error.
+ #
+ # 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.
+ "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.
+ },
}
x__xgafv: string, V1 error format.
@@ -314,143 +314,11 @@
An object of the form:
{ # A Course in Classroom.
- "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.
- "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.
- "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.
- "alternateLink": "A String", # Absolute link to this course in the Classroom web UI.
- #
- # 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.
- "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.
- "section": "A String", # Section of the course.
- # For example, "Period 2".
+ "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.
- "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course.
- #
- # Read-only.
- "creationTime": "A String", # Creation time of the course.
- # Specifying this field in a course update mask results in an error.
- #
- # 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.
- "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.
- "materials": [ # Materials attached to this set.
- { # A material attached to a course as part of a material set.
- "youTubeVideo": { # YouTube video item. # Youtube video attachment.
- "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.
- "id": "A String", # YouTube API resource ID.
- "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.
- "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.
- },
- "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.
- "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.
- },
- "form": { # Google Forms item. # Google Forms attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image 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.
- "title": "A String", # Title of the Form.
- #
- # Read-only.
- },
- },
- ],
- "title": "A String", # Title for this set.
- },
- ],
- "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.
- "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.
- },
- "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.
- "courseState": "A String", # State of the course.
- # If unspecified, the default state is `PROVISIONED`.
- "id": "A String", # Identifier for this course assigned by Classroom.
+ "id": "A String", # Identifier for this course assigned by Classroom.
#
# When
# creating a course,
@@ -460,14 +328,146 @@
# 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.
- "room": "A String", # Optional room location.
- # For example, "301".
+ "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.
+ "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.
+ "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.
+ "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.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.
+ #
+ # Read-only.
+ "id": "A String", # Drive API resource ID.
+ },
+ "youTubeVideo": { # YouTube video item. # Youtube video attachment.
+ "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.
+ "id": "A String", # YouTube API resource ID.
+ "title": "A String", # Title of the YouTube video.
+ #
+ # Read-only.
+ },
+ "form": { # Google Forms item. # Google Forms attachment.
+ "title": "A String", # Title of the Form.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image 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.
+ "formUrl": "A String", # URL of the form.
+ },
+ "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.
+ },
+ },
+ ],
+ },
+ ],
+ "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.
+ "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.
+ "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.
+ "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.
+ "alternateLink": "A String", # Absolute link to this course in the Classroom web UI.
+ #
+ # Read-only.
+ "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course.
+ #
+ # Read-only.
+ "courseState": "A String", # State of the course.
+ # If unspecified, the default state is `PROVISIONED`.
+ "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.
+ "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.
+ "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.
+ "creationTime": "A String", # Creation time of the course.
+ # Specifying this field in a course update mask results in an error.
+ #
+ # 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.
+ "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.
+ },
}</pre>
</div>
@@ -528,143 +528,11 @@
An object of the form:
{ # A Course in Classroom.
- "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.
- "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.
- "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.
- "alternateLink": "A String", # Absolute link to this course in the Classroom web UI.
- #
- # 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.
- "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.
- "section": "A String", # Section of the course.
- # For example, "Period 2".
+ "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.
- "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course.
- #
- # Read-only.
- "creationTime": "A String", # Creation time of the course.
- # Specifying this field in a course update mask results in an error.
- #
- # 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.
- "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.
- "materials": [ # Materials attached to this set.
- { # A material attached to a course as part of a material set.
- "youTubeVideo": { # YouTube video item. # Youtube video attachment.
- "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.
- "id": "A String", # YouTube API resource ID.
- "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.
- "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.
- },
- "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.
- "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.
- },
- "form": { # Google Forms item. # Google Forms attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image 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.
- "title": "A String", # Title of the Form.
- #
- # Read-only.
- },
- },
- ],
- "title": "A String", # Title for this set.
- },
- ],
- "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.
- "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.
- },
- "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.
- "courseState": "A String", # State of the course.
- # If unspecified, the default state is `PROVISIONED`.
- "id": "A String", # Identifier for this course assigned by Classroom.
+ "id": "A String", # Identifier for this course assigned by Classroom.
#
# When
# creating a course,
@@ -674,19 +542,151 @@
# 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.
- "room": "A String", # Optional room location.
- # For example, "301".
+ "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.
+ "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.
+ "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.
+ "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.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.
+ #
+ # Read-only.
+ "id": "A String", # Drive API resource ID.
+ },
+ "youTubeVideo": { # YouTube video item. # Youtube video attachment.
+ "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.
+ "id": "A String", # YouTube API resource ID.
+ "title": "A String", # Title of the YouTube video.
+ #
+ # Read-only.
+ },
+ "form": { # Google Forms item. # Google Forms attachment.
+ "title": "A String", # Title of the Form.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image 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.
+ "formUrl": "A String", # URL of the form.
+ },
+ "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.
+ },
+ },
+ ],
+ },
+ ],
+ "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.
+ "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.
+ "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.
+ "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.
+ "alternateLink": "A String", # Absolute link to this course in the Classroom web UI.
+ #
+ # Read-only.
+ "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course.
+ #
+ # Read-only.
+ "courseState": "A String", # State of the course.
+ # If unspecified, the default state is `PROVISIONED`.
+ "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.
+ "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.
+ "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.
+ "creationTime": "A String", # Creation time of the course.
+ # Specifying this field in a course update mask results in an error.
+ #
+ # 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.
+ "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.
+ },
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(studentId=None, pageSize=None, courseStates=None, teacherId=None, pageToken=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(studentId=None, pageToken=None, pageSize=None, teacherId=None, courseStates=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.
@@ -703,19 +703,7 @@
* the numeric identifier for the user
* the email address of the user
-* the string literal `"me"`, indicating the requesting user
- pageSize: integer, Maximum number of items to return. Zero or unspecified indicates that the
-server may assign a maximum.
-
-The server may return fewer than the specified number of results.
- courseStates: string, Restricts returned courses to those in one of the specified states
-The default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED. (repeated)
- 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
+* the string literal `"me"`, indicating the requesting user
pageToken: string, nextPageToken
value returned from a previous
list call,
@@ -723,6 +711,18 @@
The list request must be
otherwise identical to the one that resulted in this token.
+ pageSize: integer, Maximum number of items to return. Zero or unspecified indicates that the
+server may assign a maximum.
+
+The server may return fewer than the specified number of results.
+ 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
+ courseStates: string, Restricts returned courses to those in one of the specified states
+The default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED. (repeated)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -732,147 +732,13 @@
An object of the form:
{ # Response when listing courses.
- "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further
- # results are available.
- "courses": [ # Courses that match the list request.
+ "courses": [ # Courses that match the list request.
{ # A Course in Classroom.
- "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.
- "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.
- "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.
- "alternateLink": "A String", # Absolute link to this course in the Classroom web UI.
- #
- # 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.
- "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.
- "section": "A String", # Section of the course.
- # For example, "Period 2".
+ "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.
- "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course.
- #
- # Read-only.
- "creationTime": "A String", # Creation time of the course.
- # Specifying this field in a course update mask results in an error.
- #
- # 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.
- "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.
- "materials": [ # Materials attached to this set.
- { # A material attached to a course as part of a material set.
- "youTubeVideo": { # YouTube video item. # Youtube video attachment.
- "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.
- "id": "A String", # YouTube API resource ID.
- "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.
- "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.
- },
- "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.
- "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.
- },
- "form": { # Google Forms item. # Google Forms attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image 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.
- "title": "A String", # Title of the Form.
- #
- # Read-only.
- },
- },
- ],
- "title": "A String", # Title for this set.
- },
- ],
- "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.
- "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.
- },
- "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.
- "courseState": "A String", # State of the course.
- # If unspecified, the default state is `PROVISIONED`.
- "id": "A String", # Identifier for this course assigned by Classroom.
+ "id": "A String", # Identifier for this course assigned by Classroom.
#
# When
# creating a course,
@@ -882,16 +748,150 @@
# 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.
- "room": "A String", # Optional room location.
- # For example, "301".
+ "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.
+ "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.
+ "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.
+ "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.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.
+ #
+ # Read-only.
+ "id": "A String", # Drive API resource ID.
+ },
+ "youTubeVideo": { # YouTube video item. # Youtube video attachment.
+ "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.
+ "id": "A String", # YouTube API resource ID.
+ "title": "A String", # Title of the YouTube video.
+ #
+ # Read-only.
+ },
+ "form": { # Google Forms item. # Google Forms attachment.
+ "title": "A String", # Title of the Form.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image 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.
+ "formUrl": "A String", # URL of the form.
+ },
+ "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.
+ },
+ },
+ ],
+ },
+ ],
+ "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.
+ "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.
+ "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.
+ "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.
+ "alternateLink": "A String", # Absolute link to this course in the Classroom web UI.
+ #
+ # Read-only.
+ "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course.
+ #
+ # Read-only.
+ "courseState": "A String", # State of the course.
+ # If unspecified, the default state is `PROVISIONED`.
+ "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.
+ "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.
+ "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.
+ "creationTime": "A String", # Creation time of the course.
+ # Specifying this field in a course update mask results in an error.
+ #
+ # 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.
+ "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.
+ },
},
],
+ "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further
+ # results are available.
}</pre>
</div>
@@ -904,7 +904,7 @@
previous_response: The response from the request for the previous page. (required)
Returns:
- A request object that you can call 'execute()' on to request the next
+ A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
@@ -931,143 +931,11 @@
The object takes the form of:
{ # A Course in Classroom.
- "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.
- "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.
- "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.
- "alternateLink": "A String", # Absolute link to this course in the Classroom web UI.
- #
- # 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.
- "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.
- "section": "A String", # Section of the course.
- # For example, "Period 2".
+ "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.
- "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course.
- #
- # Read-only.
- "creationTime": "A String", # Creation time of the course.
- # Specifying this field in a course update mask results in an error.
- #
- # 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.
- "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.
- "materials": [ # Materials attached to this set.
- { # A material attached to a course as part of a material set.
- "youTubeVideo": { # YouTube video item. # Youtube video attachment.
- "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.
- "id": "A String", # YouTube API resource ID.
- "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.
- "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.
- },
- "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.
- "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.
- },
- "form": { # Google Forms item. # Google Forms attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image 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.
- "title": "A String", # Title of the Form.
- #
- # Read-only.
- },
- },
- ],
- "title": "A String", # Title for this set.
- },
- ],
- "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.
- "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.
- },
- "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.
- "courseState": "A String", # State of the course.
- # If unspecified, the default state is `PROVISIONED`.
- "id": "A String", # Identifier for this course assigned by Classroom.
+ "id": "A String", # Identifier for this course assigned by Classroom.
#
# When
# creating a course,
@@ -1077,14 +945,146 @@
# 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.
- "room": "A String", # Optional room location.
- # For example, "301".
+ "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.
+ "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.
+ "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.
+ "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.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.
+ #
+ # Read-only.
+ "id": "A String", # Drive API resource ID.
+ },
+ "youTubeVideo": { # YouTube video item. # Youtube video attachment.
+ "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.
+ "id": "A String", # YouTube API resource ID.
+ "title": "A String", # Title of the YouTube video.
+ #
+ # Read-only.
+ },
+ "form": { # Google Forms item. # Google Forms attachment.
+ "title": "A String", # Title of the Form.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image 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.
+ "formUrl": "A String", # URL of the form.
+ },
+ "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.
+ },
+ },
+ ],
+ },
+ ],
+ "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.
+ "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.
+ "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.
+ "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.
+ "alternateLink": "A String", # Absolute link to this course in the Classroom web UI.
+ #
+ # Read-only.
+ "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course.
+ #
+ # Read-only.
+ "courseState": "A String", # State of the course.
+ # If unspecified, the default state is `PROVISIONED`.
+ "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.
+ "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.
+ "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.
+ "creationTime": "A String", # Creation time of the course.
+ # Specifying this field in a course update mask results in an error.
+ #
+ # 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.
+ "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.
+ },
}
updateMask: string, Mask that identifies which fields on the course to update.
@@ -1115,143 +1115,11 @@
An object of the form:
{ # A Course in Classroom.
- "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.
- "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.
- "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.
- "alternateLink": "A String", # Absolute link to this course in the Classroom web UI.
- #
- # 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.
- "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.
- "section": "A String", # Section of the course.
- # For example, "Period 2".
+ "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.
- "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course.
- #
- # Read-only.
- "creationTime": "A String", # Creation time of the course.
- # Specifying this field in a course update mask results in an error.
- #
- # 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.
- "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.
- "materials": [ # Materials attached to this set.
- { # A material attached to a course as part of a material set.
- "youTubeVideo": { # YouTube video item. # Youtube video attachment.
- "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.
- "id": "A String", # YouTube API resource ID.
- "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.
- "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.
- },
- "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.
- "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.
- },
- "form": { # Google Forms item. # Google Forms attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image 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.
- "title": "A String", # Title of the Form.
- #
- # Read-only.
- },
- },
- ],
- "title": "A String", # Title for this set.
- },
- ],
- "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.
- "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.
- },
- "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.
- "courseState": "A String", # State of the course.
- # If unspecified, the default state is `PROVISIONED`.
- "id": "A String", # Identifier for this course assigned by Classroom.
+ "id": "A String", # Identifier for this course assigned by Classroom.
#
# When
# creating a course,
@@ -1261,14 +1129,146 @@
# 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.
- "room": "A String", # Optional room location.
- # For example, "301".
+ "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.
+ "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.
+ "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.
+ "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.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.
+ #
+ # Read-only.
+ "id": "A String", # Drive API resource ID.
+ },
+ "youTubeVideo": { # YouTube video item. # Youtube video attachment.
+ "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.
+ "id": "A String", # YouTube API resource ID.
+ "title": "A String", # Title of the YouTube video.
+ #
+ # Read-only.
+ },
+ "form": { # Google Forms item. # Google Forms attachment.
+ "title": "A String", # Title of the Form.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image 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.
+ "formUrl": "A String", # URL of the form.
+ },
+ "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.
+ },
+ },
+ ],
+ },
+ ],
+ "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.
+ "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.
+ "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.
+ "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.
+ "alternateLink": "A String", # Absolute link to this course in the Classroom web UI.
+ #
+ # Read-only.
+ "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course.
+ #
+ # Read-only.
+ "courseState": "A String", # State of the course.
+ # If unspecified, the default state is `PROVISIONED`.
+ "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.
+ "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.
+ "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.
+ "creationTime": "A String", # Creation time of the course.
+ # Specifying this field in a course update mask results in an error.
+ #
+ # 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.
+ "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.
+ },
}</pre>
</div>
@@ -1292,143 +1292,11 @@
The object takes the form of:
{ # A Course in Classroom.
- "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.
- "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.
- "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.
- "alternateLink": "A String", # Absolute link to this course in the Classroom web UI.
- #
- # 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.
- "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.
- "section": "A String", # Section of the course.
- # For example, "Period 2".
+ "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.
- "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course.
- #
- # Read-only.
- "creationTime": "A String", # Creation time of the course.
- # Specifying this field in a course update mask results in an error.
- #
- # 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.
- "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.
- "materials": [ # Materials attached to this set.
- { # A material attached to a course as part of a material set.
- "youTubeVideo": { # YouTube video item. # Youtube video attachment.
- "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.
- "id": "A String", # YouTube API resource ID.
- "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.
- "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.
- },
- "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.
- "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.
- },
- "form": { # Google Forms item. # Google Forms attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image 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.
- "title": "A String", # Title of the Form.
- #
- # Read-only.
- },
- },
- ],
- "title": "A String", # Title for this set.
- },
- ],
- "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.
- "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.
- },
- "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.
- "courseState": "A String", # State of the course.
- # If unspecified, the default state is `PROVISIONED`.
- "id": "A String", # Identifier for this course assigned by Classroom.
+ "id": "A String", # Identifier for this course assigned by Classroom.
#
# When
# creating a course,
@@ -1438,14 +1306,146 @@
# 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.
- "room": "A String", # Optional room location.
- # For example, "301".
+ "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.
+ "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.
+ "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.
+ "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.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.
+ #
+ # Read-only.
+ "id": "A String", # Drive API resource ID.
+ },
+ "youTubeVideo": { # YouTube video item. # Youtube video attachment.
+ "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.
+ "id": "A String", # YouTube API resource ID.
+ "title": "A String", # Title of the YouTube video.
+ #
+ # Read-only.
+ },
+ "form": { # Google Forms item. # Google Forms attachment.
+ "title": "A String", # Title of the Form.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image 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.
+ "formUrl": "A String", # URL of the form.
+ },
+ "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.
+ },
+ },
+ ],
+ },
+ ],
+ "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.
+ "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.
+ "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.
+ "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.
+ "alternateLink": "A String", # Absolute link to this course in the Classroom web UI.
+ #
+ # Read-only.
+ "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course.
+ #
+ # Read-only.
+ "courseState": "A String", # State of the course.
+ # If unspecified, the default state is `PROVISIONED`.
+ "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.
+ "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.
+ "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.
+ "creationTime": "A String", # Creation time of the course.
+ # Specifying this field in a course update mask results in an error.
+ #
+ # 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.
+ "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.
+ },
}
x__xgafv: string, V1 error format.
@@ -1457,143 +1457,11 @@
An object of the form:
{ # A Course in Classroom.
- "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.
- "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.
- "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.
- "alternateLink": "A String", # Absolute link to this course in the Classroom web UI.
- #
- # 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.
- "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.
- "section": "A String", # Section of the course.
- # For example, "Period 2".
+ "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.
- "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course.
- #
- # Read-only.
- "creationTime": "A String", # Creation time of the course.
- # Specifying this field in a course update mask results in an error.
- #
- # 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.
- "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.
- "materials": [ # Materials attached to this set.
- { # A material attached to a course as part of a material set.
- "youTubeVideo": { # YouTube video item. # Youtube video attachment.
- "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.
- "id": "A String", # YouTube API resource ID.
- "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.
- "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.
- },
- "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.
- "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.
- },
- "form": { # Google Forms item. # Google Forms attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image 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.
- "title": "A String", # Title of the Form.
- #
- # Read-only.
- },
- },
- ],
- "title": "A String", # Title for this set.
- },
- ],
- "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.
- "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.
- },
- "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.
- "courseState": "A String", # State of the course.
- # If unspecified, the default state is `PROVISIONED`.
- "id": "A String", # Identifier for this course assigned by Classroom.
+ "id": "A String", # Identifier for this course assigned by Classroom.
#
# When
# creating a course,
@@ -1603,14 +1471,146 @@
# 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.
- "room": "A String", # Optional room location.
- # For example, "301".
+ "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.
+ "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.
+ "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.
+ "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.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.
+ #
+ # Read-only.
+ "id": "A String", # Drive API resource ID.
+ },
+ "youTubeVideo": { # YouTube video item. # Youtube video attachment.
+ "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.
+ "id": "A String", # YouTube API resource ID.
+ "title": "A String", # Title of the YouTube video.
+ #
+ # Read-only.
+ },
+ "form": { # Google Forms item. # Google Forms attachment.
+ "title": "A String", # Title of the Form.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image 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.
+ "formUrl": "A String", # URL of the form.
+ },
+ "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.
+ },
+ },
+ ],
+ },
+ ],
+ "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.
+ "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.
+ "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.
+ "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.
+ "alternateLink": "A String", # Absolute link to this course in the Classroom web UI.
+ #
+ # Read-only.
+ "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course.
+ #
+ # Read-only.
+ "courseState": "A String", # State of the course.
+ # If unspecified, the default state is `PROVISIONED`.
+ "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.
+ "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.
+ "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.
+ "creationTime": "A String", # Creation time of the course.
+ # Specifying this field in a course update mask results in an error.
+ #
+ # 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.
+ "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.
+ },
}</pre>
</div>