GOgoogle
courses

GET /v1/courses/{courseId}/announcements

Changed on

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.

Request

  • Base URL
    https://classroom.googleapis.com
  • URL
    https://classroom.googleapis.com/v1/courses/{courseId}/announcements
  • Auth
    • OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/classroom.announcements
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/classroom.announcements
    • or OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/classroom.announcements.readonly
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/classroom.announcements.readonly

Path parameters

courseIdstring required

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

Query parameters

announcementStatesstring[]

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

orderBystring

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

pageSizeinteger

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.

pageTokenstring

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.

Response

Successful response

nextPageTokenstring

Token identifying the next page of results to return. If empty, no further results are available.

Changes

  • d9e82ce809f1Revision changes
    • info

      the security scope https://www.googleapis.com/auth/classroom.announcements was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/classroom.announcements was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/classroom.announcements.readonly was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/classroom.announcements.readonly was removed from the endpoint's security scheme Oauth2c

  • 8575901d0ec9Revision changes
    • info

      the security scope https://www.googleapis.com/auth/classroom.announcements was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/classroom.announcements was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/classroom.announcements.readonly was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/classroom.announcements.readonly was removed from the endpoint's security scheme Oauth2c