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 によって割り当てられたこのコースの ID。

creating a course の場合は、必要に応じてリクエストでこの ID を 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 のパラメータとして指定する場合、このフィールドは必須です。ID は次のいずれかです。

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

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

string (Timestamp format)

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

読み取り専用です。

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

string (Timestamp format)

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

読み取り専用です。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
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 コースのステータスなし。返されたコース メッセージではこの値は使用されません。
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

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