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

コースワーク マテリアルの ID。

クエリ パラメータ

パラメータ
updateMask

string (FieldMask format)

コースワーク マテリアルのどのフィールドを更新するかを特定するマスク。このフィールドは更新を行う際に必須です。無効なフィールドが指定されている場合、更新は失敗します。フィールドが空の値をサポートしている場合は、コースワーク マテリアル オブジェクトではなく更新マスクで指定することで、そのフィールドを消去できます。空の値をサポートしていないフィールドが更新マスクに含まれ、コースワーク マテリアル オブジェクトに設定されていない場合、INVALID_ARGUMENT エラーが返されます。

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

  • title
  • description
  • state
  • scheduledTime
  • topicId

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

リクエストの本文

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

レスポンスの本文

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

認可スコープ

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

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

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