Method: courses.studentGroups.patch

生徒グループの 1 つ以上のフィールドを更新します。

このメソッドは、次のエラーコードを返します。

  • リクエストしたユーザーがリクエストされた生徒グループの変更を許可されていない場合、またはアクセス エラーが発生した場合に PERMISSION_DENIED。
  • 生徒グループが存在しない場合、またはユーザーが生徒グループにアクセスできない場合は NOT_FOUND。
  • INVALID_ARGUMENT。更新マスクに無効なフィールドが指定されている場合、または更新マスクが指定されていない場合。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
courseId

string

必須。コースの識別子。
id

string

必須。生徒グループの識別子。

クエリ パラメータ

パラメータ
updateMask

string (FieldMask format)

必須。更新する生徒グループのフィールドを特定するマスク。このフィールドは更新を行うために必要です。無効なフィールドが指定されている場合、更新は失敗します。

教師は次のフィールドを指定できます。

  • title

完全修飾フィールド名のカンマ区切りリスト。例: "user.displayName,photo"。
previewVersion

enum (PreviewVersion)

省略可。エンドポイントのプレビュー バージョン。プレビュー プログラムでデベロッパーが利用できる新しい API 機能にアクセスするには、この設定を行う必要があります。

リクエストの本文

リクエストの本文には StudentGroup のインスタンスが含まれます。

レスポンスの本文

成功した場合、レスポンスの本文には StudentGroup のインスタンスが含まれます。

認可スコープ

次の OAuth スコープが必要です。

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

詳しくは、承認ガイドをご覧ください。