REST Resource: courses

リソース: Course

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)
  },
  "subject": string,
  "learningStandardSettings": {
    object (CourseLearningStandardSettings)
  },
  "levels": string
}
フィールド
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

説明の見出し（省略可）。たとえば、「高校 1 年生の生物学へようこそ」などとします。このフィールドを設定する場合は、有効な 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)

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

読み取り専用です。
subject

string

省略可。コースの科目。
learningStandardSettings

object (CourseLearningStandardSettings)

省略可。

コースで利用可能な学習基準に関連する設定。コースに割り当てることができる学習基準セットのルートは 20 個までです。
levels

string

省略可。コースのレベル。例: 「9 年生」、「中学校」、「4 ～ 5 年生」、「K-2」、「3000」。このフィールドを設定する場合は、有効な UTF-8 文字列で、1, 000 文字未満にする必要があります。

このフィールドは、courses.patch メソッドを使用してのみクリアできます。

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 表現 
{

  "driveFile": {
    object (DriveFile)
  },
  "youTubeVideo": {
    object (YouTubeVideo)
  },
  "link": {
    object (Link)
  },
  "form": {
    object (Form)
  }
}
フィールド
マテリアル データ。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
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 採点簿と生徒のプロフィールに総合成績が表示されます。生徒のプロフィールで生徒に表示されないようにします。

CourseLearningStandardSettings

コースの学習基準の設定。

JSON 表現 
{
  "standardSets": [
    {
      object (LearningStandardSetRoot)
    }
  ]
}
フィールド
standardSets[]

object (LearningStandardSetRoot)

必須。このコースに適用される学習基準ルートのセット。

LearningStandardSetRoot

選択した学習基準セットのルートを表します。選択したルートの子孫は、Classroom UI でストリーム アイテムに学習目標を設定する際に表示されます。

JSON 表現 
{
  "caseGuid": {
    object (CaseGuid)
  },
  "documentTitle": string,
  "standardTitle": string,
  "sourceDataAvailabilityStatus": enum (LearningStandardAvailabilityState)
}
フィールド
caseGuid

object (CaseGuid)

必須。学習基準セットのルートの Satchel Rosetta Exchange GUID。
documentTitle

string

出力専用。学習基準セットのルートのドキュメント タイトル。
standardTitle

string

出力専用。学習基準セットのルートのタイトル。
sourceDataAvailabilityStatus

enum (LearningStandardAvailabilityState)

出力専用。学習基準セットのルートの在庫状況。これを使用して、学習基準セットのルートがソースから削除されたかどうかを判断します。

メソッド

checkAddOnCreationEligibility
(deprecated)

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

checkGradingPeriodsSetupEligibility
(deprecated)

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

create

 コースを作成します。

delete

 コースを削除します。

get

 コースを返します。

getGradingPeriodSettings

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

list

 リクエスト元のユーザーが閲覧を許可されているコースのリストを返します。リクエストに一致するコースのみが返されます。

patch

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

update

 コースを更新します。

updateGradingPeriodSettings

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