Method: courses.studentGroups.patch

更新學生群組中的一或多個欄位。

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

  • PERMISSION_DENIED 如果要求的使用者無權修改所要求的學生群組，或發生存取錯誤。
  • NOT_FOUND 如果學生群組不存在，或使用者沒有學生群組的存取權。
  • INVALID_ARGUMENT：如果更新遮罩中指定的欄位無效，或未提供更新遮罩，則傳回此值。

HTTP 要求

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

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

路徑參數

參數
courseId

string

必要欄位。課程的 ID。
id

string

必要欄位。學生群組的 ID。

查詢參數

參數
updateMask

string (FieldMask format)

必要欄位。遮罩，用於識別要更新的學生群組欄位。這是更新時的必填欄位。如果指定無效欄位，更新作業就會失敗。

老師可以指定下列欄位：

  • title

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

enum (PreviewVersion)

(選用步驟) 端點預覽版本。您必須設定這個值，才能存取開發人員預覽計畫中提供的新 API 功能。

要求主體

要求主體包含 StudentGroup 的例項。

回應主體

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

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱授權指南。