Method: courses.courseWork.patch

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

更新できるフィールドと、それらを変更できるユーザーの詳細については、google.classroom.v1.CourseWork をご覧ください。

このリクエストは、対応する課題アイテムまたは対応する課題アイテムのアドオン添付ファイルの作成に使用された OAuth クライアント ID のデベロッパー コンソール プロジェクトによって行われる必要があります。

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

  • リクエスト元のデベロッパー プロジェクトが対応する課題を作成していない場合、対応する課題にアドオンの添付ファイルがない場合、ユーザーがリクエストされた生徒の提出物に対する変更を許可されていない場合、またはアクセス エラーが発生した場合に 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
  • learningGoals

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

enum (PreviewVersion)

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

リクエストの本文

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

レスポンスの本文

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

認可スコープ

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

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

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