Method: courses.announcements.patch

更新通知的一个或多个字段。

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

  • 如果发出请求的开发者项目未创建相应的通知或存在访问错误，则为 PERMISSION_DENIED。
  • 如果请求格式有误，则返回 INVALID_ARGUMENT。
  • 如果请求的通知已被删除，则为 FAILED_PRECONDITION。
  • 如果请求的课程或通知不存在，则为 NOT_FOUND

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
courseId

string

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

string

通知的标识符。

查询参数

参数
updateMask

string (FieldMask format)

用于标识要更新的通知中的哪些字段的掩码。要进行更新，必须填写此字段。如果指定了无效字段，更新将失败。如果某个字段支持空值，则可以通过在更新掩码（而不是在 公告对象）中指定该字段来清除该字段。如果更新掩码中包含不支持空值的字段，且未在 公告对象中设置该字段，系统会返回 INVALID_ARGUMENT 错误。

教师可以指定以下字段：

  • text
  • state
  • scheduledTime

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

请求正文

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

响应正文

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

授权范围

需要以下 OAuth 作用域：

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

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