docs: update generated docs (#981)
diff --git a/docs/dyn/classroom_v1.courses.announcements.html b/docs/dyn/classroom_v1.courses.announcements.html
index 273d0cd..79b4f77 100644
--- a/docs/dyn/classroom_v1.courses.announcements.html
+++ b/docs/dyn/classroom_v1.courses.announcements.html
@@ -84,7 +84,7 @@
<code><a href="#get">get(courseId, id, x__xgafv=None)</a></code></p>
<p class="firstline">Returns an announcement.</p>
<p class="toc_element">
- <code><a href="#list">list(courseId, announcementStates=None, orderBy=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(courseId, orderBy=None, pageSize=None, pageToken=None, announcementStates=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a list of announcements that the requester is permitted to view.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -118,189 +118,14 @@
The object takes the form of:
{ # Announcement created by a teacher for students of the course
- "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.
- "title": "A String", # Title of the YouTube video.
- #
- # Read-only.
- "alternateLink": "A String", # URL that can be used to view the YouTube video.
- #
- # Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video.
- #
- # Read-only.
- "id": "A String", # YouTube API resource ID.
- },
- "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.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.
- #
- # Read-only.
- "id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive item.
- #
- # Read-only.
- },
- "shareMode": "A String", # Mechanism by which students access the Drive item.
- },
- "form": { # Google Forms item. # Google Forms material.
- "formUrl": "A String", # URL of the form.
- "title": "A String", # Title of the Form.
- #
- # Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Form.
- #
- # Read-only.
- "responseUrl": "A String", # URL of the form responses document.
- # Only set if respsonses have been recorded and only when the
- # requesting user is an editor of the form.
- #
- # Read-only.
- },
- "link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type
- # if possible, and this is reflected in the response.
- "title": "A String", # Title of the target of the URL.
- #
- # Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL.
- #
- # Read-only.
- "url": "A String", # URL to link to.
- # This must be a valid UTF-8 string containing between 1 and 2024 characters.
- },
- },
- ],
- "updateTime": "A String", # Timestamp of the most recent change to this announcement.
- #
- # Read-only.
- "assigneeMode": "A String", # Assignee mode of the announcement.
- # If unspecified, the default value is `ALL_STUDENTS`.
- "alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI.
- # This is only populated if `state` is `PUBLISHED`.
- #
- # Read-only.
- "scheduledTime": "A String", # Optional timestamp when this announcement is scheduled to be published.
- "creationTime": "A String", # Timestamp when this announcement was created.
- #
- # Read-only.
- "creatorUserId": "A String", # Identifier for the user that created the announcement.
- #
- # Read-only.
- "individualStudentsOptions": { # Assignee details about a coursework/announcement. # 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.
- # This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.
- "studentIds": [ # Identifiers for the students that have access to the
- # coursework/announcement.
- "A String",
- ],
- },
- "state": "A String", # Status of this announcement.
- # If unspecified, the default state is `DRAFT`.
- "text": "A String", # Description of this announcement.
- # The text must be a valid UTF-8 string containing no more
- # than 30,000 characters.
- "courseId": "A String", # Identifier of the course.
- #
- # Read-only.
- "id": "A String", # Classroom-assigned identifier of this announcement, unique per course.
- #
- # Read-only.
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # Announcement created by a teacher for students of the course
- "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.
- "title": "A String", # Title of the YouTube video.
- #
- # Read-only.
- "alternateLink": "A String", # URL that can be used to view the YouTube video.
- #
- # Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video.
- #
- # Read-only.
- "id": "A String", # YouTube API resource ID.
- },
- "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.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.
- #
- # Read-only.
- "id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive item.
- #
- # Read-only.
- },
- "shareMode": "A String", # Mechanism by which students access the Drive item.
- },
- "form": { # Google Forms item. # Google Forms material.
- "formUrl": "A String", # URL of the form.
- "title": "A String", # Title of the Form.
- #
- # Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Form.
- #
- # Read-only.
- "responseUrl": "A String", # URL of the form responses document.
- # Only set if respsonses have been recorded and only when the
- # requesting user is an editor of the form.
- #
- # Read-only.
- },
- "link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type
- # if possible, and this is reflected in the response.
- "title": "A String", # Title of the target of the URL.
- #
- # Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL.
- #
- # Read-only.
- "url": "A String", # URL to link to.
- # This must be a valid UTF-8 string containing between 1 and 2024 characters.
- },
- },
- ],
+ "id": "A String", # Classroom-assigned identifier of this announcement, unique per course.
+ #
+ # Read-only.
"updateTime": "A String", # Timestamp of the most recent change to this announcement.
- #
- # Read-only.
- "assigneeMode": "A String", # Assignee mode of the announcement.
- # If unspecified, the default value is `ALL_STUDENTS`.
- "alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI.
- # This is only populated if `state` is `PUBLISHED`.
- #
- # Read-only.
- "scheduledTime": "A String", # Optional timestamp when this announcement is scheduled to be published.
- "creationTime": "A String", # Timestamp when this announcement was created.
- #
+ #
# Read-only.
"creatorUserId": "A String", # Identifier for the user that created the announcement.
- #
+ #
# Read-only.
"individualStudentsOptions": { # Assignee details about a coursework/announcement. # Identifiers of students with access to the announcement.
# This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.
@@ -312,18 +137,193 @@
"A String",
],
},
- "state": "A String", # Status of this announcement.
- # If unspecified, the default state is `DRAFT`.
+ "creationTime": "A String", # Timestamp when this announcement was created.
+ #
+ # Read-only.
+ "assigneeMode": "A String", # Assignee mode of the announcement.
+ # If unspecified, the default value is `ALL_STUDENTS`.
+ "scheduledTime": "A String", # Optional timestamp when this announcement is scheduled to be published.
+ "alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI.
+ # This is only populated if `state` is `PUBLISHED`.
+ #
+ # Read-only.
+ "courseId": "A String", # Identifier of the course.
+ #
+ # 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.
- "courseId": "A String", # Identifier of the course.
- #
- # Read-only.
- "id": "A String", # Classroom-assigned identifier of this announcement, unique per course.
- #
- # Read-only.
- }</pre>
+ "state": "A String", # Status of this announcement.
+ # If unspecified, the default state is `DRAFT`.
+ "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.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL.
+ #
+ # Read-only.
+ "title": "A String", # Title of the target of the URL.
+ #
+ # Read-only.
+ },
+ "driveFile": { # 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.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.
+ #
+ # Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive item.
+ #
+ # Read-only.
+ "id": "A String", # Drive API resource ID.
+ "title": "A String", # Title of the Drive item.
+ #
+ # Read-only.
+ },
+ },
+ "youtubeVideo": { # YouTube video item. # YouTube video material.
+ "alternateLink": "A String", # URL that can be used to view the YouTube video.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video.
+ #
+ # Read-only.
+ "id": "A String", # YouTube API resource ID.
+ "title": "A String", # Title of the YouTube video.
+ #
+ # Read-only.
+ },
+ "form": { # Google Forms item. # Google Forms material.
+ "title": "A String", # Title of the Form.
+ #
+ # Read-only.
+ "responseUrl": "A String", # URL of the form responses document.
+ # Only set if respsonses have been recorded and only when the
+ # requesting user is an editor of the form.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form.
+ #
+ # Read-only.
+ "formUrl": "A String", # URL of the form.
+ },
+ },
+ ],
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Announcement created by a teacher for students of the course
+ "id": "A String", # Classroom-assigned identifier of this announcement, unique per course.
+ #
+ # Read-only.
+ "updateTime": "A String", # Timestamp of the most recent change to this announcement.
+ #
+ # Read-only.
+ "creatorUserId": "A String", # Identifier for the user that created the announcement.
+ #
+ # Read-only.
+ "individualStudentsOptions": { # Assignee details about a coursework/announcement. # 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.
+ # This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.
+ "studentIds": [ # Identifiers for the students that have access to the
+ # coursework/announcement.
+ "A String",
+ ],
+ },
+ "creationTime": "A String", # Timestamp when this announcement was created.
+ #
+ # Read-only.
+ "assigneeMode": "A String", # Assignee mode of the announcement.
+ # If unspecified, the default value is `ALL_STUDENTS`.
+ "scheduledTime": "A String", # Optional timestamp when this announcement is scheduled to be published.
+ "alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI.
+ # This is only populated if `state` is `PUBLISHED`.
+ #
+ # Read-only.
+ "courseId": "A String", # Identifier of the course.
+ #
+ # 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.
+ "state": "A String", # Status of this announcement.
+ # If unspecified, the default state is `DRAFT`.
+ "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.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL.
+ #
+ # Read-only.
+ "title": "A String", # Title of the target of the URL.
+ #
+ # Read-only.
+ },
+ "driveFile": { # 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.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.
+ #
+ # Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive item.
+ #
+ # Read-only.
+ "id": "A String", # Drive API resource ID.
+ "title": "A String", # Title of the Drive item.
+ #
+ # Read-only.
+ },
+ },
+ "youtubeVideo": { # YouTube video item. # YouTube video material.
+ "alternateLink": "A String", # URL that can be used to view the YouTube video.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video.
+ #
+ # Read-only.
+ "id": "A String", # YouTube API resource ID.
+ "title": "A String", # Title of the YouTube video.
+ #
+ # Read-only.
+ },
+ "form": { # Google Forms item. # Google Forms material.
+ "title": "A String", # Title of the Form.
+ #
+ # Read-only.
+ "responseUrl": "A String", # URL of the form responses document.
+ # Only set if respsonses have been recorded and only when the
+ # requesting user is an editor of the form.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form.
+ #
+ # Read-only.
+ "formUrl": "A String", # URL of the form.
+ },
+ },
+ ],
+ }</pre>
</div>
<div class="method">
@@ -394,108 +394,108 @@
An object of the form:
{ # Announcement created by a teacher for students of the course
- "materials": [ # Additional materials.
- #
- # Announcements must have no more than 20 material items.
- { # Material attached to course work.
+ "id": "A String", # Classroom-assigned identifier of this announcement, unique per course.
#
- # When creating attachments, setting the `form` field is not supported.
- "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.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video.
- #
- # Read-only.
- "id": "A String", # YouTube API resource ID.
- },
- "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.
+ "updateTime": "A String", # Timestamp of the most recent change to this announcement.
+ #
+ # Read-only.
+ "creatorUserId": "A String", # Identifier for the user that created the announcement.
+ #
+ # Read-only.
+ "individualStudentsOptions": { # Assignee details about a coursework/announcement. # 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.
+ # This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.
+ "studentIds": [ # Identifiers for the students that have access to the
+ # coursework/announcement.
+ "A String",
+ ],
+ },
+ "creationTime": "A String", # Timestamp when this announcement was created.
+ #
+ # Read-only.
+ "assigneeMode": "A String", # Assignee mode of the announcement.
+ # If unspecified, the default value is `ALL_STUDENTS`.
+ "scheduledTime": "A String", # Optional timestamp when this announcement is scheduled to be published.
+ "alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI.
+ # This is only populated if `state` is `PUBLISHED`.
+ #
+ # Read-only.
+ "courseId": "A String", # Identifier of the course.
+ #
+ # 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.
+ "state": "A String", # Status of this announcement.
+ # If unspecified, the default state is `DRAFT`.
+ "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.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL.
#
# Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.
- #
- # Read-only.
- "id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive item.
+ "title": "A String", # Title of the target of the URL.
#
# Read-only.
},
- "shareMode": "A String", # Mechanism by which students access the Drive item.
+ "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.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.
+ #
+ # Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive item.
+ #
+ # Read-only.
+ "id": "A String", # Drive API resource ID.
+ "title": "A String", # Title of the Drive item.
+ #
+ # Read-only.
+ },
+ },
+ "youtubeVideo": { # YouTube video item. # YouTube video material.
+ "alternateLink": "A String", # URL that can be used to view the YouTube video.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video.
+ #
+ # Read-only.
+ "id": "A String", # YouTube API resource ID.
+ "title": "A String", # Title of the YouTube video.
+ #
+ # Read-only.
+ },
+ "form": { # Google Forms item. # Google Forms material.
+ "title": "A String", # Title of the Form.
+ #
+ # Read-only.
+ "responseUrl": "A String", # URL of the form responses document.
+ # Only set if respsonses have been recorded and only when the
+ # requesting user is an editor of the form.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form.
+ #
+ # Read-only.
+ "formUrl": "A String", # URL of the form.
+ },
},
- "form": { # Google Forms item. # Google Forms material.
- "formUrl": "A String", # URL of the form.
- "title": "A String", # Title of the Form.
- #
- # Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Form.
- #
- # Read-only.
- "responseUrl": "A String", # URL of the form responses document.
- # Only set if respsonses have been recorded and only when the
- # requesting user is an editor of the form.
- #
- # Read-only.
- },
- "link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type
- # if possible, and this is reflected in the response.
- "title": "A String", # Title of the target of the URL.
- #
- # Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL.
- #
- # Read-only.
- "url": "A String", # URL to link to.
- # This must be a valid UTF-8 string containing between 1 and 2024 characters.
- },
- },
- ],
- "updateTime": "A String", # Timestamp of the most recent change to this announcement.
- #
- # Read-only.
- "assigneeMode": "A String", # Assignee mode of the announcement.
- # If unspecified, the default value is `ALL_STUDENTS`.
- "alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI.
- # This is only populated if `state` is `PUBLISHED`.
- #
- # Read-only.
- "scheduledTime": "A String", # Optional timestamp when this announcement is scheduled to be published.
- "creationTime": "A String", # Timestamp when this announcement was created.
- #
- # Read-only.
- "creatorUserId": "A String", # Identifier for the user that created the announcement.
- #
- # Read-only.
- "individualStudentsOptions": { # Assignee details about a coursework/announcement. # 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.
- # This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.
- "studentIds": [ # Identifiers for the students that have access to the
- # coursework/announcement.
- "A String",
],
- },
- "state": "A String", # Status of this announcement.
- # If unspecified, the default state is `DRAFT`.
- "text": "A String", # Description of this announcement.
- # The text must be a valid UTF-8 string containing no more
- # than 30,000 characters.
- "courseId": "A String", # Identifier of the course.
- #
- # Read-only.
- "id": "A String", # Classroom-assigned identifier of this announcement, unique per course.
- #
- # Read-only.
- }</pre>
+ }</pre>
</div>
<div class="method">
- <code class="details" id="list">list(courseId, announcementStates=None, orderBy=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(courseId, orderBy=None, pageSize=None, pageToken=None, announcementStates=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
@@ -512,13 +512,15 @@
courseId: string, Identifier of the course.
This identifier can be either the Classroom-assigned identifier or an
alias. (required)
- announcementStates: string, Restriction on the `state` of announcements returned.
-If this argument is left unspecified, the default value is `PUBLISHED`. (repeated)
orderBy: string, Optional sort ordering for results. A comma-separated list of fields with
an optional sort direction keyword. Supported field is `updateTime`.
Supported direction keywords are `asc` and `desc`.
If not specified, `updateTime desc` is the default behavior.
Examples: `updateTime asc`, `updateTime`
+ 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,
@@ -526,10 +528,8 @@
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.
+ announcementStates: string, Restriction on the `state` of announcements returned.
+If this argument is left unspecified, the default value is `PUBLISHED`. (repeated)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -539,109 +539,109 @@
An object of the form:
{ # Response when listing course work.
+ "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further
+ # results are available.
"announcements": [ # Announcement items that match the request.
{ # Announcement created by a teacher for students of the course
- "materials": [ # Additional materials.
- #
- # Announcements must have no more than 20 material items.
- { # Material attached to course work.
+ "id": "A String", # Classroom-assigned identifier of this announcement, unique per course.
#
- # When creating attachments, setting the `form` field is not supported.
- "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.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video.
- #
- # Read-only.
- "id": "A String", # YouTube API resource ID.
- },
- "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.
+ "updateTime": "A String", # Timestamp of the most recent change to this announcement.
+ #
+ # Read-only.
+ "creatorUserId": "A String", # Identifier for the user that created the announcement.
+ #
+ # Read-only.
+ "individualStudentsOptions": { # Assignee details about a coursework/announcement. # 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.
+ # This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.
+ "studentIds": [ # Identifiers for the students that have access to the
+ # coursework/announcement.
+ "A String",
+ ],
+ },
+ "creationTime": "A String", # Timestamp when this announcement was created.
+ #
+ # Read-only.
+ "assigneeMode": "A String", # Assignee mode of the announcement.
+ # If unspecified, the default value is `ALL_STUDENTS`.
+ "scheduledTime": "A String", # Optional timestamp when this announcement is scheduled to be published.
+ "alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI.
+ # This is only populated if `state` is `PUBLISHED`.
+ #
+ # Read-only.
+ "courseId": "A String", # Identifier of the course.
+ #
+ # 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.
+ "state": "A String", # Status of this announcement.
+ # If unspecified, the default state is `DRAFT`.
+ "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.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL.
#
# Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.
- #
- # Read-only.
- "id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive item.
+ "title": "A String", # Title of the target of the URL.
#
# Read-only.
},
- "shareMode": "A String", # Mechanism by which students access the Drive item.
+ "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.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.
+ #
+ # Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive item.
+ #
+ # Read-only.
+ "id": "A String", # Drive API resource ID.
+ "title": "A String", # Title of the Drive item.
+ #
+ # Read-only.
+ },
+ },
+ "youtubeVideo": { # YouTube video item. # YouTube video material.
+ "alternateLink": "A String", # URL that can be used to view the YouTube video.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video.
+ #
+ # Read-only.
+ "id": "A String", # YouTube API resource ID.
+ "title": "A String", # Title of the YouTube video.
+ #
+ # Read-only.
+ },
+ "form": { # Google Forms item. # Google Forms material.
+ "title": "A String", # Title of the Form.
+ #
+ # Read-only.
+ "responseUrl": "A String", # URL of the form responses document.
+ # Only set if respsonses have been recorded and only when the
+ # requesting user is an editor of the form.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form.
+ #
+ # Read-only.
+ "formUrl": "A String", # URL of the form.
+ },
},
- "form": { # Google Forms item. # Google Forms material.
- "formUrl": "A String", # URL of the form.
- "title": "A String", # Title of the Form.
- #
- # Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Form.
- #
- # Read-only.
- "responseUrl": "A String", # URL of the form responses document.
- # Only set if respsonses have been recorded and only when the
- # requesting user is an editor of the form.
- #
- # Read-only.
- },
- "link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type
- # if possible, and this is reflected in the response.
- "title": "A String", # Title of the target of the URL.
- #
- # Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL.
- #
- # Read-only.
- "url": "A String", # URL to link to.
- # This must be a valid UTF-8 string containing between 1 and 2024 characters.
- },
- },
- ],
- "updateTime": "A String", # Timestamp of the most recent change to this announcement.
- #
- # Read-only.
- "assigneeMode": "A String", # Assignee mode of the announcement.
- # If unspecified, the default value is `ALL_STUDENTS`.
- "alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI.
- # This is only populated if `state` is `PUBLISHED`.
- #
- # Read-only.
- "scheduledTime": "A String", # Optional timestamp when this announcement is scheduled to be published.
- "creationTime": "A String", # Timestamp when this announcement was created.
- #
- # Read-only.
- "creatorUserId": "A String", # Identifier for the user that created the announcement.
- #
- # Read-only.
- "individualStudentsOptions": { # Assignee details about a coursework/announcement. # 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.
- # This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.
- "studentIds": [ # Identifiers for the students that have access to the
- # coursework/announcement.
- "A String",
],
},
- "state": "A String", # Status of this announcement.
- # If unspecified, the default state is `DRAFT`.
- "text": "A String", # Description of this announcement.
- # The text must be a valid UTF-8 string containing no more
- # than 30,000 characters.
- "courseId": "A String", # Identifier of the course.
- #
- # Read-only.
- "id": "A String", # Classroom-assigned identifier of this announcement, unique per course.
- #
- # Read-only.
- },
],
- "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further
- # results are available.
}</pre>
</div>
@@ -707,104 +707,104 @@
An object of the form:
{ # Announcement created by a teacher for students of the course
- "materials": [ # Additional materials.
- #
- # Announcements must have no more than 20 material items.
- { # Material attached to course work.
+ "id": "A String", # Classroom-assigned identifier of this announcement, unique per course.
#
- # When creating attachments, setting the `form` field is not supported.
- "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.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video.
- #
- # Read-only.
- "id": "A String", # YouTube API resource ID.
- },
- "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.
+ "updateTime": "A String", # Timestamp of the most recent change to this announcement.
+ #
+ # Read-only.
+ "creatorUserId": "A String", # Identifier for the user that created the announcement.
+ #
+ # Read-only.
+ "individualStudentsOptions": { # Assignee details about a coursework/announcement. # 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.
+ # This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.
+ "studentIds": [ # Identifiers for the students that have access to the
+ # coursework/announcement.
+ "A String",
+ ],
+ },
+ "creationTime": "A String", # Timestamp when this announcement was created.
+ #
+ # Read-only.
+ "assigneeMode": "A String", # Assignee mode of the announcement.
+ # If unspecified, the default value is `ALL_STUDENTS`.
+ "scheduledTime": "A String", # Optional timestamp when this announcement is scheduled to be published.
+ "alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI.
+ # This is only populated if `state` is `PUBLISHED`.
+ #
+ # Read-only.
+ "courseId": "A String", # Identifier of the course.
+ #
+ # 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.
+ "state": "A String", # Status of this announcement.
+ # If unspecified, the default state is `DRAFT`.
+ "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.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL.
#
# Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.
- #
- # Read-only.
- "id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive item.
+ "title": "A String", # Title of the target of the URL.
#
# Read-only.
},
- "shareMode": "A String", # Mechanism by which students access the Drive item.
+ "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.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.
+ #
+ # Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive item.
+ #
+ # Read-only.
+ "id": "A String", # Drive API resource ID.
+ "title": "A String", # Title of the Drive item.
+ #
+ # Read-only.
+ },
+ },
+ "youtubeVideo": { # YouTube video item. # YouTube video material.
+ "alternateLink": "A String", # URL that can be used to view the YouTube video.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video.
+ #
+ # Read-only.
+ "id": "A String", # YouTube API resource ID.
+ "title": "A String", # Title of the YouTube video.
+ #
+ # Read-only.
+ },
+ "form": { # Google Forms item. # Google Forms material.
+ "title": "A String", # Title of the Form.
+ #
+ # Read-only.
+ "responseUrl": "A String", # URL of the form responses document.
+ # Only set if respsonses have been recorded and only when the
+ # requesting user is an editor of the form.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form.
+ #
+ # Read-only.
+ "formUrl": "A String", # URL of the form.
+ },
},
- "form": { # Google Forms item. # Google Forms material.
- "formUrl": "A String", # URL of the form.
- "title": "A String", # Title of the Form.
- #
- # Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Form.
- #
- # Read-only.
- "responseUrl": "A String", # URL of the form responses document.
- # Only set if respsonses have been recorded and only when the
- # requesting user is an editor of the form.
- #
- # Read-only.
- },
- "link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type
- # if possible, and this is reflected in the response.
- "title": "A String", # Title of the target of the URL.
- #
- # Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL.
- #
- # Read-only.
- "url": "A String", # URL to link to.
- # This must be a valid UTF-8 string containing between 1 and 2024 characters.
- },
- },
- ],
- "updateTime": "A String", # Timestamp of the most recent change to this announcement.
- #
- # Read-only.
- "assigneeMode": "A String", # Assignee mode of the announcement.
- # If unspecified, the default value is `ALL_STUDENTS`.
- "alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI.
- # This is only populated if `state` is `PUBLISHED`.
- #
- # Read-only.
- "scheduledTime": "A String", # Optional timestamp when this announcement is scheduled to be published.
- "creationTime": "A String", # Timestamp when this announcement was created.
- #
- # Read-only.
- "creatorUserId": "A String", # Identifier for the user that created the announcement.
- #
- # Read-only.
- "individualStudentsOptions": { # Assignee details about a coursework/announcement. # 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.
- # This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.
- "studentIds": [ # Identifiers for the students that have access to the
- # coursework/announcement.
- "A String",
],
- },
- "state": "A String", # Status of this announcement.
- # If unspecified, the default state is `DRAFT`.
- "text": "A String", # Description of this announcement.
- # The text must be a valid UTF-8 string containing no more
- # than 30,000 characters.
- "courseId": "A String", # Identifier of the course.
- #
- # Read-only.
- "id": "A String", # Classroom-assigned identifier of this announcement, unique per course.
- #
- # Read-only.
- }</pre>
+ }</pre>
</div>
<div class="method">
@@ -829,104 +829,104 @@
The object takes the form of:
{ # Announcement created by a teacher for students of the course
- "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.
- "title": "A String", # Title of the YouTube video.
- #
- # Read-only.
- "alternateLink": "A String", # URL that can be used to view the YouTube video.
- #
- # Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video.
- #
- # Read-only.
- "id": "A String", # YouTube API resource ID.
- },
- "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.
+ "id": "A String", # Classroom-assigned identifier of this announcement, unique per course.
+ #
+ # Read-only.
+ "updateTime": "A String", # Timestamp of the most recent change to this announcement.
+ #
+ # Read-only.
+ "creatorUserId": "A String", # Identifier for the user that created the announcement.
+ #
+ # Read-only.
+ "individualStudentsOptions": { # Assignee details about a coursework/announcement. # 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.
+ # This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.
+ "studentIds": [ # Identifiers for the students that have access to the
+ # coursework/announcement.
+ "A String",
+ ],
+ },
+ "creationTime": "A String", # Timestamp when this announcement was created.
+ #
+ # Read-only.
+ "assigneeMode": "A String", # Assignee mode of the announcement.
+ # If unspecified, the default value is `ALL_STUDENTS`.
+ "scheduledTime": "A String", # Optional timestamp when this announcement is scheduled to be published.
+ "alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI.
+ # This is only populated if `state` is `PUBLISHED`.
+ #
+ # Read-only.
+ "courseId": "A String", # Identifier of the course.
+ #
+ # 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.
+ "state": "A String", # Status of this announcement.
+ # If unspecified, the default state is `DRAFT`.
+ "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.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL.
#
# Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.
- #
- # Read-only.
- "id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive item.
+ "title": "A String", # Title of the target of the URL.
#
# Read-only.
},
- "shareMode": "A String", # Mechanism by which students access the Drive item.
+ "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.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.
+ #
+ # Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive item.
+ #
+ # Read-only.
+ "id": "A String", # Drive API resource ID.
+ "title": "A String", # Title of the Drive item.
+ #
+ # Read-only.
+ },
+ },
+ "youtubeVideo": { # YouTube video item. # YouTube video material.
+ "alternateLink": "A String", # URL that can be used to view the YouTube video.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video.
+ #
+ # Read-only.
+ "id": "A String", # YouTube API resource ID.
+ "title": "A String", # Title of the YouTube video.
+ #
+ # Read-only.
+ },
+ "form": { # Google Forms item. # Google Forms material.
+ "title": "A String", # Title of the Form.
+ #
+ # Read-only.
+ "responseUrl": "A String", # URL of the form responses document.
+ # Only set if respsonses have been recorded and only when the
+ # requesting user is an editor of the form.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form.
+ #
+ # Read-only.
+ "formUrl": "A String", # URL of the form.
+ },
},
- "form": { # Google Forms item. # Google Forms material.
- "formUrl": "A String", # URL of the form.
- "title": "A String", # Title of the Form.
- #
- # Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Form.
- #
- # Read-only.
- "responseUrl": "A String", # URL of the form responses document.
- # Only set if respsonses have been recorded and only when the
- # requesting user is an editor of the form.
- #
- # Read-only.
- },
- "link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type
- # if possible, and this is reflected in the response.
- "title": "A String", # Title of the target of the URL.
- #
- # Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL.
- #
- # Read-only.
- "url": "A String", # URL to link to.
- # This must be a valid UTF-8 string containing between 1 and 2024 characters.
- },
- },
- ],
- "updateTime": "A String", # Timestamp of the most recent change to this announcement.
- #
- # Read-only.
- "assigneeMode": "A String", # Assignee mode of the announcement.
- # If unspecified, the default value is `ALL_STUDENTS`.
- "alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI.
- # This is only populated if `state` is `PUBLISHED`.
- #
- # Read-only.
- "scheduledTime": "A String", # Optional timestamp when this announcement is scheduled to be published.
- "creationTime": "A String", # Timestamp when this announcement was created.
- #
- # Read-only.
- "creatorUserId": "A String", # Identifier for the user that created the announcement.
- #
- # Read-only.
- "individualStudentsOptions": { # Assignee details about a coursework/announcement. # 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.
- # This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.
- "studentIds": [ # Identifiers for the students that have access to the
- # coursework/announcement.
- "A String",
],
- },
- "state": "A String", # Status of this announcement.
- # If unspecified, the default state is `DRAFT`.
- "text": "A String", # Description of this announcement.
- # The text must be a valid UTF-8 string containing no more
- # than 30,000 characters.
- "courseId": "A String", # Identifier of the course.
- #
- # Read-only.
- "id": "A String", # Classroom-assigned identifier of this announcement, unique per course.
- #
- # 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
@@ -950,104 +950,104 @@
An object of the form:
{ # Announcement created by a teacher for students of the course
- "materials": [ # Additional materials.
- #
- # Announcements must have no more than 20 material items.
- { # Material attached to course work.
+ "id": "A String", # Classroom-assigned identifier of this announcement, unique per course.
#
- # When creating attachments, setting the `form` field is not supported.
- "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.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video.
- #
- # Read-only.
- "id": "A String", # YouTube API resource ID.
- },
- "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.
+ "updateTime": "A String", # Timestamp of the most recent change to this announcement.
+ #
+ # Read-only.
+ "creatorUserId": "A String", # Identifier for the user that created the announcement.
+ #
+ # Read-only.
+ "individualStudentsOptions": { # Assignee details about a coursework/announcement. # 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.
+ # This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.
+ "studentIds": [ # Identifiers for the students that have access to the
+ # coursework/announcement.
+ "A String",
+ ],
+ },
+ "creationTime": "A String", # Timestamp when this announcement was created.
+ #
+ # Read-only.
+ "assigneeMode": "A String", # Assignee mode of the announcement.
+ # If unspecified, the default value is `ALL_STUDENTS`.
+ "scheduledTime": "A String", # Optional timestamp when this announcement is scheduled to be published.
+ "alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI.
+ # This is only populated if `state` is `PUBLISHED`.
+ #
+ # Read-only.
+ "courseId": "A String", # Identifier of the course.
+ #
+ # 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.
+ "state": "A String", # Status of this announcement.
+ # If unspecified, the default state is `DRAFT`.
+ "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.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL.
#
# Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.
- #
- # Read-only.
- "id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive item.
+ "title": "A String", # Title of the target of the URL.
#
# Read-only.
},
- "shareMode": "A String", # Mechanism by which students access the Drive item.
+ "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.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.
+ #
+ # Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive item.
+ #
+ # Read-only.
+ "id": "A String", # Drive API resource ID.
+ "title": "A String", # Title of the Drive item.
+ #
+ # Read-only.
+ },
+ },
+ "youtubeVideo": { # YouTube video item. # YouTube video material.
+ "alternateLink": "A String", # URL that can be used to view the YouTube video.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video.
+ #
+ # Read-only.
+ "id": "A String", # YouTube API resource ID.
+ "title": "A String", # Title of the YouTube video.
+ #
+ # Read-only.
+ },
+ "form": { # Google Forms item. # Google Forms material.
+ "title": "A String", # Title of the Form.
+ #
+ # Read-only.
+ "responseUrl": "A String", # URL of the form responses document.
+ # Only set if respsonses have been recorded and only when the
+ # requesting user is an editor of the form.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form.
+ #
+ # Read-only.
+ "formUrl": "A String", # URL of the form.
+ },
},
- "form": { # Google Forms item. # Google Forms material.
- "formUrl": "A String", # URL of the form.
- "title": "A String", # Title of the Form.
- #
- # Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Form.
- #
- # Read-only.
- "responseUrl": "A String", # URL of the form responses document.
- # Only set if respsonses have been recorded and only when the
- # requesting user is an editor of the form.
- #
- # Read-only.
- },
- "link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type
- # if possible, and this is reflected in the response.
- "title": "A String", # Title of the target of the URL.
- #
- # Read-only.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL.
- #
- # Read-only.
- "url": "A String", # URL to link to.
- # This must be a valid UTF-8 string containing between 1 and 2024 characters.
- },
- },
- ],
- "updateTime": "A String", # Timestamp of the most recent change to this announcement.
- #
- # Read-only.
- "assigneeMode": "A String", # Assignee mode of the announcement.
- # If unspecified, the default value is `ALL_STUDENTS`.
- "alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI.
- # This is only populated if `state` is `PUBLISHED`.
- #
- # Read-only.
- "scheduledTime": "A String", # Optional timestamp when this announcement is scheduled to be published.
- "creationTime": "A String", # Timestamp when this announcement was created.
- #
- # Read-only.
- "creatorUserId": "A String", # Identifier for the user that created the announcement.
- #
- # Read-only.
- "individualStudentsOptions": { # Assignee details about a coursework/announcement. # 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.
- # This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.
- "studentIds": [ # Identifiers for the students that have access to the
- # coursework/announcement.
- "A String",
],
- },
- "state": "A String", # Status of this announcement.
- # If unspecified, the default state is `DRAFT`.
- "text": "A String", # Description of this announcement.
- # The text must be a valid UTF-8 string containing no more
- # than 30,000 characters.
- "courseId": "A String", # Identifier of the course.
- #
- # Read-only.
- "id": "A String", # Classroom-assigned identifier of this announcement, unique per course.
- #
- # Read-only.
- }</pre>
+ }</pre>
</div>
</body></html>
\ No newline at end of file