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)

对要返回的工作状态的限制。系统只会返回匹配的课程作业。如果未指定，则返回工作状态为 PUBLISHED 的项。
orderBy

string

结果的可选排序顺序。字段的逗号分隔列表，其中包含可选的排序方向关键字。支持的字段为 updateTime 和 dueDate。支持的方向关键字包括 asc 和 desc。如果未指定，默认行为是 updateTime desc。示例：dueDate asc,updateTime desc、updateTime,dueDate desc
pageSize

integer

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

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

string

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

否则，list 请求必须与生成此令牌的请求相同。
previewVersion

enum (PreviewVersion)

可选。API 的预览版。必须设置此属性，才能使用预览版计划中向开发者提供的新 API 功能。

请求正文

请求正文必须为空。

响应正文

列出课程作业时的响应。

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

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

如需了解详情，请参阅授权指南。