REST Resource: courses.courseWork

リソース: CourseWork

コースの受講生向けに教師が作成したコースの課題。

JSON 表現 
{
  "courseId": string,
  "id": string,
  "title": string,
  "description": string,
  "materials": [
    {
      object (Material)
    }
  ],
  "state": enum (CourseWorkState),
  "alternateLink": string,
  "creationTime": string,
  "updateTime": string,
  "dueDate": {
    object (Date)
  },
  "dueTime": {
    object (TimeOfDay)
  },
  "scheduledTime": string,
  "maxPoints": number,
  "workType": enum (CourseWorkType),
  "associatedWithDeveloper": boolean,
  "assigneeMode": enum (AssigneeMode),
  "individualStudentsOptions": {
    object (IndividualStudentsOptions)
  },
  "submissionModificationMode": enum (SubmissionModificationMode),
  "creatorUserId": string,
  "topicId": string,
  "gradeCategory": {
    object (GradeCategory)
  },
  "previewVersion": enum (PreviewVersion),

  // Union field details can be only one of the following:
  "assignment": {
    object (Assignment)
  },
  "multipleChoiceQuestion": {
    object (MultipleChoiceQuestion)
  }
  // End of list of possible types for union field details.
  "gradingPeriodId": string
}
フィールド
courseId

string

コースの識別子。

読み取り専用です。
id

string

クラスによって割り当てられた、このコースの課題の ID。コースごとに一意です。

読み取り専用です。
title

string

このコースの課題のタイトル。タイトルは、1 ～ 3,000 文字の有効な UTF-8 文字列にする必要があります。
description

string

このコースの課題の説明（省略可）。設定する場合は、30,000 文字以下の有効な UTF-8 文字列を指定する必要があります。
materials[]

object (Material)

補足資料

CourseWork の教材アイテムは 20 個以下にする必要があります。
state

enum (CourseWorkState)

このコースの課題のステータス。指定しない場合、デフォルトの状態は DRAFT です。
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"。
dueDate

object (Date)

このコースの課題の提出期限（省略可）の日付（UTC）。dueTime が指定されている場合は、これを指定する必要があります。
dueTime

object (TimeOfDay)

このコースの課題の提出期限（オプション）。時刻（UTC）。dueDate が指定されている場合は、これを指定する必要があります。
scheduledTime

string (Timestamp format)

このコースの課題の公開予定時刻のタイムスタンプ（省略可）。

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

number

このコースの課題の最大成績。ゼロまたは未指定の場合、この課題は採点なしと見なされます。0 または正の整数値を指定してください。
workType

enum (CourseWorkType)

このコースの成果物のタイプ。

タイプは、コースの課題の作成時に設定され、変更できません。
associatedWithDeveloper

boolean

このコースの作業アイテムが、リクエストを行う Developer Console プロジェクトに関連付けられているかどうか。

詳しくは、courseWork.create をご覧ください。

読み取り専用です。
assigneeMode

enum (AssigneeMode)

コースワークの割り当て先モード。指定しない場合、デフォルト値は ALL_STUDENTS です。
individualStudentsOptions

object (IndividualStudentsOptions)

コースワークにアクセスできる生徒の識別子。このフィールドは、assigneeMode が INDIVIDUAL_STUDENTS の場合にのみ設定されます。assigneeMode が INDIVIDUAL_STUDENTS の場合、このフィールドで指定された生徒のみに課題が割り当てられます。
submissionModificationMode

enum (SubmissionModificationMode)

生徒が提出物を変更できるタイミングを指定する設定です。指定しない場合、デフォルト値は MODIFIABLE_UNTIL_TURNED_IN です。
creatorUserId

string

コースワークを作成したユーザーの識別子。

読み取り専用です。
topicId

string

このコースワークが関連付けられているトピックの識別子。コースの既存のトピックと一致している必要があります。
gradeCategory

object (GradeCategory)

この課題の成績が寄与しているカテゴリ。コースワークのカテゴリが選択された場合にのみ表示します。総合成績の計算に使用できます。

読み取り専用です。
previewVersion

enum (PreviewVersion)

出力専用。このリソースの取得に使用される API のプレビュー版。
共用体フィールド details。コースの作業の種類に固有の追加の詳細。details は次のいずれかになります。
assignment

object (Assignment)

課題の詳細。workType が ASSIGNMENT の場合にのみ入力されます。

読み取り専用です。
multipleChoiceQuestion

object (MultipleChoiceQuestion)

多肢選択式の質問の詳細。読み取りオペレーションでは、workType が MULTIPLE_CHOICE_QUESTION の場合にのみ、このフィールドにデータが入力されます。書き込みオペレーションの場合、このフィールドは workType が MULTIPLE_CHOICE_QUESTION のコース課題の作成時に指定する必要があります。それ以外の場合は設定しないでください。
gradingPeriodId

string

コースワークに関連付けられている採点期間の識別子。

  • 指定しない場合、採点期間 ID は dueDate に基づいて設定されます（dueDate が設定されていない場合は scheduledTime）。
  • どの採点期間にも関連付けられていないことを示すには、このフィールドに空の文字列（""）を設定します。
  • 指定する場合は、コースの既存の採点期間 ID と一致している必要があります。

CourseWorkState

コースの作業の状態。

列挙型
COURSE_WORK_STATE_UNSPECIFIED 状態が指定されていません。これは返されることはありません。
PUBLISHED 公開済みの課題のステータス。これがデフォルトの状態です。
DRAFT まだ公開されていない課題のステータス。この状態の課題は、コースの教師とドメイン管理者にのみ表示されます。
DELETED 公開済みだが現在は削除済みの課題のステータス。この状態の課題は、コースの教師とドメイン管理者にのみ表示されます。この状態の課題はしばらくすると削除されます。

SubmissionModificationMode

生徒の提出物に対して考えられる変更モード。

列挙型
SUBMISSION_MODIFICATION_MODE_UNSPECIFIED 変更モードが指定されていません。これは返されることはありません。
MODIFIABLE_UNTIL_TURNED_IN 提出前に提出物を変更できます。
MODIFIABLE 提出物はいつでも変更できます。

職務

課題の詳細。

JSON 表現 
{
  "studentWorkFolder": {
    object (DriveFolder)
  }
}
フィールド
studentWorkFolder

object (DriveFolder)

生徒の提出物の添付ファイルが保存されているドライブ フォルダ。この項目はコースの教師と管理者にのみ表示されます。

MultipleChoiceQuestion

多肢選択式の問題に関する詳細情報。

JSON 表現 
{
  "choices": [
    string
  ]
}
フィールド
choices[]

string

可能な選択肢。

メソッド

create

 コースワークを作成する。

delete

 コースの課題を削除します。

get

 コースの課題を返却します。

getAddOnContext

 特定の投稿のコンテキストで Classroom アドオンのメタデータを取得します。

list

 リクエスト元に閲覧が許可されているコース作業のリストを返します。

modifyAssignees

 課題の割り当て先のモードとオプションを変更します。

patch

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