Method: courses.patch

更新課程中的一或多個欄位。

這個方法會傳回下列錯誤代碼：

  • PERMISSION_DENIED：要求的使用者不得修改要求的課程或存取錯誤。
  • 如果沒有具備要求 ID 的課程，則為 NOT_FOUND。
  • 如果更新遮罩中指定無效欄位，或是未提供更新遮罩，則為 INVALID_ARGUMENT。
  • FAILED_PRECONDITION 代表下列要求錯誤：
    • CourseNotModifiable
    • InactiveCourseOwner
    • IneligibleOwner

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
id

string

要更新課程的 ID。這個 ID 可以是 Classroom 指派的 ID 或 alias。

查詢參數

參數
updateMask

string (FieldMask format)

識別課程中要更新欄位的遮罩。此為必填欄位，才能進行更新。如果指定無效欄位，更新就會失敗。下列欄位有效：

  • name
  • section
  • descriptionHeading
  • description
  • room
  • courseState
  • ownerId

注意：系統會立即對 ownerId 修補程式生效，但在實際運作時，所有受影響資源的擁有權轉移程序可能需要一段時間才能完成。

在查詢參數中設定時，這個欄位應指定為

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

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

要求主體

要求主體包含 Course 的例項。

回應主體

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

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱授權指南。