chore: update docs/dyn (#1106)
diff --git a/docs/dyn/classroom_v1.courses.announcements.html b/docs/dyn/classroom_v1.courses.announcements.html
index e1d90d2..71e63b3 100644
--- a/docs/dyn/classroom_v1.courses.announcements.html
+++ b/docs/dyn/classroom_v1.courses.announcements.html
@@ -87,7 +87,7 @@
<code><a href="#get">get(courseId, id, x__xgafv=None)</a></code></p>
<p class="firstline">Returns an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or announcement, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or announcement does not exist.</p>
<p class="toc_element">
- <code><a href="#list">list(courseId, pageToken=None, pageSize=None, announcementStates=None, orderBy=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(courseId, pageSize=None, pageToken=None, announcementStates=None, orderBy=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a list of announcements that the requester is permitted to view. Course students may only view `PUBLISHED` announcements. Course teachers and domain administrators may view all announcements. 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. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -114,51 +114,51 @@
The object takes the form of:
{ # Announcement created by a teacher for students of the course
- "assigneeMode": "A String", # Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.
- "creationTime": "A String", # Timestamp when this announcement was created. Read-only.
- "text": "A String", # Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters.
- "alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
"state": "A String", # Status of this announcement. If unspecified, the default state is `DRAFT`.
- "courseId": "A String", # Identifier of the course. Read-only.
- "updateTime": "A String", # Timestamp of the most recent change to this announcement. Read-only.
+ "id": "A String", # Classroom-assigned identifier of this announcement, unique per course. Read-only.
+ "materials": [ # Additional materials. Announcements must have no more than 20 material items.
+ { # Material attached to course work. When creating attachments, setting the `form` field is not supported.
+ "link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response.
+ "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
+ "title": "A String", # Title of the target of the URL. Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
+ },
+ "driveFile": { # Drive file that is used as material for course work. # Google Drive file material.
+ "shareMode": "A String", # Mechanism by which students access the Drive item.
+ "driveFile": { # Representation of a Google Drive file. # Drive file details.
+ "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 material.
+ "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.
+ },
+ "youtubeVideo": { # YouTube video item. # YouTube video material.
+ "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.
+ },
+ },
+ ],
+ "text": "A String", # Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters.
"scheduledTime": "A String", # Optional timestamp when this announcement is scheduled to be published.
+ "updateTime": "A String", # Timestamp of the most recent change to this announcement. Read-only.
"individualStudentsOptions": { # Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. # Identifiers of students with access to the announcement. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field can see the announcement.
"studentIds": [ # Identifiers for the students that have access to the coursework/announcement.
"A String",
],
},
+ "assigneeMode": "A String", # Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.
"creatorUserId": "A String", # Identifier for the user that created the announcement. Read-only.
- "id": "A String", # Classroom-assigned identifier of this announcement, unique per course. Read-only.
- "materials": [ # Additional materials. Announcements must have no more than 20 material items.
- { # Material attached to course work. When creating attachments, setting the `form` field is not supported.
- "youtubeVideo": { # YouTube video item. # YouTube video material.
- "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.
- },
- "link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response.
- "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.
- },
- "driveFile": { # Drive file that is used as material for course work. # Google Drive file material.
- "driveFile": { # Representation of a Google Drive file. # Drive file details.
- "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.
- },
- "shareMode": "A String", # Mechanism by which students access the Drive item.
- },
- "form": { # Google Forms item. # Google Forms material.
- "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.
- },
- },
- ],
+ "courseId": "A String", # Identifier of the course. Read-only.
+ "alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
+ "creationTime": "A String", # Timestamp when this announcement was created. Read-only.
}
x__xgafv: string, V1 error format.
@@ -170,51 +170,51 @@
An object of the form:
{ # Announcement created by a teacher for students of the course
- "assigneeMode": "A String", # Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.
- "creationTime": "A String", # Timestamp when this announcement was created. Read-only.
- "text": "A String", # Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters.
- "alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
"state": "A String", # Status of this announcement. If unspecified, the default state is `DRAFT`.
- "courseId": "A String", # Identifier of the course. Read-only.
- "updateTime": "A String", # Timestamp of the most recent change to this announcement. Read-only.
+ "id": "A String", # Classroom-assigned identifier of this announcement, unique per course. Read-only.
+ "materials": [ # Additional materials. Announcements must have no more than 20 material items.
+ { # Material attached to course work. When creating attachments, setting the `form` field is not supported.
+ "link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response.
+ "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
+ "title": "A String", # Title of the target of the URL. Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
+ },
+ "driveFile": { # Drive file that is used as material for course work. # Google Drive file material.
+ "shareMode": "A String", # Mechanism by which students access the Drive item.
+ "driveFile": { # Representation of a Google Drive file. # Drive file details.
+ "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 material.
+ "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.
+ },
+ "youtubeVideo": { # YouTube video item. # YouTube video material.
+ "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.
+ },
+ },
+ ],
+ "text": "A String", # Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters.
"scheduledTime": "A String", # Optional timestamp when this announcement is scheduled to be published.
+ "updateTime": "A String", # Timestamp of the most recent change to this announcement. Read-only.
"individualStudentsOptions": { # Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. # Identifiers of students with access to the announcement. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field can see the announcement.
"studentIds": [ # Identifiers for the students that have access to the coursework/announcement.
"A String",
],
},
+ "assigneeMode": "A String", # Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.
"creatorUserId": "A String", # Identifier for the user that created the announcement. Read-only.
- "id": "A String", # Classroom-assigned identifier of this announcement, unique per course. Read-only.
- "materials": [ # Additional materials. Announcements must have no more than 20 material items.
- { # Material attached to course work. When creating attachments, setting the `form` field is not supported.
- "youtubeVideo": { # YouTube video item. # YouTube video material.
- "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.
- },
- "link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response.
- "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.
- },
- "driveFile": { # Drive file that is used as material for course work. # Google Drive file material.
- "driveFile": { # Representation of a Google Drive file. # Drive file details.
- "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.
- },
- "shareMode": "A String", # Mechanism by which students access the Drive item.
- },
- "form": { # Google Forms item. # Google Forms material.
- "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.
- },
- },
- ],
+ "courseId": "A String", # Identifier of the course. Read-only.
+ "alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
+ "creationTime": "A String", # Timestamp when this announcement was created. Read-only.
}</pre>
</div>
@@ -253,62 +253,62 @@
An object of the form:
{ # Announcement created by a teacher for students of the course
- "assigneeMode": "A String", # Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.
- "creationTime": "A String", # Timestamp when this announcement was created. Read-only.
- "text": "A String", # Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters.
- "alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
"state": "A String", # Status of this announcement. If unspecified, the default state is `DRAFT`.
- "courseId": "A String", # Identifier of the course. Read-only.
- "updateTime": "A String", # Timestamp of the most recent change to this announcement. Read-only.
+ "id": "A String", # Classroom-assigned identifier of this announcement, unique per course. Read-only.
+ "materials": [ # Additional materials. Announcements must have no more than 20 material items.
+ { # Material attached to course work. When creating attachments, setting the `form` field is not supported.
+ "link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response.
+ "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
+ "title": "A String", # Title of the target of the URL. Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
+ },
+ "driveFile": { # Drive file that is used as material for course work. # Google Drive file material.
+ "shareMode": "A String", # Mechanism by which students access the Drive item.
+ "driveFile": { # Representation of a Google Drive file. # Drive file details.
+ "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 material.
+ "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.
+ },
+ "youtubeVideo": { # YouTube video item. # YouTube video material.
+ "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.
+ },
+ },
+ ],
+ "text": "A String", # Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters.
"scheduledTime": "A String", # Optional timestamp when this announcement is scheduled to be published.
+ "updateTime": "A String", # Timestamp of the most recent change to this announcement. Read-only.
"individualStudentsOptions": { # Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. # Identifiers of students with access to the announcement. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field can see the announcement.
"studentIds": [ # Identifiers for the students that have access to the coursework/announcement.
"A String",
],
},
+ "assigneeMode": "A String", # Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.
"creatorUserId": "A String", # Identifier for the user that created the announcement. Read-only.
- "id": "A String", # Classroom-assigned identifier of this announcement, unique per course. Read-only.
- "materials": [ # Additional materials. Announcements must have no more than 20 material items.
- { # Material attached to course work. When creating attachments, setting the `form` field is not supported.
- "youtubeVideo": { # YouTube video item. # YouTube video material.
- "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.
- },
- "link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response.
- "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.
- },
- "driveFile": { # Drive file that is used as material for course work. # Google Drive file material.
- "driveFile": { # Representation of a Google Drive file. # Drive file details.
- "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.
- },
- "shareMode": "A String", # Mechanism by which students access the Drive item.
- },
- "form": { # Google Forms item. # Google Forms material.
- "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.
- },
- },
- ],
+ "courseId": "A String", # Identifier of the course. Read-only.
+ "alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
+ "creationTime": "A String", # Timestamp when this announcement was created. Read-only.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(courseId, pageToken=None, pageSize=None, announcementStates=None, orderBy=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(courseId, pageSize=None, pageToken=None, announcementStates=None, orderBy=None, x__xgafv=None)</code>
<pre>Returns a list of announcements that the requester is permitted to view. Course students may only view `PUBLISHED` announcements. Course teachers and domain administrators may view all announcements. 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. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.
Args:
courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
- 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.
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.
+ 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.
announcementStates: string, Restriction on the `state` of announcements returned. If this argument is left unspecified, the default value is `PUBLISHED`. (repeated)
Allowed values
ANNOUNCEMENT_STATE_UNSPECIFIED - No state specified. This is never returned.
@@ -327,51 +327,51 @@
{ # Response when listing course work.
"announcements": [ # Announcement items that match the request.
{ # Announcement created by a teacher for students of the course
- "assigneeMode": "A String", # Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.
- "creationTime": "A String", # Timestamp when this announcement was created. Read-only.
- "text": "A String", # Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters.
- "alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
"state": "A String", # Status of this announcement. If unspecified, the default state is `DRAFT`.
- "courseId": "A String", # Identifier of the course. Read-only.
- "updateTime": "A String", # Timestamp of the most recent change to this announcement. Read-only.
+ "id": "A String", # Classroom-assigned identifier of this announcement, unique per course. Read-only.
+ "materials": [ # Additional materials. Announcements must have no more than 20 material items.
+ { # Material attached to course work. When creating attachments, setting the `form` field is not supported.
+ "link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response.
+ "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
+ "title": "A String", # Title of the target of the URL. Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
+ },
+ "driveFile": { # Drive file that is used as material for course work. # Google Drive file material.
+ "shareMode": "A String", # Mechanism by which students access the Drive item.
+ "driveFile": { # Representation of a Google Drive file. # Drive file details.
+ "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 material.
+ "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.
+ },
+ "youtubeVideo": { # YouTube video item. # YouTube video material.
+ "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.
+ },
+ },
+ ],
+ "text": "A String", # Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters.
"scheduledTime": "A String", # Optional timestamp when this announcement is scheduled to be published.
+ "updateTime": "A String", # Timestamp of the most recent change to this announcement. Read-only.
"individualStudentsOptions": { # Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. # Identifiers of students with access to the announcement. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field can see the announcement.
"studentIds": [ # Identifiers for the students that have access to the coursework/announcement.
"A String",
],
},
+ "assigneeMode": "A String", # Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.
"creatorUserId": "A String", # Identifier for the user that created the announcement. Read-only.
- "id": "A String", # Classroom-assigned identifier of this announcement, unique per course. Read-only.
- "materials": [ # Additional materials. Announcements must have no more than 20 material items.
- { # Material attached to course work. When creating attachments, setting the `form` field is not supported.
- "youtubeVideo": { # YouTube video item. # YouTube video material.
- "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.
- },
- "link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response.
- "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.
- },
- "driveFile": { # Drive file that is used as material for course work. # Google Drive file material.
- "driveFile": { # Representation of a Google Drive file. # Drive file details.
- "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.
- },
- "shareMode": "A String", # Mechanism by which students access the Drive item.
- },
- "form": { # Google Forms item. # Google Forms material.
- "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.
- },
- },
- ],
+ "courseId": "A String", # Identifier of the course. Read-only.
+ "alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
+ "creationTime": "A String", # Timestamp when this announcement was created. Read-only.
},
],
"nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available.
@@ -403,7 +403,6 @@
The object takes the form of:
{ # Request to modify assignee mode and options of an announcement.
- "assigneeMode": "A String", # Mode of the announcement describing whether it is accessible by all students or specified individual students.
"modifyIndividualStudentsOptions": { # Contains fields to add or remove students from a course work or announcement where the `assigneeMode` is set to `INDIVIDUAL_STUDENTS`. # Set which students can view or cannot view the announcement. Must be specified only when `assigneeMode` is `INDIVIDUAL_STUDENTS`.
"addStudentIds": [ # IDs of students to be added as having access to this coursework/announcement.
"A String",
@@ -412,6 +411,7 @@
"A String",
],
},
+ "assigneeMode": "A String", # Mode of the announcement describing whether it is accessible by all students or specified individual students.
}
x__xgafv: string, V1 error format.
@@ -423,51 +423,51 @@
An object of the form:
{ # Announcement created by a teacher for students of the course
- "assigneeMode": "A String", # Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.
- "creationTime": "A String", # Timestamp when this announcement was created. Read-only.
- "text": "A String", # Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters.
- "alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
"state": "A String", # Status of this announcement. If unspecified, the default state is `DRAFT`.
- "courseId": "A String", # Identifier of the course. Read-only.
- "updateTime": "A String", # Timestamp of the most recent change to this announcement. Read-only.
+ "id": "A String", # Classroom-assigned identifier of this announcement, unique per course. Read-only.
+ "materials": [ # Additional materials. Announcements must have no more than 20 material items.
+ { # Material attached to course work. When creating attachments, setting the `form` field is not supported.
+ "link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response.
+ "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
+ "title": "A String", # Title of the target of the URL. Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
+ },
+ "driveFile": { # Drive file that is used as material for course work. # Google Drive file material.
+ "shareMode": "A String", # Mechanism by which students access the Drive item.
+ "driveFile": { # Representation of a Google Drive file. # Drive file details.
+ "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 material.
+ "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.
+ },
+ "youtubeVideo": { # YouTube video item. # YouTube video material.
+ "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.
+ },
+ },
+ ],
+ "text": "A String", # Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters.
"scheduledTime": "A String", # Optional timestamp when this announcement is scheduled to be published.
+ "updateTime": "A String", # Timestamp of the most recent change to this announcement. Read-only.
"individualStudentsOptions": { # Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. # Identifiers of students with access to the announcement. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field can see the announcement.
"studentIds": [ # Identifiers for the students that have access to the coursework/announcement.
"A String",
],
},
+ "assigneeMode": "A String", # Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.
"creatorUserId": "A String", # Identifier for the user that created the announcement. Read-only.
- "id": "A String", # Classroom-assigned identifier of this announcement, unique per course. Read-only.
- "materials": [ # Additional materials. Announcements must have no more than 20 material items.
- { # Material attached to course work. When creating attachments, setting the `form` field is not supported.
- "youtubeVideo": { # YouTube video item. # YouTube video material.
- "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.
- },
- "link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response.
- "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.
- },
- "driveFile": { # Drive file that is used as material for course work. # Google Drive file material.
- "driveFile": { # Representation of a Google Drive file. # Drive file details.
- "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.
- },
- "shareMode": "A String", # Mechanism by which students access the Drive item.
- },
- "form": { # Google Forms item. # Google Forms material.
- "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.
- },
- },
- ],
+ "courseId": "A String", # Identifier of the course. Read-only.
+ "alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
+ "creationTime": "A String", # Timestamp when this announcement was created. Read-only.
}</pre>
</div>
@@ -482,51 +482,51 @@
The object takes the form of:
{ # Announcement created by a teacher for students of the course
- "assigneeMode": "A String", # Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.
- "creationTime": "A String", # Timestamp when this announcement was created. Read-only.
- "text": "A String", # Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters.
- "alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
"state": "A String", # Status of this announcement. If unspecified, the default state is `DRAFT`.
- "courseId": "A String", # Identifier of the course. Read-only.
- "updateTime": "A String", # Timestamp of the most recent change to this announcement. Read-only.
+ "id": "A String", # Classroom-assigned identifier of this announcement, unique per course. Read-only.
+ "materials": [ # Additional materials. Announcements must have no more than 20 material items.
+ { # Material attached to course work. When creating attachments, setting the `form` field is not supported.
+ "link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response.
+ "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
+ "title": "A String", # Title of the target of the URL. Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
+ },
+ "driveFile": { # Drive file that is used as material for course work. # Google Drive file material.
+ "shareMode": "A String", # Mechanism by which students access the Drive item.
+ "driveFile": { # Representation of a Google Drive file. # Drive file details.
+ "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 material.
+ "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.
+ },
+ "youtubeVideo": { # YouTube video item. # YouTube video material.
+ "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.
+ },
+ },
+ ],
+ "text": "A String", # Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters.
"scheduledTime": "A String", # Optional timestamp when this announcement is scheduled to be published.
+ "updateTime": "A String", # Timestamp of the most recent change to this announcement. Read-only.
"individualStudentsOptions": { # Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. # Identifiers of students with access to the announcement. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field can see the announcement.
"studentIds": [ # Identifiers for the students that have access to the coursework/announcement.
"A String",
],
},
+ "assigneeMode": "A String", # Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.
"creatorUserId": "A String", # Identifier for the user that created the announcement. Read-only.
- "id": "A String", # Classroom-assigned identifier of this announcement, unique per course. Read-only.
- "materials": [ # Additional materials. Announcements must have no more than 20 material items.
- { # Material attached to course work. When creating attachments, setting the `form` field is not supported.
- "youtubeVideo": { # YouTube video item. # YouTube video material.
- "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.
- },
- "link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response.
- "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.
- },
- "driveFile": { # Drive file that is used as material for course work. # Google Drive file material.
- "driveFile": { # Representation of a Google Drive file. # Drive file details.
- "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.
- },
- "shareMode": "A String", # Mechanism by which students access the Drive item.
- },
- "form": { # Google Forms item. # Google Forms material.
- "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.
- },
- },
- ],
+ "courseId": "A String", # Identifier of the course. Read-only.
+ "alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
+ "creationTime": "A String", # Timestamp when this announcement was created. Read-only.
}
updateMask: string, Mask that identifies which fields on the announcement to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the Announcement object. If a field that does not support empty values is included in the update mask and not set in the Announcement object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `text` * `state` * `scheduled_time`
@@ -539,51 +539,51 @@
An object of the form:
{ # Announcement created by a teacher for students of the course
- "assigneeMode": "A String", # Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.
- "creationTime": "A String", # Timestamp when this announcement was created. Read-only.
- "text": "A String", # Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters.
- "alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
"state": "A String", # Status of this announcement. If unspecified, the default state is `DRAFT`.
- "courseId": "A String", # Identifier of the course. Read-only.
- "updateTime": "A String", # Timestamp of the most recent change to this announcement. Read-only.
+ "id": "A String", # Classroom-assigned identifier of this announcement, unique per course. Read-only.
+ "materials": [ # Additional materials. Announcements must have no more than 20 material items.
+ { # Material attached to course work. When creating attachments, setting the `form` field is not supported.
+ "link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response.
+ "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
+ "title": "A String", # Title of the target of the URL. Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
+ },
+ "driveFile": { # Drive file that is used as material for course work. # Google Drive file material.
+ "shareMode": "A String", # Mechanism by which students access the Drive item.
+ "driveFile": { # Representation of a Google Drive file. # Drive file details.
+ "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 material.
+ "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.
+ },
+ "youtubeVideo": { # YouTube video item. # YouTube video material.
+ "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.
+ },
+ },
+ ],
+ "text": "A String", # Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters.
"scheduledTime": "A String", # Optional timestamp when this announcement is scheduled to be published.
+ "updateTime": "A String", # Timestamp of the most recent change to this announcement. Read-only.
"individualStudentsOptions": { # Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. # Identifiers of students with access to the announcement. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field can see the announcement.
"studentIds": [ # Identifiers for the students that have access to the coursework/announcement.
"A String",
],
},
+ "assigneeMode": "A String", # Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.
"creatorUserId": "A String", # Identifier for the user that created the announcement. Read-only.
- "id": "A String", # Classroom-assigned identifier of this announcement, unique per course. Read-only.
- "materials": [ # Additional materials. Announcements must have no more than 20 material items.
- { # Material attached to course work. When creating attachments, setting the `form` field is not supported.
- "youtubeVideo": { # YouTube video item. # YouTube video material.
- "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.
- },
- "link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response.
- "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.
- },
- "driveFile": { # Drive file that is used as material for course work. # Google Drive file material.
- "driveFile": { # Representation of a Google Drive file. # Drive file details.
- "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.
- },
- "shareMode": "A String", # Mechanism by which students access the Drive item.
- },
- "form": { # Google Forms item. # Google Forms material.
- "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.
- },
- },
- ],
+ "courseId": "A String", # Identifier of the course. Read-only.
+ "alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
+ "creationTime": "A String", # Timestamp when this announcement was created. Read-only.
}</pre>
</div>