Method: courses.patch

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

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

  • 如果请求的用户无权修改请求的课程，或者出现访问权限错误，则返回 PERMISSION_DENIED。
  • 如果不存在具有请求 ID 的课程，则返回 NOT_FOUND。
  • 如果在更新掩码中指定了无效字段或未提供更新掩码，则使用 INVALID_ARGUMENT。
  • FAILED_PRECONDITION 出现以下请求错误：
    • CourseNotModifiable
    • InactiveCourseOwner
    • IneligibleOwner

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
id

string

要更新的课程的标识符。此标识符可以是 Google 课堂分配的标识符，也可以是 alias。

查询参数

参数
updateMask

string (FieldMask format)

用于标识要更新的课程字段的掩码。若要进行更新，必须填写此字段。如果指定无效字段，更新将会失败。以下字段有效：

  • name
  • section
  • descriptionHeading
  • description
  • room
  • courseState
  • ownerId

注意：对 ownerId 的补丁会被视为立即生效，但在实践中，所有受影响资源的所有权转移可能需要一些时间才能完成。

在查询参数中设置此字段时，应将其指定为

updateMask=<field1>,<field2>,...

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

请求正文

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

响应正文

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

授权范围

需要以下 OAuth 范围：

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

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