Method: courses.patch

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

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

  • PERMISSION_DENIED: リクエスト元のユーザーがリクエストされたコースの変更を許可されていない場合、またはアクセスエラーのため。
  • NOT_FOUND: リクエストされた ID のコースが存在しない場合。
  • 更新マスクに無効なフィールドが指定されている場合、または更新マスクが指定されていない場合は INVALID_ARGUMENT。
  • 次のリクエスト エラーの場合は FAILED_PRECONDITION。
    • CourseNotModifiable
    • InactiveCourseOwner
    • IneligibleOwner

HTTP リクエスト

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

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

パスパラメータ

パラメータ
id

string

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

クエリ パラメータ

パラメータ
updateMask

string (FieldMask format)

コースのどのフィールドを更新するかを識別するマスク。このフィールドは更新に必要です。無効なフィールドを指定すると更新が失敗します。有効なフィールドは次のとおりです。

  • name
  • section
  • descriptionHeading
  • description
  • room
  • courseState
  • ownerId

注: ownerId に対するパッチはすぐに有効になりますが、実際には、影響を受けるすべてのリソースのオーナー権限の譲渡が完了するまでに時間がかかることがあります。

クエリ パラメータで設定する場合、このフィールドは次のように指定します。

updateMask=<field1>,<field2>,...

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

リクエストの本文

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

レスポンスの本文

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

認可スコープ

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

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

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