Method: courses.courseWork.list

返回请求者可以查看的课程作业列表。

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

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

  • 如果发出请求的用户无权访问所请求的课程或存在访问错误，则为 PERMISSION_DENIED；
  • 如果请求格式不正确，则为 INVALID_ARGUMENT。
  • 如果所请求的课程不存在，则为 NOT_FOUND。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
courseId

string

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

查询参数

参数
courseWorkStates[]

enum (CourseWorkState)

对要返回的工作状态的限制。系统仅返回匹配的 courseWork。如果未指定，则返回工作状态为 PUBLISHED 的项。
orderBy

string

（可选）结果排序顺序。以英文逗号分隔的字段列表，带有可选的排序方向关键字。支持的字段包括 updateTime 和 dueDate。支持的方向关键字为 asc 和 desc。如果未指定，则默认行为为 updateTime desc。示例：dueDate asc,updateTime desc、updateTime,dueDate desc
pageSize

integer

要返回的最大项数。零或未指定，表示服务器可以分配最大值。

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

string

nextPageToken 值从上一个 list 调用返回，表示应返回后续页面结果。

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

请求正文

请求正文必须为空。

响应正文

列出课程作业时的响应。

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

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

object (CourseWork)

与请求匹配的课程作业项。
nextPageToken

string

标识要返回的下一页结果的令牌。如果为空，表示没有进一步的结果。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/classroom.coursework.students.readonly
  • https://www.googleapis.com/auth/classroom.coursework.me.readonly
  • https://www.googleapis.com/auth/classroom.coursework.students
  • https://www.googleapis.com/auth/classroom.coursework.me

有关详情，请参阅授权指南。