- リソース: コース
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- CourseState
- CourseMaterialSet
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- CourseMaterial
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- GradebookSettings
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- 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 によって割り当てられたこのコースの ID。
コース更新マスクでこのフィールドを指定すると、エラーが発生します。 |
name |
コースの名前。たとえば、「高校生の生物学」のように指定します。名前は必須です。1 ~ 750 文字で、有効な UTF-8 文字列を指定する必要があります。 |
section |
このセクションで説明します例: "Period 2"設定する場合、このフィールドは 2, 800 文字以下の有効な UTF-8 文字列にする必要があります。 |
descriptionHeading |
説明の見出し(省略可)。たとえば、「Welcome to 10th SIS Biology」などです。設定する場合、このフィールドは 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 |
コースの状態がありません。返されるコース メッセージでこの値が使用されることはありません。 |
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 |
採点簿と生徒のプロフィールに総合成績が教師に表示されます。生徒プロフィールに生徒に表示されなくなります。 |
メソッド |
|
---|---|
|
ユーザーが特定のコースでアドオン添付ファイルを作成する資格があるかどうかを返します。 |
|
ユーザーが特定のコースで GradingPeriodSettings の更新の資格があるかどうかを返します。 |
|
コースを作成します。 |
|
コースを削除します。 |
|
コースを返します。 |
|
コースの採点期間の設定を返します。 |
|
リクエスト元のユーザーに表示が許可されているコースのリスト(リクエストに一致するコースのみ)を返します。 |
|
コース内の 1 つ以上のフィールドを更新します。 |
|
コースを更新します。 |
|
コースの採点期間の設定を更新します。 |