Method: courses.courseWorkMaterials.patch

更新一或多個課程作業資料欄位。

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

  • PERMISSION_DENIED 如果要求存取權的開發人員專案發生存取錯誤。
  • 如果要求格式有誤，則為 INVALID_ARGUMENT。
  • FAILED_PRECONDITION 如果要求的課程作業資料已遭刪除。
  • 如果要求的課程或課程作業教材不存在，則為 NOT_FOUND

HTTP 要求

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

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

路徑參數

參數
courseId

string

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

string

課程作業教材的 ID。

查詢參數

參數
updateMask

string (FieldMask format)

遮罩，用於識別要更新的教材欄位。這是更新時的必填欄位。如果指定無效欄位，更新就會失敗。如果欄位支援空值，只要在更新遮罩中指定該欄位，但不要在課程作業教材物件中指定，即可清除該欄位。如果更新遮罩中包含不支援空值的欄位，且未在課程作業教材物件中設定，系統會傳回 INVALID_ARGUMENT 錯誤。

老師可以指定下列欄位：

  • title
  • description
  • state
  • scheduledTime
  • topicId

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

enum (PreviewVersion)

(選用步驟) 端點的預覽版本。

PREVIEW_VERSION_9001 包含新功能：* 支援更新材質。如要更新教材，請使用 updateMask「materials」。要求 CourseWorkMaterial 物件中提供的素材清單，將完全取代現有清單。如要清除材料欄位，請在更新遮罩中指定「materials」，但不要在 CourseWorkMaterial 物件中指定。目前不支援更新「已發布」CourseWorkMaterial狀態。

要求主體

要求主體包含 CourseWorkMaterial 的例項。

回應主體

如果成功，回應主體會包含 CourseWorkMaterial 的執行個體。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱授權指南。