docs: update generated docs (#981)
diff --git a/docs/dyn/classroom_v1.courses.html b/docs/dyn/classroom_v1.courses.html
index 80ecfad..51a8674 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, pageToken=None, pageSize=None, teacherId=None, courseStates=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(studentId=None, pageToken=None, courseStates=None, pageSize=None, teacherId=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>
@@ -149,161 +149,161 @@
The object takes the form of:
{ # A Course in Classroom.
- "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.
- "id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive folder.
- #
+ "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.
- "alternateLink": "A String", # URL that can be used to access the Drive folder.
- #
+ "alternateLink": "A String", # Absolute link to this course in the Classroom web UI.
+ #
# Read-only.
- },
- "section": "A String", # Section of the course.
- # For example, "Period 2".
- # If set, this field must be a valid UTF-8 string and no longer than 2800
- # characters.
- "id": "A String", # Identifier for this course assigned by Classroom.
- #
- # When
- # creating a course,
- # you may optionally set this identifier to an
- # alias string in the
- # request to create a corresponding alias. The `id` is still assigned by
- # Classroom and cannot be updated after the course is created.
- #
- # Specifying this field in a course update mask results in an error.
- "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.
- "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.
- "title": "A String", # Title of the Drive item.
- #
- # Read-only.
- },
- "youTubeVideo": { # YouTube video item. # Youtube video attachment.
- "title": "A String", # Title of the YouTube video.
- #
- # Read-only.
- "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.
- },
- "form": { # Google Forms item. # Google Forms attachment.
- "formUrl": "A String", # URL of the form.
- "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.
- },
- "link": { # URL item. # Link atatchment.
- "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.
- "url": "A String", # URL to link to.
- # This must be a valid UTF-8 string containing between 1 and 2024 characters.
- },
- },
- ],
+ "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the
+ # course.
+ #
+ # This field will only be set for teachers of the course and domain
+ # administrators.
+ #
+ # Read-only.
+ "id": "A String", # Drive API resource ID.
+ "alternateLink": "A String", # URL that can be used to access the Drive folder.
+ #
+ # Read-only.
+ "title": "A String", # Title of the Drive folder.
+ #
+ # 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.
- "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.
- "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.
- "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.
-}
+ "id": "A String", # Identifier for this course assigned by Classroom.
+ #
+ # When
+ # creating a course,
+ # you may optionally set this identifier to an
+ # alias string in the
+ # request to create a corresponding alias. The `id` is still assigned by
+ # Classroom and cannot be updated after the course is created.
+ #
+ # Specifying this field in a course update mask results in an error.
+ "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.
+ "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.
+ "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course.
+ #
+ # 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.
+ "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.
+ },
+ "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.
+ },
+ "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.
+ },
+ "form": { # Google Forms item. # Google Forms attachment.
+ "title": "A String", # Title of the Form.
+ #
+ # Read-only.
+ "responseUrl": "A String", # URL of the form responses document.
+ # Only set if respsonses have been recorded and only when the
+ # requesting user is an editor of the form.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form.
+ #
+ # Read-only.
+ "formUrl": "A String", # URL of the form.
+ },
+ },
+ ],
+ },
+ ],
+ "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.
+ "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.
+ "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.
+ "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.
+ "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course.
+ # This group does not accept email and can only be used for permissions.
+ #
+ # Read-only.
+ "room": "A String", # Optional room location.
+ # For example, "301".
+ # If set, this field must be a valid UTF-8 string and no longer than 650
+ # characters.
+ "courseState": "A String", # State of the course.
+ # If unspecified, the default state is `PROVISIONED`.
+ "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.
+ "creationTime": "A String", # Creation time of the course.
+ # Specifying this field in a course update mask results in an error.
+ #
+ # Read-only.
+ }
x__xgafv: string, V1 error format.
Allowed values
@@ -314,161 +314,161 @@
An object of the form:
{ # A Course in Classroom.
- "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.
- "id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive folder.
+ "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.
- "alternateLink": "A String", # URL that can be used to access the Drive folder.
+ "alternateLink": "A String", # Absolute link to this course in the Classroom web UI.
#
# Read-only.
- },
- "section": "A String", # Section of the course.
- # For example, "Period 2".
- # If set, this field must be a valid UTF-8 string and no longer than 2800
- # characters.
- "id": "A String", # Identifier for this course assigned by Classroom.
- #
- # When
- # creating a course,
- # you may optionally set this identifier to an
- # alias string in the
- # request to create a corresponding alias. The `id` is still assigned by
- # Classroom and cannot be updated after the course is created.
- #
- # Specifying this field in a course update mask results in an error.
- "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.
- "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.
- "title": "A String", # Title of the Drive item.
- #
- # Read-only.
- },
- "youTubeVideo": { # YouTube video item. # Youtube video attachment.
- "title": "A String", # Title of the YouTube video.
- #
- # Read-only.
- "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.
- },
- "form": { # Google Forms item. # Google Forms attachment.
- "formUrl": "A String", # URL of the form.
- "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.
- },
- "link": { # URL item. # Link atatchment.
- "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.
- "url": "A String", # URL to link to.
- # This must be a valid UTF-8 string containing between 1 and 2024 characters.
- },
- },
- ],
+ "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the
+ # course.
+ #
+ # This field will only be set for teachers of the course and domain
+ # administrators.
+ #
+ # Read-only.
+ "id": "A String", # Drive API resource ID.
+ "alternateLink": "A String", # URL that can be used to access the Drive folder.
+ #
+ # Read-only.
+ "title": "A String", # Title of the Drive folder.
+ #
+ # 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.
- "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.
- "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.
- "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.
- }</pre>
+ "id": "A String", # Identifier for this course assigned by Classroom.
+ #
+ # When
+ # creating a course,
+ # you may optionally set this identifier to an
+ # alias string in the
+ # request to create a corresponding alias. The `id` is still assigned by
+ # Classroom and cannot be updated after the course is created.
+ #
+ # Specifying this field in a course update mask results in an error.
+ "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.
+ "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.
+ "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course.
+ #
+ # 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.
+ "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.
+ },
+ "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.
+ },
+ "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.
+ },
+ "form": { # Google Forms item. # Google Forms attachment.
+ "title": "A String", # Title of the Form.
+ #
+ # Read-only.
+ "responseUrl": "A String", # URL of the form responses document.
+ # Only set if respsonses have been recorded and only when the
+ # requesting user is an editor of the form.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form.
+ #
+ # Read-only.
+ "formUrl": "A String", # URL of the form.
+ },
+ },
+ ],
+ },
+ ],
+ "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.
+ "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.
+ "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.
+ "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.
+ "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course.
+ # This group does not accept email and can only be used for permissions.
+ #
+ # Read-only.
+ "room": "A String", # Optional room location.
+ # For example, "301".
+ # If set, this field must be a valid UTF-8 string and no longer than 650
+ # characters.
+ "courseState": "A String", # State of the course.
+ # If unspecified, the default state is `PROVISIONED`.
+ "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.
+ "creationTime": "A String", # Creation time of the course.
+ # Specifying this field in a course update mask results in an error.
+ #
+ # Read-only.
+ }</pre>
</div>
<div class="method">
@@ -528,165 +528,165 @@
An object of the form:
{ # A Course in Classroom.
- "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.
- "id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive folder.
+ "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.
- "alternateLink": "A String", # URL that can be used to access the Drive folder.
+ "alternateLink": "A String", # Absolute link to this course in the Classroom web UI.
#
# Read-only.
- },
- "section": "A String", # Section of the course.
- # For example, "Period 2".
- # If set, this field must be a valid UTF-8 string and no longer than 2800
- # characters.
- "id": "A String", # Identifier for this course assigned by Classroom.
- #
- # When
- # creating a course,
- # you may optionally set this identifier to an
- # alias string in the
- # request to create a corresponding alias. The `id` is still assigned by
- # Classroom and cannot be updated after the course is created.
- #
- # Specifying this field in a course update mask results in an error.
- "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.
- "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.
- "title": "A String", # Title of the Drive item.
- #
- # Read-only.
- },
- "youTubeVideo": { # YouTube video item. # Youtube video attachment.
- "title": "A String", # Title of the YouTube video.
- #
- # Read-only.
- "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.
- },
- "form": { # Google Forms item. # Google Forms attachment.
- "formUrl": "A String", # URL of the form.
- "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.
- },
- "link": { # URL item. # Link atatchment.
- "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.
- "url": "A String", # URL to link to.
- # This must be a valid UTF-8 string containing between 1 and 2024 characters.
- },
- },
- ],
+ "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the
+ # course.
+ #
+ # This field will only be set for teachers of the course and domain
+ # administrators.
+ #
+ # Read-only.
+ "id": "A String", # Drive API resource ID.
+ "alternateLink": "A String", # URL that can be used to access the Drive folder.
+ #
+ # Read-only.
+ "title": "A String", # Title of the Drive folder.
+ #
+ # 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.
- "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.
- "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.
- "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.
- }</pre>
+ "id": "A String", # Identifier for this course assigned by Classroom.
+ #
+ # When
+ # creating a course,
+ # you may optionally set this identifier to an
+ # alias string in the
+ # request to create a corresponding alias. The `id` is still assigned by
+ # Classroom and cannot be updated after the course is created.
+ #
+ # Specifying this field in a course update mask results in an error.
+ "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.
+ "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.
+ "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course.
+ #
+ # 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.
+ "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.
+ },
+ "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.
+ },
+ "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.
+ },
+ "form": { # Google Forms item. # Google Forms attachment.
+ "title": "A String", # Title of the Form.
+ #
+ # Read-only.
+ "responseUrl": "A String", # URL of the form responses document.
+ # Only set if respsonses have been recorded and only when the
+ # requesting user is an editor of the form.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form.
+ #
+ # Read-only.
+ "formUrl": "A String", # URL of the form.
+ },
+ },
+ ],
+ },
+ ],
+ "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.
+ "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.
+ "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.
+ "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.
+ "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course.
+ # This group does not accept email and can only be used for permissions.
+ #
+ # Read-only.
+ "room": "A String", # Optional room location.
+ # For example, "301".
+ # If set, this field must be a valid UTF-8 string and no longer than 650
+ # characters.
+ "courseState": "A String", # State of the course.
+ # If unspecified, the default state is `PROVISIONED`.
+ "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.
+ "creationTime": "A String", # Creation time of the course.
+ # Specifying this field in a course update mask results in an error.
+ #
+ # Read-only.
+ }</pre>
</div>
<div class="method">
- <code class="details" id="list">list(studentId=None, pageToken=None, pageSize=None, teacherId=None, courseStates=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(studentId=None, pageToken=None, courseStates=None, pageSize=None, teacherId=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.
@@ -711,6 +711,8 @@
The list request must be
otherwise identical to the one that resulted in this token.
+ courseStates: string, Restricts returned courses to those in one of the specified states
+The default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED. (repeated)
pageSize: integer, Maximum number of items to return. Zero or unspecified indicates that the
server may assign a maximum.
@@ -721,8 +723,6 @@
* 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,166 +732,166 @@
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.
{ # A Course in Classroom.
- "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.
- "id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive folder.
+ "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.
- "alternateLink": "A String", # URL that can be used to access the Drive folder.
+ "alternateLink": "A String", # Absolute link to this course in the Classroom web UI.
+ #
+ # 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.
+ "id": "A String", # Drive API resource ID.
+ "alternateLink": "A String", # URL that can be used to access the Drive folder.
+ #
+ # Read-only.
+ "title": "A String", # Title of the Drive folder.
+ #
+ # Read-only.
+ },
+ "id": "A String", # Identifier for this course assigned by Classroom.
+ #
+ # When
+ # creating a course,
+ # you may optionally set this identifier to an
+ # alias string in the
+ # request to create a corresponding alias. The `id` is still assigned by
+ # Classroom and cannot be updated after the course is created.
+ #
+ # Specifying this field in a course update mask results in an error.
+ "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.
+ "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.
+ "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course.
+ #
+ # 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.
+ "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.
+ },
+ "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.
+ },
+ "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.
+ },
+ "form": { # Google Forms item. # Google Forms attachment.
+ "title": "A String", # Title of the Form.
+ #
+ # Read-only.
+ "responseUrl": "A String", # URL of the form responses document.
+ # Only set if respsonses have been recorded and only when the
+ # requesting user is an editor of the form.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form.
+ #
+ # Read-only.
+ "formUrl": "A String", # URL of the form.
+ },
+ },
+ ],
+ },
+ ],
+ "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.
+ "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.
+ "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.
+ "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.
+ "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course.
+ # This group does not accept email and can only be used for permissions.
+ #
+ # Read-only.
+ "room": "A String", # Optional room location.
+ # For example, "301".
+ # If set, this field must be a valid UTF-8 string and no longer than 650
+ # characters.
+ "courseState": "A String", # State of the course.
+ # If unspecified, the default state is `PROVISIONED`.
+ "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.
+ "creationTime": "A String", # Creation time of the course.
+ # Specifying this field in a course update mask results in an error.
#
# Read-only.
},
- "section": "A String", # Section of the course.
- # For example, "Period 2".
- # If set, this field must be a valid UTF-8 string and no longer than 2800
- # characters.
- "id": "A String", # Identifier for this course assigned by Classroom.
- #
- # When
- # creating a course,
- # you may optionally set this identifier to an
- # alias string in the
- # request to create a corresponding alias. The `id` is still assigned by
- # Classroom and cannot be updated after the course is created.
- #
- # Specifying this field in a course update mask results in an error.
- "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.
- "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.
- "title": "A String", # Title of the Drive item.
- #
- # Read-only.
- },
- "youTubeVideo": { # YouTube video item. # Youtube video attachment.
- "title": "A String", # Title of the YouTube video.
- #
- # Read-only.
- "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.
- },
- "form": { # Google Forms item. # Google Forms attachment.
- "formUrl": "A String", # URL of the form.
- "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.
- },
- "link": { # URL item. # Link atatchment.
- "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.
- "url": "A String", # URL to link to.
- # This must be a valid UTF-8 string containing between 1 and 2024 characters.
- },
- },
- ],
- },
- ],
- "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.
- "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.
- "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.
- "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.
- },
],
- "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further
- # results are available.
}</pre>
</div>
@@ -931,161 +931,161 @@
The object takes the form of:
{ # A Course in Classroom.
- "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.
- "id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive folder.
- #
+ "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.
- "alternateLink": "A String", # URL that can be used to access the Drive folder.
- #
+ "alternateLink": "A String", # Absolute link to this course in the Classroom web UI.
+ #
# Read-only.
- },
- "section": "A String", # Section of the course.
- # For example, "Period 2".
- # If set, this field must be a valid UTF-8 string and no longer than 2800
- # characters.
- "id": "A String", # Identifier for this course assigned by Classroom.
- #
- # When
- # creating a course,
- # you may optionally set this identifier to an
- # alias string in the
- # request to create a corresponding alias. The `id` is still assigned by
- # Classroom and cannot be updated after the course is created.
- #
- # Specifying this field in a course update mask results in an error.
- "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.
- "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.
- "title": "A String", # Title of the Drive item.
- #
- # Read-only.
- },
- "youTubeVideo": { # YouTube video item. # Youtube video attachment.
- "title": "A String", # Title of the YouTube video.
- #
- # Read-only.
- "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.
- },
- "form": { # Google Forms item. # Google Forms attachment.
- "formUrl": "A String", # URL of the form.
- "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.
- },
- "link": { # URL item. # Link atatchment.
- "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.
- "url": "A String", # URL to link to.
- # This must be a valid UTF-8 string containing between 1 and 2024 characters.
- },
- },
- ],
+ "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the
+ # course.
+ #
+ # This field will only be set for teachers of the course and domain
+ # administrators.
+ #
+ # Read-only.
+ "id": "A String", # Drive API resource ID.
+ "alternateLink": "A String", # URL that can be used to access the Drive folder.
+ #
+ # Read-only.
+ "title": "A String", # Title of the Drive folder.
+ #
+ # 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.
- "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.
- "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.
- "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.
-}
+ "id": "A String", # Identifier for this course assigned by Classroom.
+ #
+ # When
+ # creating a course,
+ # you may optionally set this identifier to an
+ # alias string in the
+ # request to create a corresponding alias. The `id` is still assigned by
+ # Classroom and cannot be updated after the course is created.
+ #
+ # Specifying this field in a course update mask results in an error.
+ "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.
+ "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.
+ "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course.
+ #
+ # 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.
+ "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.
+ },
+ "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.
+ },
+ "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.
+ },
+ "form": { # Google Forms item. # Google Forms attachment.
+ "title": "A String", # Title of the Form.
+ #
+ # Read-only.
+ "responseUrl": "A String", # URL of the form responses document.
+ # Only set if respsonses have been recorded and only when the
+ # requesting user is an editor of the form.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form.
+ #
+ # Read-only.
+ "formUrl": "A String", # URL of the form.
+ },
+ },
+ ],
+ },
+ ],
+ "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.
+ "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.
+ "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.
+ "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.
+ "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course.
+ # This group does not accept email and can only be used for permissions.
+ #
+ # Read-only.
+ "room": "A String", # Optional room location.
+ # For example, "301".
+ # If set, this field must be a valid UTF-8 string and no longer than 650
+ # characters.
+ "courseState": "A String", # State of the course.
+ # If unspecified, the default state is `PROVISIONED`.
+ "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.
+ "creationTime": "A String", # Creation time of the course.
+ # Specifying this field in a course update mask results in an error.
+ #
+ # Read-only.
+ }
updateMask: string, Mask that identifies which fields on the course to update.
This field is required to do an update. The update will fail if invalid
@@ -1115,161 +1115,161 @@
An object of the form:
{ # A Course in Classroom.
- "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.
- "id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive folder.
+ "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.
- "alternateLink": "A String", # URL that can be used to access the Drive folder.
+ "alternateLink": "A String", # Absolute link to this course in the Classroom web UI.
#
# Read-only.
- },
- "section": "A String", # Section of the course.
- # For example, "Period 2".
- # If set, this field must be a valid UTF-8 string and no longer than 2800
- # characters.
- "id": "A String", # Identifier for this course assigned by Classroom.
- #
- # When
- # creating a course,
- # you may optionally set this identifier to an
- # alias string in the
- # request to create a corresponding alias. The `id` is still assigned by
- # Classroom and cannot be updated after the course is created.
- #
- # Specifying this field in a course update mask results in an error.
- "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.
- "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.
- "title": "A String", # Title of the Drive item.
- #
- # Read-only.
- },
- "youTubeVideo": { # YouTube video item. # Youtube video attachment.
- "title": "A String", # Title of the YouTube video.
- #
- # Read-only.
- "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.
- },
- "form": { # Google Forms item. # Google Forms attachment.
- "formUrl": "A String", # URL of the form.
- "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.
- },
- "link": { # URL item. # Link atatchment.
- "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.
- "url": "A String", # URL to link to.
- # This must be a valid UTF-8 string containing between 1 and 2024 characters.
- },
- },
- ],
+ "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the
+ # course.
+ #
+ # This field will only be set for teachers of the course and domain
+ # administrators.
+ #
+ # Read-only.
+ "id": "A String", # Drive API resource ID.
+ "alternateLink": "A String", # URL that can be used to access the Drive folder.
+ #
+ # Read-only.
+ "title": "A String", # Title of the Drive folder.
+ #
+ # 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.
- "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.
- "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.
- "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.
- }</pre>
+ "id": "A String", # Identifier for this course assigned by Classroom.
+ #
+ # When
+ # creating a course,
+ # you may optionally set this identifier to an
+ # alias string in the
+ # request to create a corresponding alias. The `id` is still assigned by
+ # Classroom and cannot be updated after the course is created.
+ #
+ # Specifying this field in a course update mask results in an error.
+ "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.
+ "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.
+ "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course.
+ #
+ # 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.
+ "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.
+ },
+ "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.
+ },
+ "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.
+ },
+ "form": { # Google Forms item. # Google Forms attachment.
+ "title": "A String", # Title of the Form.
+ #
+ # Read-only.
+ "responseUrl": "A String", # URL of the form responses document.
+ # Only set if respsonses have been recorded and only when the
+ # requesting user is an editor of the form.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form.
+ #
+ # Read-only.
+ "formUrl": "A String", # URL of the form.
+ },
+ },
+ ],
+ },
+ ],
+ "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.
+ "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.
+ "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.
+ "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.
+ "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course.
+ # This group does not accept email and can only be used for permissions.
+ #
+ # Read-only.
+ "room": "A String", # Optional room location.
+ # For example, "301".
+ # If set, this field must be a valid UTF-8 string and no longer than 650
+ # characters.
+ "courseState": "A String", # State of the course.
+ # If unspecified, the default state is `PROVISIONED`.
+ "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.
+ "creationTime": "A String", # Creation time of the course.
+ # Specifying this field in a course update mask results in an error.
+ #
+ # Read-only.
+ }</pre>
</div>
<div class="method">
@@ -1292,161 +1292,161 @@
The object takes the form of:
{ # A Course in Classroom.
- "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.
- "id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive folder.
- #
+ "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.
- "alternateLink": "A String", # URL that can be used to access the Drive folder.
- #
+ "alternateLink": "A String", # Absolute link to this course in the Classroom web UI.
+ #
# Read-only.
- },
- "section": "A String", # Section of the course.
- # For example, "Period 2".
- # If set, this field must be a valid UTF-8 string and no longer than 2800
- # characters.
- "id": "A String", # Identifier for this course assigned by Classroom.
- #
- # When
- # creating a course,
- # you may optionally set this identifier to an
- # alias string in the
- # request to create a corresponding alias. The `id` is still assigned by
- # Classroom and cannot be updated after the course is created.
- #
- # Specifying this field in a course update mask results in an error.
- "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.
- "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.
- "title": "A String", # Title of the Drive item.
- #
- # Read-only.
- },
- "youTubeVideo": { # YouTube video item. # Youtube video attachment.
- "title": "A String", # Title of the YouTube video.
- #
- # Read-only.
- "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.
- },
- "form": { # Google Forms item. # Google Forms attachment.
- "formUrl": "A String", # URL of the form.
- "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.
- },
- "link": { # URL item. # Link atatchment.
- "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.
- "url": "A String", # URL to link to.
- # This must be a valid UTF-8 string containing between 1 and 2024 characters.
- },
- },
- ],
+ "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the
+ # course.
+ #
+ # This field will only be set for teachers of the course and domain
+ # administrators.
+ #
+ # Read-only.
+ "id": "A String", # Drive API resource ID.
+ "alternateLink": "A String", # URL that can be used to access the Drive folder.
+ #
+ # Read-only.
+ "title": "A String", # Title of the Drive folder.
+ #
+ # 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.
- "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.
- "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.
- "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.
-}
+ "id": "A String", # Identifier for this course assigned by Classroom.
+ #
+ # When
+ # creating a course,
+ # you may optionally set this identifier to an
+ # alias string in the
+ # request to create a corresponding alias. The `id` is still assigned by
+ # Classroom and cannot be updated after the course is created.
+ #
+ # Specifying this field in a course update mask results in an error.
+ "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.
+ "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.
+ "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course.
+ #
+ # 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.
+ "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.
+ },
+ "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.
+ },
+ "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.
+ },
+ "form": { # Google Forms item. # Google Forms attachment.
+ "title": "A String", # Title of the Form.
+ #
+ # Read-only.
+ "responseUrl": "A String", # URL of the form responses document.
+ # Only set if respsonses have been recorded and only when the
+ # requesting user is an editor of the form.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form.
+ #
+ # Read-only.
+ "formUrl": "A String", # URL of the form.
+ },
+ },
+ ],
+ },
+ ],
+ "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.
+ "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.
+ "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.
+ "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.
+ "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course.
+ # This group does not accept email and can only be used for permissions.
+ #
+ # Read-only.
+ "room": "A String", # Optional room location.
+ # For example, "301".
+ # If set, this field must be a valid UTF-8 string and no longer than 650
+ # characters.
+ "courseState": "A String", # State of the course.
+ # If unspecified, the default state is `PROVISIONED`.
+ "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.
+ "creationTime": "A String", # Creation time of the course.
+ # Specifying this field in a course update mask results in an error.
+ #
+ # Read-only.
+ }
x__xgafv: string, V1 error format.
Allowed values
@@ -1457,161 +1457,161 @@
An object of the form:
{ # A Course in Classroom.
- "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.
- "id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive folder.
+ "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.
- "alternateLink": "A String", # URL that can be used to access the Drive folder.
+ "alternateLink": "A String", # Absolute link to this course in the Classroom web UI.
#
# Read-only.
- },
- "section": "A String", # Section of the course.
- # For example, "Period 2".
- # If set, this field must be a valid UTF-8 string and no longer than 2800
- # characters.
- "id": "A String", # Identifier for this course assigned by Classroom.
- #
- # When
- # creating a course,
- # you may optionally set this identifier to an
- # alias string in the
- # request to create a corresponding alias. The `id` is still assigned by
- # Classroom and cannot be updated after the course is created.
- #
- # Specifying this field in a course update mask results in an error.
- "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.
- "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.
- "title": "A String", # Title of the Drive item.
- #
- # Read-only.
- },
- "youTubeVideo": { # YouTube video item. # Youtube video attachment.
- "title": "A String", # Title of the YouTube video.
- #
- # Read-only.
- "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.
- },
- "form": { # Google Forms item. # Google Forms attachment.
- "formUrl": "A String", # URL of the form.
- "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.
- },
- "link": { # URL item. # Link atatchment.
- "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.
- "url": "A String", # URL to link to.
- # This must be a valid UTF-8 string containing between 1 and 2024 characters.
- },
- },
- ],
+ "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the
+ # course.
+ #
+ # This field will only be set for teachers of the course and domain
+ # administrators.
+ #
+ # Read-only.
+ "id": "A String", # Drive API resource ID.
+ "alternateLink": "A String", # URL that can be used to access the Drive folder.
+ #
+ # Read-only.
+ "title": "A String", # Title of the Drive folder.
+ #
+ # 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.
- "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.
- "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.
- "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.
- }</pre>
+ "id": "A String", # Identifier for this course assigned by Classroom.
+ #
+ # When
+ # creating a course,
+ # you may optionally set this identifier to an
+ # alias string in the
+ # request to create a corresponding alias. The `id` is still assigned by
+ # Classroom and cannot be updated after the course is created.
+ #
+ # Specifying this field in a course update mask results in an error.
+ "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.
+ "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.
+ "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course.
+ #
+ # 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.
+ "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.
+ },
+ "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.
+ },
+ "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.
+ },
+ "form": { # Google Forms item. # Google Forms attachment.
+ "title": "A String", # Title of the Form.
+ #
+ # Read-only.
+ "responseUrl": "A String", # URL of the form responses document.
+ # Only set if respsonses have been recorded and only when the
+ # requesting user is an editor of the form.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form.
+ #
+ # Read-only.
+ "formUrl": "A String", # URL of the form.
+ },
+ },
+ ],
+ },
+ ],
+ "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.
+ "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.
+ "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.
+ "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.
+ "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course.
+ # This group does not accept email and can only be used for permissions.
+ #
+ # Read-only.
+ "room": "A String", # Optional room location.
+ # For example, "301".
+ # If set, this field must be a valid UTF-8 string and no longer than 650
+ # characters.
+ "courseState": "A String", # State of the course.
+ # If unspecified, the default state is `PROVISIONED`.
+ "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.
+ "creationTime": "A String", # Creation time of the course.
+ # Specifying this field in a course update mask results in an error.
+ #
+ # Read-only.
+ }</pre>
</div>
</body></html>
\ No newline at end of file