- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
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.
HTTP request
GET https://classroom.googleapis.com/v1/courses/{courseId}/announcements
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
courseId |
Identifier of the course. This identifier can be either the Classroom-assigned identifier or an |
Query parameters
Parameters | |
---|---|
announcementStates[] |
Restriction on the |
orderBy |
Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported field is |
pageSize |
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 |
The |
Request body
The request body must be empty.
Response body
Response when listing course work.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"announcements": [
{
object ( |
Fields | |
---|---|
announcements[] |
Announcement items that match the request. |
nextPageToken |
Token identifying the next page of results to return. If empty, no further results are available. |
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/classroom.announcements
https://www.googleapis.com/auth/classroom.announcements.readonly
For more information, see the Authorization guide.