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
  • learningGoals

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

enum (PreviewVersion)

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

PREVIEW_VERSION_9001 には、次の新機能が含まれています。 * 資料の更新がサポートされています。資料を更新するには、updateMask「materials」を使用します。リクエストの CourseWorkMaterial オブジェクトで指定された資料のリストは、既存のリストを完全に置き換えます。資料フィールドをクリアするには、更新マスクで「materials」を指定し、CourseWorkMaterial オブジェクトで指定しないようにします。現時点では、公開された CourseWorkMaterial の更新は対象外です。

リクエストの本文

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

レスポンスの本文

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

認可スコープ

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

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

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