ユーザーが Classroom と Google Meet を使用している場合は、Google Meet コースの生徒の出席状況を確認する Apps Script クイックスタートをご覧ください。

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」 設定する場合、このフィールドは、650 文字以下の有効な UTF-8 文字列にする必要があります。

ownerId

string

コースのオーナーの ID。

create course request のパラメータとして指定すると、このフィールドは必須です。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 でコースの課題とお知らせの予定が追加されます。

読み取り専用です。

gradebookSettings

object (GradebookSettings)

コースでの生徒の総合成績の計算方法と、採点の対象となる生徒を指定する採点 book の設定。

読み取り専用

コース状態

コースが取り得るステータスです。

列挙型
COURSE_STATE_UNSPECIFIED コースの状態はありません。返されたコース メッセージではこの値は使用されません。
ACTIVE コースは有効です。
ARCHIVED コースはアーカイブされました。これを別の状態に変更する以外変更できません。
PROVISIONED コースは作成されましたが、まだ有効になっていません。主担任とドメイン管理者は、これらのリソースを変更したり、ACTIVEDECLINED の状態に変更したりできます。コースのステータスが DECLINED の場合に限り、PROVISIONED に変更できます。
DECLINED コースは作成されましたが、辞退されました。ウェブ UI には表示されないものの、コースのオーナーとドメイン管理者はアクセスすることができます。コースのステータスを PROVISIONED に変更する以外に変更はできません。コースのステータスが PROVISIONED の場合に限り、DECLINED に変更できます。
SUSPENDED コースは停止されています。コースを変更することはできません。コースを表示できるのは、ownerId によって識別されるユーザーだけです。利用規約に違反している可能性があるコースは、このステータスになることがあります。

コースの教材セット

コースの [概要] ページに表示される資料のセット。これらの資料には、シラバスや日程など、コース全体に関する背景情報が含まれる場合があります。

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

string

このセットのタイトル。

materials[]

object (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 フォームの添付ファイル。

採点 book の設定

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

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

enum (CalculationType)

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

displaySetting

enum (DisplaySetting)

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

gradeCategories[]

object (GradeCategory)

コースで課題として使用できる成績のカテゴリ。

計算の種類

総合成績を計算する方法。

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

ディスプレイ設定

総合成績を表示する設定。

列挙型
DISPLAY_SETTING_UNSPECIFIED 設定が指定されていません。返されることはありません。
SHOW_OVERALL_GRADE 教師と生徒に対して、採点 book と生徒のプロフィールに総合成績が表示されます。
HIDE_OVERALL_GRADE 採点 book または生徒のプロフィールに総合成績は表示されません。
SHOW_TEACHERS_ONLY 採点 book と生徒プロフィールの教師に総合成績が表示されます。生徒プロフィールで生徒に対して非表示になります。

メソッド

create

コースを作成する。

delete

コースを削除します。

get

コースを返します。

list

リクエストしているユーザーに閲覧を許可するコースのリストを返します。ただし、リクエストに一致するコースに限定されます。

patch

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

update

コースを更新します。