Method: courses.courseWorkMaterials.patch

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

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

  • 如果请求访问权限的开发者项目存在 访问错误，则返回 PERMISSION_DENIED。
  • 如果请求格式有误，则返回 INVALID_ARGUMENT。
  • 如果请求的课程作业材料已被删除，则返回 FAILED_PRECONDITION。
  • 如果请求的课程或课程作业材料不存在，则返回 NOT_FOUND

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
courseId

string

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

string

课程作业材料的标识符。

查询参数

参数
updateMask

string (FieldMask format)

用于标识要更新的课程作业材料字段的掩码。此字段是执行更新所必需的。如果指定了无效字段，更新会失败。如果某个字段支持空值，则可以通过在更新掩码中指定该字段，但不在课程作业材料对象中指定该字段来清除该字段。如果更新掩码中包含不支持空值的字段，但未在课程作业材料对象中设置该字段，则会返回 INVALID_ARGUMENT 错误。

教师可以指定以下字段：

  • title
  • description
  • state
  • scheduledTime
  • topicId

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

enum (PreviewVersion)

可选。端点的预览版本。

PREVIEW_VERSION_9001 包含新功能： * 支持更新材料。如需更新材料，请使用 updateMask“materials”。请求的 CourseWorkMaterial 对象中提供的材料列表将完全替换现有列表。可以通过在更新掩码中指定“materials”，但不在 CourseWorkMaterial 对象中指定“materials”来清除材料字段。目前不支持更新 PUBLISHED CourseWorkMaterial。

请求正文

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

响应正文

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

授权范围

需要以下 OAuth 范围：

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

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