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"。
previewVersion

enum (PreviewVersion)

省略可。エンドポイントのプレビュー バージョン。

PREVIEW_VERSION_9001 には新機能が含まれています。* マテリアルの更新がサポートされています。マテリアルを更新するには、updateMask「materials」を使用します。リクエストの CourseWorkMaterial オブジェクトで指定されたマテリアルのリストは、既存のリストを完全に置き換えます。更新マスクで「materials」を指定し、CourseWorkMaterial オブジェクトで指定しないことで、materials フィールドをクリアできます。現時点では、PUBLISHED CourseWorkMaterial の更新はサポートされていません。

リクエストの本文

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

レスポンスの本文

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

認可スコープ

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

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

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