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

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