REST Resource: courses

{
  "id": string,
  "name": string,
  "section": string,
  "descriptionHeading": string,
  "description": string,
  "room": string,
  "ownerId": string,
  "creationTime": string,
  "updateTime": string,
  "enrollmentCode": string,
  "courseState": enum (CourseState),
  "alternateLink": string,
  "teacherGroupEmail": string,
  "courseGroupEmail": string,
  "teacherFolder": {
    object (DriveFolder)
  },
  "courseMaterialSets": [
    {
      object (CourseMaterialSet)
    }
  ],
  "guardiansEnabled": boolean,
  "calendarId": string,
  "gradebookSettings": {
    object (GradebookSettings)
  }
}

string

Classroom によって割り当てられたこのコースの ID。

creating a course の場合は、必要に応じてリクエストでこの ID を alias string に設定して、対応するエイリアスを作成できます。id は引き続き Classroom によって割り当てられ、コースの作成後に更新することはできません。

コースの更新マスクでこのフィールドを指定すると、エラーが発生します。

string

コースの名前。例: 「10 年生生物」名前は必須です。1 ～ 750 文字で、有効な UTF-8 文字列を指定する必要があります。

string

コースのセクション。例: "Period 2"設定する場合、このフィールドは 2, 800 文字以下の有効な UTF-8 文字列にする必要があります。

string

説明の見出し（省略可）。たとえば、「10 年生生物学へようこそ」などです。設定する場合は、有効な UTF-8 文字列で、3, 600 文字以下にする必要があります。

string

説明（省略可）。たとえば、「教科書、ゲスト講義、ラボ作業を組み合わせて、生物の構造について学んでいきます。楽しみにしていてください。」設定する場合は、このフィールドは有効な UTF-8 文字列で、30,000 文字以下にする必要があります。

string

部屋の場所（省略可）。例: 「301」。設定する場合は、このフィールドを有効な UTF-8 文字列にし、650 文字以下にする必要があります。

string

コースのオーナーの識別子。

create course request のパラメータとして指定する場合、このフィールドは必須です。ID は次のいずれかです。

• ユーザーの数値識別子
• ユーザーのメールアドレス
• リクエスト元のユーザーを示す文字列リテラル "me"

これは作成リクエストで設定する必要があります。管理者は、patch course request でこのフィールドを指定してオーナー権限を譲渡することもできます。他のコンテキストでは読み取り専用です。

string (Timestamp format)

コースの作成日時。コースの更新マスクでこのフィールドを指定すると、エラーが発生します。

読み取り専用です。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。

string (Timestamp format)

このコースの最新の更新日時。コースの更新マスクでこのフィールドを指定すると、エラーが発生します。

読み取り専用です。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。

string

このコースに参加する際に使用する登録コード。コースの更新マスクでこのフィールドを指定すると、エラーが発生します。

読み取り専用です。

enum (CourseState)

コースの状態。指定しない場合、デフォルトの状態は PROVISIONED です。

string

Classroom ウェブ UI のこのコースへの絶対リンク。

読み取り専用です。

string

コースのすべての教師が含まれる Google グループのメールアドレス。このグループはメールを受け入れず、権限にのみ使用できます。

読み取り専用です。

string

コースのすべてのメンバーを含む Google グループのメールアドレス。このグループはメールを受け入れず、権限にのみ使用できます。

読み取り専用です。

object (DriveFolder)

コースのすべての教師と共有されるドライブ フォルダに関する情報。

このフィールドは、コースの教師とドメイン管理者に対してのみ設定されます。

読み取り専用です。

object (CourseMaterialSet)

このコースの [概要] ページに表示される一連の資料。

読み取り専用です。

boolean

このコースで保護者への通知が有効かどうか。

読み取り専用です。

string

すべてのコース メンバーが閲覧できるカレンダーのカレンダー ID。Classroom は、コースの課題やお知らせの予定をこのカレンダーに追加します。

コースのカレンダーは、コースが初めて CourseState.ACTIVE に設定されたときに非同期で作成されます（作成時、または UI または API を介して ACTIVE に更新されたとき）。作成プロセスが完了するまで、カレンダー ID は入力されません。

読み取り専用です。

object (GradebookSettings)

採点簿の設定では、コースにおける生徒の総合成績をどのように計算し、誰に表示するかを指定します。

読み取り専用

{
  "title": string,
  "materials": [
    {
      object (CourseMaterial)
    }
  ]
}

string

このセットのタイトル。

object (CourseMaterial)

このセットに関連付けられた資料。

{

  // Union field material can be only one of the following:
  "driveFile": {
    object (DriveFile)
  },
  "youTubeVideo": {
    object (YouTubeVideo)
  },
  "link": {
    object (Link)
  },
  "form": {
    object (Form)
  }
  // End of list of possible types for union field material.
}

object (DriveFile)

Google ドライブのファイル添付。

object (YouTubeVideo)

YouTube 動画の添付。

object (Link)

リンクの添付。

object (Form)

Google フォームの添付ファイル。

{
  "calculationType": enum (CalculationType),
  "displaySetting": enum (DisplaySetting),
  "gradeCategories": [
    {
      object (GradeCategory)
    }
  ]
}

enum (CalculationType)

総合成績の計算方法を示します。

enum (DisplaySetting)

総合成績を表示できるユーザーを示します。

object (GradeCategory)

コースのコースワークに使用できる成績のカテゴリ。