Method: courses.courseWorkMaterials.list

返回请求者有权查看的课程作业材料列表。

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

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

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

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
courseId

string

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

查询参数

参数
courseWorkMaterialStates[]

enum (CourseWorkMaterialState)

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

string

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

integer

要返回的最大项数。如果为零或未指定，则表示服务器可能会分配一个上限。

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

string

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

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

string

（可选）过滤条件，用于过滤至少包含一个 Google 云端硬盘材料的课程作业材料，且该材料的 ID 与提供的字符串匹配。如果还指定了 materialLink，则课程作业材料必须包含与这两个过滤条件都匹配的材料。
previewVersion

enum (PreviewVersion)

可选。API 的预览版。您必须设置此值，才能访问试用计划中向开发者提供的新 API 功能。

请求正文

请求正文必须为空。

响应正文

列出课程作业材料时的响应。

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

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

object (CourseWorkMaterial)

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

string

用于标识要返回的下一页结果的令牌。如果为空，则表示没有更多结果。

授权范围

需要以下 OAuth 范围之一：

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

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