chore: update docs/dyn (#1106)
diff --git a/docs/dyn/classroom_v1.courses.html b/docs/dyn/classroom_v1.courses.html
index c5f9269..824246e 100644
--- a/docs/dyn/classroom_v1.courses.html
+++ b/docs/dyn/classroom_v1.courses.html
@@ -122,7 +122,7 @@
<code><a href="#get">get(id, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.</p>
<p class="toc_element">
- <code><a href="#list">list(teacherId=None, studentId=None, pageToken=None, courseStates=None, pageSize=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(pageSize=None, studentId=None, teacherId=None, pageToken=None, courseStates=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. Returned courses are ordered by creation time, with the most recently created coming first. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the query argument is malformed. * `NOT_FOUND` if any users specified in the query arguments do not exist.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -148,59 +148,59 @@
The object takes the form of:
{ # A Course in Classroom.
+ "updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
+ "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
+ "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.
+ "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.
+ "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
+ "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.
- "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
- "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
- "id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive item. Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
- },
"link": { # URL item. # Link atatchment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
- "title": "A String", # Title of the target of the URL. Read-only.
"url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
- },
- "form": { # Google Forms item. # Google Forms attachment.
- "title": "A String", # Title of the Form. Read-only.
- "formUrl": "A String", # URL of the form.
- "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
+ "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.
},
"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.
"id": "A String", # YouTube API resource ID.
"thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
- "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
- "title": "A String", # Title of the YouTube video. Read-only.
+ },
+ "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
+ "id": "A String", # Drive API resource ID.
+ "title": "A String", # Title of the Drive item. Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
+ },
+ "form": { # Google Forms item. # Google Forms attachment.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
+ "formUrl": "A String", # URL of the form.
+ "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.
},
},
],
+ "title": "A String", # Title for this set.
},
],
- "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
- "enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.
- "description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.
- "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters.
+ "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.
+ "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.
"teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only.
- "title": "A String", # Title of the Drive folder. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
"id": "A String", # Drive API resource ID.
+ "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.
},
- "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only.
- "ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Admins can also specify this field in a patch course request to transfer ownership. In other contexts, it is read-only.
"calendarId": "A String", # The Calendar ID for a calendar that all course members can see, to which Classroom adds events for course work and announcements in the course. Read-only.
"teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only.
- "room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters.
- "id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error.
- "updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
- "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
- "section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
- "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
"alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
- "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
+ "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.
+ "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. 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.
+ "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.
}
x__xgafv: string, V1 error format.
@@ -212,59 +212,59 @@
An object of the form:
{ # A Course in Classroom.
+ "updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
+ "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
+ "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.
+ "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.
+ "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
+ "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.
- "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
- "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
- "id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive item. Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
- },
"link": { # URL item. # Link atatchment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
- "title": "A String", # Title of the target of the URL. Read-only.
"url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
- },
- "form": { # Google Forms item. # Google Forms attachment.
- "title": "A String", # Title of the Form. Read-only.
- "formUrl": "A String", # URL of the form.
- "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
+ "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.
},
"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.
"id": "A String", # YouTube API resource ID.
"thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
- "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
- "title": "A String", # Title of the YouTube video. Read-only.
+ },
+ "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
+ "id": "A String", # Drive API resource ID.
+ "title": "A String", # Title of the Drive item. Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
+ },
+ "form": { # Google Forms item. # Google Forms attachment.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
+ "formUrl": "A String", # URL of the form.
+ "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.
},
},
],
+ "title": "A String", # Title for this set.
},
],
- "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
- "enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.
- "description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.
- "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters.
+ "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.
+ "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.
"teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only.
- "title": "A String", # Title of the Drive folder. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
"id": "A String", # Drive API resource ID.
+ "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.
},
- "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only.
- "ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Admins can also specify this field in a patch course request to transfer ownership. In other contexts, it is read-only.
"calendarId": "A String", # The Calendar ID for a calendar that all course members can see, to which Classroom adds events for course work and announcements in the course. Read-only.
"teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only.
- "room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters.
- "id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error.
- "updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
- "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
- "section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
- "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
"alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
- "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
+ "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.
+ "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. 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.
+ "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.
}</pre>
</div>
@@ -301,69 +301,70 @@
An object of the form:
{ # A Course in Classroom.
+ "updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
+ "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
+ "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.
+ "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.
+ "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
+ "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.
- "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
- "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
- "id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive item. Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
- },
"link": { # URL item. # Link atatchment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
- "title": "A String", # Title of the target of the URL. Read-only.
"url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
- },
- "form": { # Google Forms item. # Google Forms attachment.
- "title": "A String", # Title of the Form. Read-only.
- "formUrl": "A String", # URL of the form.
- "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
+ "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.
},
"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.
"id": "A String", # YouTube API resource ID.
"thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
- "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
- "title": "A String", # Title of the YouTube video. Read-only.
+ },
+ "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
+ "id": "A String", # Drive API resource ID.
+ "title": "A String", # Title of the Drive item. Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
+ },
+ "form": { # Google Forms item. # Google Forms attachment.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
+ "formUrl": "A String", # URL of the form.
+ "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.
},
},
],
+ "title": "A String", # Title for this set.
},
],
- "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
- "enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.
- "description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.
- "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters.
+ "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.
+ "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.
"teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only.
- "title": "A String", # Title of the Drive folder. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
"id": "A String", # Drive API resource ID.
+ "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.
},
- "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only.
- "ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Admins can also specify this field in a patch course request to transfer ownership. In other contexts, it is read-only.
"calendarId": "A String", # The Calendar ID for a calendar that all course members can see, to which Classroom adds events for course work and announcements in the course. Read-only.
"teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only.
- "room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters.
- "id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error.
- "updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
- "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
- "section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
- "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
"alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
- "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
+ "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.
+ "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. 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.
+ "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.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(teacherId=None, studentId=None, pageToken=None, courseStates=None, pageSize=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(pageSize=None, studentId=None, teacherId=None, pageToken=None, courseStates=None, x__xgafv=None)</code>
<pre>Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. Returned courses are ordered by creation time, with the most recently created coming first. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the query argument is malformed. * `NOT_FOUND` if any users specified in the query arguments do not exist.
Args:
- teacherId: string, Restricts returned courses to those having a teacher with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
+ pageSize: integer, Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
studentId: string, Restricts returned courses to those having a student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
+ teacherId: string, Restricts returned courses to those having a teacher with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
pageToken: string, nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
courseStates: string, Restricts returned courses to those in one of the specified states The default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED. (repeated)
Allowed values
@@ -373,7 +374,6 @@
PROVISIONED - The course has been created, but not yet activated. It is accessible by the primary teacher and domain administrators, who may modify it or change it to the `ACTIVE` or `DECLINED` states. A course may only be changed to `PROVISIONED` if it is in the `DECLINED` state.
DECLINED - The course has been created, but declined. It is accessible by the course owner and domain administrators, though it will not be displayed in the web UI. You cannot modify the course except to change it to the `PROVISIONED` state. A course may only be changed to `DECLINED` if it is in the `PROVISIONED` state.
SUSPENDED - The course has been suspended. You cannot modify the course, and only the user identified by the `owner_id` can view the course. A course may be placed in this state if it potentially violates the Terms of Service.
- pageSize: integer, Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -385,59 +385,59 @@
{ # Response when listing courses.
"courses": [ # Courses that match the list request.
{ # A Course in Classroom.
+ "updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
+ "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
+ "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.
+ "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.
+ "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
+ "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.
- "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
- "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
- "id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive item. Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
- },
"link": { # URL item. # Link atatchment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
- "title": "A String", # Title of the target of the URL. Read-only.
"url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
- },
- "form": { # Google Forms item. # Google Forms attachment.
- "title": "A String", # Title of the Form. Read-only.
- "formUrl": "A String", # URL of the form.
- "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
+ "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.
},
"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.
"id": "A String", # YouTube API resource ID.
"thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
- "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
- "title": "A String", # Title of the YouTube video. Read-only.
+ },
+ "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
+ "id": "A String", # Drive API resource ID.
+ "title": "A String", # Title of the Drive item. Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
+ },
+ "form": { # Google Forms item. # Google Forms attachment.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
+ "formUrl": "A String", # URL of the form.
+ "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.
},
},
],
+ "title": "A String", # Title for this set.
},
],
- "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
- "enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.
- "description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.
- "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters.
+ "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.
+ "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.
"teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only.
- "title": "A String", # Title of the Drive folder. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
"id": "A String", # Drive API resource ID.
+ "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.
},
- "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only.
- "ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Admins can also specify this field in a patch course request to transfer ownership. In other contexts, it is read-only.
"calendarId": "A String", # The Calendar ID for a calendar that all course members can see, to which Classroom adds events for course work and announcements in the course. Read-only.
"teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only.
- "room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters.
- "id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error.
- "updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
- "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
- "section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
- "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
"alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
- "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
+ "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.
+ "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. 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.
+ "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.
},
],
"nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available.
@@ -468,59 +468,59 @@
The object takes the form of:
{ # A Course in Classroom.
+ "updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
+ "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
+ "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.
+ "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.
+ "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
+ "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.
- "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
- "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
- "id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive item. Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
- },
"link": { # URL item. # Link atatchment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
- "title": "A String", # Title of the target of the URL. Read-only.
"url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
- },
- "form": { # Google Forms item. # Google Forms attachment.
- "title": "A String", # Title of the Form. Read-only.
- "formUrl": "A String", # URL of the form.
- "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
+ "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.
},
"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.
"id": "A String", # YouTube API resource ID.
"thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
- "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
- "title": "A String", # Title of the YouTube video. Read-only.
+ },
+ "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
+ "id": "A String", # Drive API resource ID.
+ "title": "A String", # Title of the Drive item. Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
+ },
+ "form": { # Google Forms item. # Google Forms attachment.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
+ "formUrl": "A String", # URL of the form.
+ "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.
},
},
],
+ "title": "A String", # Title for this set.
},
],
- "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
- "enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.
- "description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.
- "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters.
+ "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.
+ "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.
"teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only.
- "title": "A String", # Title of the Drive folder. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
"id": "A String", # Drive API resource ID.
+ "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.
},
- "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only.
- "ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Admins can also specify this field in a patch course request to transfer ownership. In other contexts, it is read-only.
"calendarId": "A String", # The Calendar ID for a calendar that all course members can see, to which Classroom adds events for course work and announcements in the course. Read-only.
"teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only.
- "room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters.
- "id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error.
- "updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
- "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
- "section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
- "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
"alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
- "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
+ "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.
+ "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. 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.
+ "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.
}
updateMask: string, Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: * `name` * `section` * `descriptionHeading` * `description` * `room` * `courseState` * `ownerId` Note: patches to ownerId are treated as being effective immediately, but in practice it may take some time for the ownership transfer of all affected resources to complete. When set in a query parameter, this field should be specified as `updateMask=,,...`
@@ -533,59 +533,59 @@
An object of the form:
{ # A Course in Classroom.
+ "updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
+ "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
+ "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.
+ "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.
+ "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
+ "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.
- "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
- "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
- "id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive item. Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
- },
"link": { # URL item. # Link atatchment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
- "title": "A String", # Title of the target of the URL. Read-only.
"url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
- },
- "form": { # Google Forms item. # Google Forms attachment.
- "title": "A String", # Title of the Form. Read-only.
- "formUrl": "A String", # URL of the form.
- "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
+ "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.
},
"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.
"id": "A String", # YouTube API resource ID.
"thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
- "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
- "title": "A String", # Title of the YouTube video. Read-only.
+ },
+ "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
+ "id": "A String", # Drive API resource ID.
+ "title": "A String", # Title of the Drive item. Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
+ },
+ "form": { # Google Forms item. # Google Forms attachment.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
+ "formUrl": "A String", # URL of the form.
+ "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.
},
},
],
+ "title": "A String", # Title for this set.
},
],
- "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
- "enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.
- "description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.
- "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters.
+ "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.
+ "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.
"teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only.
- "title": "A String", # Title of the Drive folder. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
"id": "A String", # Drive API resource ID.
+ "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.
},
- "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only.
- "ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Admins can also specify this field in a patch course request to transfer ownership. In other contexts, it is read-only.
"calendarId": "A String", # The Calendar ID for a calendar that all course members can see, to which Classroom adds events for course work and announcements in the course. Read-only.
"teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only.
- "room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters.
- "id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error.
- "updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
- "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
- "section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
- "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
"alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
- "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
+ "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.
+ "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. 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.
+ "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.
}</pre>
</div>
@@ -599,59 +599,59 @@
The object takes the form of:
{ # A Course in Classroom.
+ "updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
+ "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
+ "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.
+ "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.
+ "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
+ "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.
- "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
- "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
- "id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive item. Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
- },
"link": { # URL item. # Link atatchment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
- "title": "A String", # Title of the target of the URL. Read-only.
"url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
- },
- "form": { # Google Forms item. # Google Forms attachment.
- "title": "A String", # Title of the Form. Read-only.
- "formUrl": "A String", # URL of the form.
- "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
+ "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.
},
"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.
"id": "A String", # YouTube API resource ID.
"thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
- "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
- "title": "A String", # Title of the YouTube video. Read-only.
+ },
+ "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
+ "id": "A String", # Drive API resource ID.
+ "title": "A String", # Title of the Drive item. Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
+ },
+ "form": { # Google Forms item. # Google Forms attachment.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
+ "formUrl": "A String", # URL of the form.
+ "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.
},
},
],
+ "title": "A String", # Title for this set.
},
],
- "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
- "enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.
- "description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.
- "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters.
+ "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.
+ "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.
"teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only.
- "title": "A String", # Title of the Drive folder. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
"id": "A String", # Drive API resource ID.
+ "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.
},
- "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only.
- "ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Admins can also specify this field in a patch course request to transfer ownership. In other contexts, it is read-only.
"calendarId": "A String", # The Calendar ID for a calendar that all course members can see, to which Classroom adds events for course work and announcements in the course. Read-only.
"teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only.
- "room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters.
- "id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error.
- "updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
- "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
- "section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
- "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
"alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
- "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
+ "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.
+ "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. 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.
+ "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.
}
x__xgafv: string, V1 error format.
@@ -663,59 +663,59 @@
An object of the form:
{ # A Course in Classroom.
+ "updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
+ "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
+ "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.
+ "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.
+ "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
+ "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.
- "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
- "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
- "id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive item. Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
- },
"link": { # URL item. # Link atatchment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
- "title": "A String", # Title of the target of the URL. Read-only.
"url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
- },
- "form": { # Google Forms item. # Google Forms attachment.
- "title": "A String", # Title of the Form. Read-only.
- "formUrl": "A String", # URL of the form.
- "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
+ "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.
},
"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.
"id": "A String", # YouTube API resource ID.
"thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
- "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
- "title": "A String", # Title of the YouTube video. Read-only.
+ },
+ "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
+ "id": "A String", # Drive API resource ID.
+ "title": "A String", # Title of the Drive item. Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
+ },
+ "form": { # Google Forms item. # Google Forms attachment.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
+ "formUrl": "A String", # URL of the form.
+ "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.
},
},
],
+ "title": "A String", # Title for this set.
},
],
- "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course. Read-only.
- "enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.
- "description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.
- "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters.
+ "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.
+ "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.
"teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only.
- "title": "A String", # Title of the Drive folder. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
"id": "A String", # Drive API resource ID.
+ "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.
},
- "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only.
- "ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Admins can also specify this field in a patch course request to transfer ownership. In other contexts, it is read-only.
"calendarId": "A String", # The Calendar ID for a calendar that all course members can see, to which Classroom adds events for course work and announcements in the course. Read-only.
"teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only.
- "room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters.
- "id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error.
- "updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
- "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
- "section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
- "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
"alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
- "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
+ "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.
+ "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. 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.
+ "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.
}</pre>
</div>