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

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

リクエストの本文

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

レスポンスの本文

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

認可スコープ

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

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

詳細については、承認ガイドをご覧ください。