Method: courses.studentGroups.patch

更新学生群组中的一个或多个字段。

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

  • 如果请求用户无权修改所请求的学生群组，或者存在访问错误，则返回 PERMISSION_DENIED。
  • NOT_FOUND 如果学生群组不存在或用户无权访问学生群组。
  • 如果更新掩码中指定了无效字段，或者未提供更新掩码，则使用 INVALID_ARGUMENT。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
courseId

string

必需。课程的标识符。
id

string

必需。学生群组的标识符。

查询参数

参数
updateMask

string (FieldMask format)

必需。用于标识要更新的学生群组字段的掩码。此字段是执行更新所必需的。如果指定了无效字段，更新会失败。

教师可以指定以下字段：

  • title

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

enum (PreviewVersion)

可选。端点预览版本。必须设置此标志，才能访问预览版计划中向开发者提供的新 API 功能。

请求正文

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

响应正文

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

授权范围

需要以下 OAuth 范围：

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

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