Google 课堂插件现已面向开发者正式推出!如需了解详情,请参阅
插件文档。
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 。支持的方向关键字包括 asc 和 desc 。如果未指定,默认行为是 updateTime desc 。示例:updateTime asc 、updateTime
|
pageSize |
integer
要返回的最大项数。零或未指定表示服务器可能会分配上限。 服务器返回的结果数量可能少于指定数量。
|
pageToken |
string
上一次 list 调用返回的 nextPageToken 值,表示应返回后续的结果页。 否则,list 请求必须与生成此令牌的请求相同。
|
materialLink |
string
可选择过滤课程作业材料,其中至少有一个链接材料的网址与所提供的字符串部分匹配。
|
materialDriveId |
string
可选择过滤出至少有一个 ID 与所提供字符串匹配的 Google 云端硬盘材料的课业材料。如果还指定了 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
如需了解详情,请参阅授权指南。
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2025-07-25。
[null,null,["最后更新时间 (UTC):2025-07-25。"],[],[],null,["# Method: courses.courseWorkMaterials.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListCourseWorkMaterialResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nReturns a list of course work material that the requester is permitted to view.\n\nCourse students may only view `PUBLISHED` course work material. Course teachers and domain administrators may view all course work material.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for [access errors](/workspace/classroom/reference/Access.Errors).\n- `INVALID_ARGUMENT` if the request is malformed.\n- `NOT_FOUND` if the requested course does not exist.\n\n### HTTP request\n\n`GET https://classroom.googleapis.com/v1/courses/{courseId}/courseWorkMaterials`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `courseId` | `string` Identifier of the course. This identifier can be either the Classroom-assigned identifier or an [alias](/workspace/classroom/reference/rest/v1/courses.aliases#CourseAlias). |\n\n### Query parameters\n\n| Parameters ||\n|------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `courseWorkMaterialStates[]` | `enum (`[CourseWorkMaterialState](/workspace/classroom/reference/rest/v1/courses.courseWorkMaterials#CourseWorkMaterialState)`)` Restriction on the work status to return. Only course work material that matches is returned. If unspecified, items with a work status of `PUBLISHED` is returned. |\n| `orderBy` | `string` Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported field is `updateTime`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `updateTime asc`, `updateTime` |\n| `pageSize` | `integer` Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. |\n| `pageToken` | `string` [nextPageToken](/workspace/classroom/reference/rest/v1/courses.courseWorkMaterials/list#body.ListCourseWorkMaterialResponse.FIELDS.next_page_token) value returned from a previous `list` call, indicating that the subsequent page of results should be returned. The `list` request must be otherwise identical to the one that resulted in this token. |\n| `materialLink` | `string` Optional filtering for course work material with at least one link material whose URL partially matches the provided string. |\n| `materialDriveId` | `string` Optional filtering for course work material with at least one Drive material whose ID matches the provided string. If `materialLink` is also specified, course work material must have materials matching both filters. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse when listing course work material.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"courseWorkMaterial\": [ { object (/workspace/classroom/reference/rest/v1/courses.courseWorkMaterials#CourseWorkMaterial) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `courseWorkMaterial[]` | `object (`[CourseWorkMaterial](/workspace/classroom/reference/rest/v1/courses.courseWorkMaterials#CourseWorkMaterial)`)` Course work material items that match the request. |\n| `nextPageToken` | `string` Token identifying the next page of results to return. If empty, no further results are available. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/classroom.courseworkmaterials`\n- `\n https://www.googleapis.com/auth/classroom.courseworkmaterials.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]