Method: courses.announcements.list

返回允许请求者查看的公告列表。

课程学生只能查看 PUBLISHED 项通知。课程教师和网域管理员可以查看所有通知。

此方法会返回以下错误代码:

  • 如果发出请求的用户无权访问请求的课程或出现访问错误,则返回 PERMISSION_DENIED
  • 如果请求格式有误,则返回 INVALID_ARGUMENT
  • 如果请求的课程不存在,则返回 NOT_FOUND

HTTP 请求

GET https://classroom.googleapis.com/v1/courses/{courseId}/announcements

网址采用 gRPC 转码语法。

路径参数

参数
courseId

string

课程的标识符。此标识符可以是 Google 课堂分配的标识符,也可以是 alias

查询参数

参数
announcementStates[]

enum (AnnouncementState)

对返回的通知的 state 进行了限制。如果未指定此参数,则默认值为 PUBLISHED

orderBy

string

结果的可选排序顺序。以英文逗号分隔的字段列表,其中包含可选的排序方向关键字。支持的字段为 updateTime。支持的方向关键字为ascdesc。如果未指定,则默认行为为 updateTime desc。示例:updateTime ascupdateTime

pageSize

integer

要返回的项数上限。零或未指定表示服务器可以分配上限。

服务器返回的结果数可能会少于指定的数量。

pageToken

string

从上一个 list 调用返回的 nextPageToken 值,表示应返回下一页结果。

list 请求在其他方面必须与生成此令牌的请求相同。

请求正文

请求正文必须为空。

响应正文

列出课程作业时的响应。

如果成功,响应正文将包含结构如下的数据:

JSON 表示法
{
  "announcements": [
    {
      object (Announcement)
    }
  ],
  "nextPageToken": string
}
字段
announcements[]

object (Announcement)

与请求匹配的通知项。

nextPageToken

string

标识下一页要返回结果的令牌。如果为空,则没有更多结果。

授权范围

需要以下 OAuth 范围之一:

  • https://www.googleapis.com/auth/classroom.announcements
  • https://www.googleapis.com/auth/classroom.announcements.readonly

有关详情,请参阅授权指南