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

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