Method: courses.courseWork.patch

課題の 1 つ以上のフィールドを更新します。

更新可能なフィールドと更新可能なユーザーの詳細については、google.classroom.v1.CourseWork をご覧ください。

このリクエストは、対応する課題アイテムの作成に使用された OAuth クライアント ID の Developer Console プロジェクトから行う必要があります。

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

  • PERMISSION_DENIED: リクエスト元のデベロッパー プロジェクトが対応する課題を作成していない場合、ユーザーが生徒の提出物に対してリクエストされた変更を加えることが許可されていない場合、またはアクセス エラーの場合。
  • INVALID_ARGUMENT: リクエストの形式が正しくない場合。
  • FAILED_PRECONDITION: リクエストされた課題がすでに削除されている場合。
  • リクエストされたコースまたはコースワークが存在しない場合: NOT_FOUND

HTTP リクエスト

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

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

パスパラメータ

パラメータ
courseId

string

コースの識別子。この識別子は、Classroom で割り当てられた識別子または alias のいずれかです。
id

string

コースの課題の識別子。

クエリ パラメータ

パラメータ
updateMask

string (FieldMask format)

課題のどのフィールドを更新するかを特定するマスク。このフィールドは更新を行う際に必須です。無効なフィールドが指定されている場合、更新は失敗します。フィールドが空の値をサポートしている場合は、CourseWork オブジェクトではなく更新マスクで指定することで、そのフィールドを消去できます。空の値をサポートしていないフィールドが更新マスクに含まれ、CourseWork オブジェクトに設定されていない場合、INVALID_ARGUMENT エラーが返されます。

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

  • title
  • description
  • state
  • dueDate
  • dueTime
  • maxPoints
  • scheduledTime
  • submissionModificationMode
  • topicId
  • gradingPeriodId V1_20240401_PREVIEW 以降で利用可能。

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

enum (PreviewVersion)

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

リクエスト本文

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

レスポンスの本文

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

認可スコープ

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

  • https://www.googleapis.com/auth/classroom.coursework.students

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