REST Resource: courses

リソース: コース

Classroom のコース。

JSON 表現 
{
  "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)
  }
}
フィールド
id

string

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

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

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

string

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

string

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

string

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

string

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

string

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

string

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

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

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

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

string (Timestamp format)

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

読み取り専用です。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
updateTime

string (Timestamp format)

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

読み取り専用です。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
enrollmentCode

string

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

読み取り専用です。
courseState

enum (CourseState)

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

string

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

読み取り専用です。
courseGroupEmail

string

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

読み取り専用です。
teacherFolder

object (DriveFolder)

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

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

読み取り専用です。
courseMaterialSets[]
(deprecated)

object (CourseMaterialSet)

このコースの [概要] ページに表示される教材のセット。

読み取り専用です。
guardiansEnabled

boolean

このコースで保護者宛の通知が有効になっているかどうか。

読み取り専用です。
calendarId

string

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

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

読み取り専用です。
gradebookSettings

object (GradebookSettings)

コースの生徒の総合成績の計算方法と、その成績を誰に表示するかを指定する成績表の設定。

読み取り専用

CourseState

コースが取り得る状態。

列挙型
COURSE_STATE_UNSPECIFIED コースの状態がありません。返される Course メッセージでこの値が使用されることはありません。
ACTIVE コースは有効です。
ARCHIVED コースはアーカイブされています。別の状態に変更する場合を除き、変更することはできません。
PROVISIONED コースは作成されていますが、まだ有効になっていません。この設定には、メインの教師とドメイン管理者がアクセスできます。これらのユーザーは、設定を変更したり、ACTIVE または DECLINED の状態に変更したりできます。コースを PROVISIONED に変更できるのは、コースが DECLINED 状態の場合のみです。
DECLINED コースは作成されましたが、承認されませんでした。コースの所有者とドメイン管理者はアクセスできますが、ウェブ UI には表示されません。コースは、PROVISIONED 状態に変更する場合を除き、変更できません。コースを DECLINED に変更できるのは、コースが PROVISIONED 状態の場合のみです。
SUSPENDED コースは一時停止されています。コースを変更することはできません。ownerId で識別されるユーザーのみがコースを表示できます。コースが利用規約に違反している可能性がある場合、この状態になることがあります。

CourseMaterialSet

コースの [概要] ページに表示される一連の教材。これらの資料には、シラバス、スケジュール、コース全体に関連するその他の背景情報が含まれる場合があります。

JSON 表現 
{
  "title": string,
  "materials": [
    {
      object (CourseMaterial)
    }
  ]
}
フィールド
title

string

このセットのタイトル。
materials[]

object (CourseMaterial)

このセットに添付された資料。

CourseMaterial

教材セットの一部としてコースに添付された教材。

JSON 表現 
{

  // 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.
}
フィールド
共用体フィールド material。マテリアル データ。material は次のいずれかになります。
driveFile

object (DriveFile)

Google ドライブのファイルを添付します。
youTubeVideo

object (YouTubeVideo)

YouTube 動画の添付。
form

object (Form)

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

GradebookSettings

コースの成績表の設定。詳しくは、ヘルプセンターの記事をご覧ください。

JSON 表現 
{
  "calculationType": enum (CalculationType),
  "displaySetting": enum (DisplaySetting),
  "gradeCategories": [
    {
      object (GradeCategory)
    }
  ]
}
フィールド
calculationType

enum (CalculationType)

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

enum (DisplaySetting)

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

object (GradeCategory)

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

CalculationType

総合成績の計算方法。

列挙型
CALCULATION_TYPE_UNSPECIFIED メソッドが指定されていません。これは返されません。
TOTAL_POINTS 総合成績は、カテゴリに関係なく、成績の合計を合計点の合計で割った値です。
WEIGHTED_CATEGORIES 総合成績はカテゴリ別の加重平均です。

DisplaySetting

総合成績の表示に関する設定。

列挙型
DISPLAY_SETTING_UNSPECIFIED 設定が指定されていません。これは返されません。
SHOW_OVERALL_GRADE 採点簿と生徒のプロフィールに総合成績が表示され、教師と生徒の両方が確認できます。
HIDE_OVERALL_GRADE 採点簿や生徒のプロフィールに総合成績が表示されません。
SHOW_TEACHERS_ONLY 採点簿と生徒のプロフィールで教師に総合成績が表示されます。生徒のプロフィールで生徒に表示されなくなります。

メソッド

checkAddOnCreationEligibility
(deprecated)

 ユーザーが特定のコースでアドオンの添付ファイルを作成できるかどうかを返します。

checkGradingPeriodsSetupEligibility
(deprecated)

 ユーザーが特定のコースで GradingPeriodSettings を更新できるかどうかを返します。

create

 コースを作成します。

delete

 コースを削除します。

get

 コースを返します。

getGradingPeriodSettings

 コースの採点期間の設定を返します。

list

 リクエストに一致するコースに限定して、リクエストしたユーザーが閲覧できるコースのリストを返します。

patch

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

update

 コースを更新します。

updateGradingPeriodSettings

 コースの採点期間の設定を更新します。