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

課程的 ID。這個 ID 可以是 Classroom 指派的 ID 或 alias。
id

string

公告的 ID。

查詢參數

參數
updateMask

string (FieldMask format)

識別公告中要更新欄位的遮罩。此為必填欄位，才能進行更新。如果指定無效欄位，更新就會失敗。如果欄位支援空白值，只要在更新遮罩 (而非 公告 物件) 中指定此欄位即可清除。如果更新遮罩中包含不支援空白值的欄位，且該欄位沒有在 公告物件中設定，則會傳回 INVALID_ARGUMENT 錯誤。

以下欄位可由老師指定：

  • text
  • state
  • scheduledTime

此為以半形逗號分隔的完整欄位名稱清單。範例："user.displayName,photo"。

要求主體

要求主體包含 Announcement 的例項。

回應主體

如果成功，回應主體會包含 Announcement 的執行例項。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱授權指南。