- リソース: コース
- CourseState
- CourseMaterialSet
- CourseMaterial
- GradebookSettings
- CalculationType
- DisplaySetting
- メソッド
リソース: コース
Classroom の学習コース
JSON 表現 |
---|
{ "id": string, "name": string, "section": string, "descriptionHeading": string, "description": string, "room": string, "ownerId": string, "creationTime": string, "updateTime": string, "enrollmentCode": string, "courseState": enum ( |
フィールド | |
---|---|
id |
Classroom によって割り当てられたこのコースの識別子。
コース更新マスクでこのフィールドを指定すると、エラーが発生します。 |
name |
コースの名前。例: 「高校生の生物学」名前は必須です。1 ~ 750 文字で、有効な UTF-8 文字列を指定する必要があります。 |
section |
コースのセクション。例: 「期間 2」。設定する場合、このフィールドは 2, 800 文字以下の有効な UTF-8 文字列にする必要があります。 |
descriptionHeading |
説明の見出し(省略可)。たとえば、「10 年生の生物学へようこそ」と言います。設定する場合、このフィールドは 3, 600 文字以下の有効な UTF-8 文字列にする必要があります。 |
description |
説明(省略可)。たとえば、「私たちは、教科書、ゲスト講義、ラボの作業を組み合わせて、生物の構造について学びます。楽しみになれます。」設定する場合、このフィールドは 30,000 文字以下の有効な UTF-8 文字列にする必要があります。 |
room |
会議室の場所(省略可)。例: 「301」。設定する場合、このフィールドは 650 文字以下の有効な UTF-8 文字列にする必要があります。 |
ownerId |
コースのオーナーの ID。
作成リクエストで設定する必要があります。管理者は、 |
creationTime |
コースの作成時間。コース更新マスクでこのフィールドを指定すると、エラーが発生します。 読み取り専用です。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
updateTime |
このコースが最後に更新された時刻。コース更新マスクでこのフィールドを指定すると、エラーが発生します。 読み取り専用です。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
enrollmentCode |
このコースへの参加時に使用する登録コード。コース更新マスクでこのフィールドを指定すると、エラーが発生します。 読み取り専用です。 |
courseState |
コースの状態。指定しない場合のデフォルトの状態は |
alternateLink |
Classroom ウェブ UI でのこのコースへの絶対リンク。 読み取り専用です。 |
teacherGroupEmail |
コースのすべての教師を含む Google グループのメールアドレス。このグループはメールを受け付けていません。権限を設定する場合にのみ使用できます。 読み取り専用です。 |
courseGroupEmail |
コースのすべてのメンバーを含む Google グループのメールアドレス。このグループはメールを受け付けていません。権限を設定する場合にのみ使用できます。 読み取り専用です。 |
teacherFolder |
コースのすべての教師と共有するドライブ フォルダに関する情報。 このフィールドは、コースの教師とドメイン管理者にのみ設定されます。 読み取り専用です。 |
courseMaterialSets[] |
このコースの「概要」ページに表示される教材のセット。 読み取り専用です。 |
guardiansEnabled |
このコースで保護者への通知が有効になっているかどうかを指定します。 読み取り専用です。 |
calendarId |
すべてのコースメンバーが閲覧できるカレンダーのカレンダー ID。Classroom でコースの課題やお知らせに関する予定が追加されます。 コースのカレンダーは、初めてコースが 読み取り専用です。 |
gradebookSettings |
採点簿の設定では、コースでの生徒の総合成績の計算方法と、成績の表示先を指定します。 読み取りのみ |
CourseState
コースの考えられるステータス。
列挙型 | |
---|---|
COURSE_STATE_UNSPECIFIED |
コースの状態がありません。返された Course メッセージでこの値が使用されることはありません。 |
ACTIVE |
コースは有効です。 |
ARCHIVED |
コースはアーカイブされました。別の状態に変更する以外は変更できません。 |
PROVISIONED |
コースは作成されていますが、まだ有効になっていません。主担任とドメイン管理者がアクセスでき、これらの教師は状態を変更したり、ACTIVE や DECLINED 状態に変更したりできます。コースは DECLINED 状態の場合にのみ、PROVISIONED に変更できます。 |
DECLINED |
コースは作成されましたが、拒否されました。コースのオーナーとドメイン管理者はアクセスできますが、ウェブ UI には表示されません。コースを変更するには、PROVISIONED 状態に変更する必要があります。コースは PROVISIONED 状態の場合にのみ、DECLINED に変更できます。 |
SUSPENDED |
コースは一時停止されました。コースは変更できません。ownerId で指定されたユーザーのみがコースを表示できます。コースが利用規約に違反している可能性がある場合、このステータスになることがあります。 |
CourseMaterialSet
コースの [概要] ページに表示される教材のセット。これらの資料には、シラバス、スケジュール、コース全体に関連するその他の背景情報などが含まれます。
JSON 表現 |
---|
{
"title": string,
"materials": [
{
object ( |
フィールド | |
---|---|
title |
このセットのタイトル。 |
materials[] |
このセットに添付された資料。 |
CourseMaterial
マテリアル セットの一部としてコースに添付されるマテリアル。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド material 。マテリアル データ。material は次のいずれかになります。 |
|
driveFile |
Google ドライブのファイル添付ファイル。 |
youTubeVideo |
YouTube 動画添付ファイル。 |
link |
リンク関連付け。 |
form |
Google フォームの添付ファイル。 |
GradebookSettings
コースの採点簿の設定。詳しくは、ヘルプセンターの記事をご覧ください。
JSON 表現 |
---|
{ "calculationType": enum ( |
フィールド | |
---|---|
calculationType |
総合成績の計算方法を指定します。 |
displaySetting |
総合成績を表示できるユーザーを示します。 |
gradeCategories[] |
コースの課題で利用できる成績のカテゴリ。 |
CalculationType
総合成績の計算方法として考えられる方法。
列挙型 | |
---|---|
CALCULATION_TYPE_UNSPECIFIED |
メソッドが指定されていません。これは返されません。 |
TOTAL_POINTS |
総合成績は、カテゴリに関係なく、成績の合計点を点数の合計で割って算出されます。 |
WEIGHTED_CATEGORIES |
総合成績はカテゴリごとの加重平均です。 |
DisplaySetting
総合成績を表示するための可能な設定。
列挙型 | |
---|---|
DISPLAY_SETTING_UNSPECIFIED |
設定が指定されていません。これは返されません。 |
SHOW_OVERALL_GRADE |
採点簿と生徒のプロフィールで教師と生徒の両方に総合成績が表示されます。 |
HIDE_OVERALL_GRADE |
採点簿や生徒のプロフィールに総合成績は表示されません。 |
SHOW_TEACHERS_ONLY |
採点簿と生徒のプロフィールに教師の総合成績が表示されます。生徒プロフィールで生徒には表示されません。 |
Methods |
|
---|---|
|
指定したコースでユーザーがアドオンの添付ファイルを作成できるかどうかを返します。 |
|
コースを作成する。 |
|
コースを削除します。 |
|
コースを返します。 |
|
リクエストを行ったユーザーが閲覧を許可されているコースのリストを、リクエストに一致するコースに限定して返します。 |
|
コース内の 1 つ以上のフィールドを更新します。 |
|
コースを更新します。 |