Method: courses.patch

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

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

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
id

string

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

クエリ パラメータ

パラメータ
updateMask

string (FieldMask format)

更新するコースのフィールドを識別するマスク。更新を行うには、このフィールドが必要です。無効なフィールドが指定されている場合、更新は失敗します。有効なフィールドは次のとおりです。

  • courseState
  • description
  • descriptionHeading
  • name
  • ownerId
  • room
  • section
  • subject
  • learningStandardSettings
  • levels

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

クエリ パラメータで設定する場合、このフィールドは

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

完全修飾フィールド名のカンマ区切りリストとして指定する必要があります。例: "user.displayName,photo"。
previewVersion

enum (PreviewVersion)

省略可。API のプレビュー バージョン。プレビュー プログラムでデベロッパーが利用できる新しい API 機能にアクセスするには、これを設定する必要があります。

リクエストの本文

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

レスポンスの本文

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

認可スコープ

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

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

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