Method: courses.updateGradingPeriodSettings

更新课程的评分周期设置。

提出请求的用户和课程所有者必须符合修改评分周期的条件。如需了解详情，请参阅许可要求。

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

  • 如果发出请求的用户无权修改课程中的评分周期设置或出现访问错误，则使用 PERMISSION_DENIED：
    • UserIneligibleToUpdateGradingPeriodSettings
  • 如果请求格式有误，则返回 INVALID_ARGUMENT。
  • 如果请求的课程不存在，则返回 NOT_FOUND。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
courseId

string

必需。课程的标识符。

查询参数

参数
updateMask

string (FieldMask format)

用于标识要更新的 GradingPeriodSettings 中的字段的掩码。

GradingPeriodSettings gradingPeriods 列表将完全替换为更新请求中指定的评分周期。例如：

  • 列表中包含的没有 ID 的评分周期会被视为新增评分周期，并且系统会在用户提出申请后分配新的评分周期。
  • 当前存在但在申请中缺失的评分周期将被视为删除。
  • 系统会将已有 ID 和修改数据的评分周期视为修改。未经修改的数据将保持不变。
  • 如果评分周期包含未知 ID，则会导致错误。

可指定以下字段：

  • gradingPeriods
  • applyToExistingCoursework

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

enum (PreviewVersion)

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

请求正文

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

响应正文

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

授权范围

需要以下 OAuth 范围：

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

有关详情，请参阅授权指南。