docs: update docs/dyn (#1096)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/6f0f288a-a1e8-4b2d-a85f-00b1c6150185/targets
- [ ] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/synthtool/commit/39b7149da4026765385403632db3c6f63db96b2c
Source-Link: https://github.com/googleapis/synthtool/commit/9a7d9fbb7045c34c9d3d22c1ff766eeae51f04c9
Source-Link: https://github.com/googleapis/synthtool/commit/dc9903a8c30c3662b6098f0e4a97f221d67268b2
Source-Link: https://github.com/googleapis/synthtool/commit/7fcc405a579d5d53a726ff3da1b7c8c08f0f2d58
Source-Link: https://github.com/googleapis/synthtool/commit/d5fc0bcf9ea9789c5b0e3154a9e3b29e5cea6116
Source-Link: https://github.com/googleapis/synthtool/commit/e89175cf074dccc4babb4eca66ae913696e47a71
Source-Link: https://github.com/googleapis/synthtool/commit/7d652819519dfa24da9e14548232e4aaba71a11c
Source-Link: https://github.com/googleapis/synthtool/commit/7db8a6c5ffb12a6e4c2f799c18f00f7f3d60e279
Source-Link: https://github.com/googleapis/synthtool/commit/1f1148d3c7a7a52f0c98077f976bd9b3c948ee2b
Source-Link: https://github.com/googleapis/synthtool/commit/2c8aecedd55b0480fb4e123b6e07fa5b12953862
Source-Link: https://github.com/googleapis/synthtool/commit/3d3e94c4e02370f307a9a200b0c743c3d8d19f29
Source-Link: https://github.com/googleapis/synthtool/commit/c7824ea48ff6d4d42dfae0849aec8a85acd90bd9
Source-Link: https://github.com/googleapis/synthtool/commit/ba9918cd22874245b55734f57470c719b577e591
Source-Link: https://github.com/googleapis/synthtool/commit/b19b401571e77192f8dd38eab5fb2300a0de9324
Source-Link: https://github.com/googleapis/synthtool/commit/6542bd723403513626f61642fc02ddca528409aa
diff --git a/docs/dyn/classroom_v1.courses.announcements.html b/docs/dyn/classroom_v1.courses.announcements.html
index c770a99..e1d90d2 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, pageSize=None, orderBy=None, pageToken=None, announcementStates=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(courseId, pageToken=None, pageSize=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
- "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.
- "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.
- "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.
- "id": "A String", # Drive API resource ID.
- },
- },
- "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.
- },
- "youtubeVideo": { # YouTube video item. # YouTube video material.
- "title": "A String", # Title of the YouTube video. Read-only.
- "id": "A String", # YouTube API resource ID.
- "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.
- },
- "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.
- },
- },
- ],
"assigneeMode": "A String", # Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.
- "courseId": "A String", # Identifier of the course. Read-only.
"creationTime": "A String", # Timestamp when this announcement was created. Read-only.
- "state": "A String", # Status of this announcement. If unspecified, the default state is `DRAFT`.
- "creatorUserId": "A String", # Identifier for the user that created the announcement. Read-only.
- "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.
"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.
+ "scheduledTime": "A String", # Optional timestamp when this announcement is scheduled to be published.
"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",
],
},
- "alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
+ "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.
+ },
+ },
+ ],
}
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
- "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.
- "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.
- "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.
- "id": "A String", # Drive API resource ID.
- },
- },
- "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.
- },
- "youtubeVideo": { # YouTube video item. # YouTube video material.
- "title": "A String", # Title of the YouTube video. Read-only.
- "id": "A String", # YouTube API resource ID.
- "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.
- },
- "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.
- },
- },
- ],
"assigneeMode": "A String", # Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.
- "courseId": "A String", # Identifier of the course. Read-only.
"creationTime": "A String", # Timestamp when this announcement was created. Read-only.
- "state": "A String", # Status of this announcement. If unspecified, the default state is `DRAFT`.
- "creatorUserId": "A String", # Identifier for the user that created the announcement. Read-only.
- "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.
"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.
+ "scheduledTime": "A String", # Optional timestamp when this announcement is scheduled to be published.
"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",
],
},
- "alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
+ "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.
+ },
+ },
+ ],
}</pre>
</div>
@@ -253,69 +253,69 @@
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.
- "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.
- "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.
- "id": "A String", # Drive API resource ID.
- },
- },
- "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.
- },
- "youtubeVideo": { # YouTube video item. # YouTube video material.
- "title": "A String", # Title of the YouTube video. Read-only.
- "id": "A String", # YouTube API resource ID.
- "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.
- },
- "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.
- },
- },
- ],
"assigneeMode": "A String", # Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.
- "courseId": "A String", # Identifier of the course. Read-only.
"creationTime": "A String", # Timestamp when this announcement was created. Read-only.
- "state": "A String", # Status of this announcement. If unspecified, the default state is `DRAFT`.
- "creatorUserId": "A String", # Identifier for the user that created the announcement. Read-only.
- "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.
"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.
+ "scheduledTime": "A String", # Optional timestamp when this announcement is scheduled to be published.
"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",
],
},
- "alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
+ "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.
+ },
+ },
+ ],
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(courseId, pageSize=None, orderBy=None, pageToken=None, announcementStates=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(courseId, pageToken=None, pageSize=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)
- 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.
- 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`
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.
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.
PUBLISHED - Status for announcement that has been published. This is the default state.
DRAFT - Status for an announcement that is not yet published. Announcement in this state is visible only to course teachers and domain administrators.
DELETED - Status for announcement that was published but is now deleted. Announcement in this state is visible only to course teachers and domain administrators. Announcement in this state is deleted after some time.
+ 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`
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -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
- "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.
- "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.
- "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.
- "id": "A String", # Drive API resource ID.
- },
- },
- "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.
- },
- "youtubeVideo": { # YouTube video item. # YouTube video material.
- "title": "A String", # Title of the YouTube video. Read-only.
- "id": "A String", # YouTube API resource ID.
- "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.
- },
- "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.
- },
- },
- ],
"assigneeMode": "A String", # Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.
- "courseId": "A String", # Identifier of the course. Read-only.
"creationTime": "A String", # Timestamp when this announcement was created. Read-only.
- "state": "A String", # Status of this announcement. If unspecified, the default state is `DRAFT`.
- "creatorUserId": "A String", # Identifier for the user that created the announcement. Read-only.
- "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.
"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.
+ "scheduledTime": "A String", # Optional timestamp when this announcement is scheduled to be published.
"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",
],
},
- "alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
+ "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.
+ },
+ },
+ ],
},
],
"nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available.
@@ -423,51 +423,51 @@
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.
- "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.
- "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.
- "id": "A String", # Drive API resource ID.
- },
- },
- "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.
- },
- "youtubeVideo": { # YouTube video item. # YouTube video material.
- "title": "A String", # Title of the YouTube video. Read-only.
- "id": "A String", # YouTube API resource ID.
- "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.
- },
- "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.
- },
- },
- ],
"assigneeMode": "A String", # Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.
- "courseId": "A String", # Identifier of the course. Read-only.
"creationTime": "A String", # Timestamp when this announcement was created. Read-only.
- "state": "A String", # Status of this announcement. If unspecified, the default state is `DRAFT`.
- "creatorUserId": "A String", # Identifier for the user that created the announcement. Read-only.
- "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.
"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.
+ "scheduledTime": "A String", # Optional timestamp when this announcement is scheduled to be published.
"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",
],
},
- "alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
+ "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.
+ },
+ },
+ ],
}</pre>
</div>
@@ -482,51 +482,51 @@
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.
- "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.
- "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.
- "id": "A String", # Drive API resource ID.
- },
- },
- "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.
- },
- "youtubeVideo": { # YouTube video item. # YouTube video material.
- "title": "A String", # Title of the YouTube video. Read-only.
- "id": "A String", # YouTube API resource ID.
- "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.
- },
- "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.
- },
- },
- ],
"assigneeMode": "A String", # Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.
- "courseId": "A String", # Identifier of the course. Read-only.
"creationTime": "A String", # Timestamp when this announcement was created. Read-only.
- "state": "A String", # Status of this announcement. If unspecified, the default state is `DRAFT`.
- "creatorUserId": "A String", # Identifier for the user that created the announcement. Read-only.
- "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.
"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.
+ "scheduledTime": "A String", # Optional timestamp when this announcement is scheduled to be published.
"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",
],
},
- "alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
+ "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.
+ },
+ },
+ ],
}
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
- "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.
- "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.
- "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.
- "id": "A String", # Drive API resource ID.
- },
- },
- "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.
- },
- "youtubeVideo": { # YouTube video item. # YouTube video material.
- "title": "A String", # Title of the YouTube video. Read-only.
- "id": "A String", # YouTube API resource ID.
- "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.
- },
- "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.
- },
- },
- ],
"assigneeMode": "A String", # Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.
- "courseId": "A String", # Identifier of the course. Read-only.
"creationTime": "A String", # Timestamp when this announcement was created. Read-only.
- "state": "A String", # Status of this announcement. If unspecified, the default state is `DRAFT`.
- "creatorUserId": "A String", # Identifier for the user that created the announcement. Read-only.
- "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.
"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.
+ "scheduledTime": "A String", # Optional timestamp when this announcement is scheduled to be published.
"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",
],
},
- "alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
+ "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.
+ },
+ },
+ ],
}</pre>
</div>