Method: courses.courseWorkMaterials.patch

コースの教材の 1 つ以上のフィールドを更新します。

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

  • PERMISSION_DENIED: アクセスエラーをリクエストしているデベロッパー プロジェクトの場合。
  • INVALID_ARGUMENT: リクエストの形式が正しくない場合。
  • FAILED_PRECONDITION: リクエストされたコースの教材がすでに削除されている場合。
  • リクエストされたコースまたはコース教材が存在しない場合は NOT_FOUND

HTTP リクエスト

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

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

パスパラメータ

パラメータ
courseId

string

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

string

コースの教材の識別子。

クエリ パラメータ

パラメータ
updateMask

string (FieldMask format)

更新するコース教材のフィールドを識別するマスク。このフィールドは更新に必要です。無効なフィールドを指定すると更新が失敗します。フィールドが空の値に対応している場合は、コースの教材オブジェクトではなく更新マスクで指定することで、その値を消去できます。空の値に対応していないフィールドが更新マスクに含まれ、コース教材オブジェクトに設定されていない場合は、INVALID_ARGUMENT エラーが返されます。

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

  • title
  • description
  • state
  • scheduledTime
  • topicId

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

リクエストの本文

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

レスポンスの本文

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

認可スコープ

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

  • https://www.googleapis.com/auth/classroom.courseworkmaterials

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