Method: courses.topics.patch

更新主題的一或多個欄位。

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

  • PERMISSION_DENIED 表示提出要求的開發人員專案並未建立對應的主題,或存取錯誤
  • 如果要求格式錯誤,則為 INVALID_ARGUMENT
  • NOT_FOUND:如果要求的課程或主題不存在

HTTP 要求

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

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

路徑參數

參數
courseId

string

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

id

string

主題的 ID,

查詢參數

參數
updateMask

string (FieldMask format)

這個遮罩可識別主題中要更新的欄位。此為必填欄位,才能進行更新。如果指定無效欄位,更新就會失敗。如果欄位支援空白值,只要在更新遮罩中指定空白值,即可在「主題」物件 (而非「主題」物件) 中指定該欄位。如果更新遮罩中的欄位不支援空白值,且未在「主題」物件中設定,系統會傳回 INVALID_ARGUMENT 錯誤。

可指定的欄位如下:

  • name

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

要求主體

要求主體包含 Topic 的例項。

回應主體

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

授權範圍

需要下列 OAuth 範圍:

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

詳情請參閱授權指南