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

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