Method: courses.courseWork.patch

更新课程作业的一个或多个字段。

如需详细了解哪些字段可能会更新,以及哪些人可以更改这些字段,请参阅 google.classroom.v1.CourseWork

此请求必须由用于创建相应课程作业项的 OAuth 客户端 ID 的 Developer Console 项目发出。

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

  • 如果发出请求的开发者项目没有创建相应的课程作业、用户无权对学生提交的作业进行所请求的修改,或者出现访问错误,则为 PERMISSION_DENIED
  • 如果请求格式有误,则返回 INVALID_ARGUMENT
  • 如果请求的课程作业已被删除,则为 FAILED_PRECONDITION
  • 如果请求的课程或课程作业不存在,则返回 NOT_FOUND

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
courseId

string

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

id

string

课程作业的标识符。

查询参数

参数
updateMask

string (FieldMask format)

用于标识课程中需要更新哪些字段的掩码。必须填写此字段才能进行更新。如果指定了无效字段,更新将失败。如果某个字段支持空值,则可以通过在更新掩码(而不是 CourseWork 对象)中指定该字段来将其清除。如果更新掩码中包含不支持空值的字段,但未在 CourseWork 对象中设置此字段,则系统会返回 INVALID_ARGUMENT 错误。

教师可以指定以下字段:

  • title
  • description
  • state
  • dueDate
  • dueTime
  • maxPoints
  • scheduledTime
  • submissionModificationMode
  • topicId
  • gradingPeriodIdV1_20240401_PREVIEW 及更高版本中提供。

这是完全限定字段名称的逗号分隔列表。示例:"user.displayName,photo"

previewVersion

enum (PreviewVersion)

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

请求正文

请求正文包含一个 CourseWork 实例。

响应正文

如果成功,则响应正文包含一个 CourseWork 实例。

授权范围

需要以下 OAuth 范围:

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

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