Method: courses.courseWorkMaterials.list

返回允许请求者查看的课程作业资料列表。

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

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

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

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
courseId

string

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

查询参数

参数
courseWorkMaterialStates[]

enum (CourseWorkMaterialState)

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

orderBy

string

结果的可选排序顺序。带有可选排序方向关键字的字段逗号分隔列表。支持的字段为 updateTime。支持的路线关键字为 ascdesc。如果未指定,则默认行为为 updateTime desc。示例:updateTime ascupdateTime

pageSize

integer

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

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

pageToken

string

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

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

materialDriveId

string

(可选)过滤课程作业资料,其中至少有一项云端硬盘资料的 ID 与所提供的字符串相匹配。如果还指定了 materialLink,则课程作业资料必须具有与这两个过滤条件都匹配的资料。

请求正文

请求正文必须为空。

响应正文

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

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

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

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