Method: courses.announcements.list

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 Google API HTTP annotation syntax.

Path parameters

Parameters
courseId

string

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

Query parameters

Parameters
announcementStates

enum(AnnouncementState)

Restriction on the state of announcements returned. If this argument is left unspecified, the default value is PUBLISHED.

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

number

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][google.classroom.v1.Work.ListAnnouncementsAction] call, indicating that the subsequent page of results should be returned.

The [list][google.classroom.v1.Work.ListAnnouncementsAction] request must be otherwise identical to the one that resulted in this token.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response when listing course work.

JSON representation
{
  "announcements": [
    {
      object(Announcement)
    }
  ],
  "nextPageToken": string
}
Fields
announcements[]

object(Announcement)

Announcement items that match the request.

nextPageToken

string

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 OAuth 2.0 Overview.

Try it!

发送以下问题的反馈:

此网页
Classroom API
Classroom API
需要帮助?请访问我们的支持页面