Method: courses.patch

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

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

  • 如果请求的用户无法修改所请求的课程,或者因访问错误而无权修改,则为 PERMISSION_DENIED
  • 如果不存在具有所请求 ID 的课程,则为 NOT_FOUND
  • 如果更新掩码中指定了无效字段,或者未提供更新掩码,则为 INVALID_ARGUMENT
  • FAILED_PRECONDITION(对于以下请求错误):
    • 课程无法剪辑
    • 无效课程所有者
    • 不符合条件的所有者

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

注意:所有者所有者的补丁被视为立即生效,但实际上,所有受影响的资源的所有权转移可能需要一段时间才能完成。

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

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

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

请求正文

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

响应正文

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

授权范围

需要以下 OAuth 作用域:

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

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