REST Resource: courses.courseWorkMaterials

リソース: CourseWorkMaterial

教師がコースの生徒向けに作成したコースの教材

JSON 表現 
{
  "courseId": string,
  "id": string,
  "title": string,
  "description": string,
  "materials": [
    {
      object (Material)
    }
  ],
  "state": enum (CourseWorkMaterialState),
  "alternateLink": string,
  "creationTime": string,
  "updateTime": string,
  "scheduledTime": string,
  "assigneeMode": enum (AssigneeMode),
  "individualStudentsOptions": {
    object (IndividualStudentsOptions)
  },
  "creatorUserId": string,
  "topicId": string,
  "learningGoals": [
    {
      object (LearningGoal)
    }
  ]
}
フィールド
courseId

string

コースの識別子。

読み取り専用です。
id

string

このコースの教材に Classroom が割り当てた識別子。コースごとに一意です。

読み取り専用です。
title

string

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

string

このコースの教材の説明（省略可）。テキストは、30,000 文字以内の有効な UTF-8 文字列にする必要があります。
materials[]

object (Material)

その他の教材。

コースの教材の項目数は 20 個以下にする必要があります。
state

enum (CourseWorkMaterialState)

このコースの教材のステータス。指定しない場合、デフォルトのステータスは DRAFT です。
creationTime

string (Timestamp format)

このコースの教材が作成されたときのタイムスタンプ。

読み取り専用です。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
updateTime

string (Timestamp format)

このコースの教材が最後に変更されたときのタイムスタンプ。

読み取り専用です。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
scheduledTime

string (Timestamp format)

このコースの教材が公開される予定のタイムスタンプ（省略可）。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
assigneeMode

enum (AssigneeMode)

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

object (IndividualStudentsOptions)

コースの教材にアクセスできる生徒の識別子。このフィールドは、assigneeMode が INDIVIDUAL_STUDENTS の場合にのみ設定されます。assigneeMode が INDIVIDUAL_STUDENTS の場合、このフィールドで指定された生徒のみがコースの教材を表示できます。
creatorUserId

string

コースの教材を作成したユーザーの識別子。

読み取り専用です。
topicId

string

このコースの教材が関連付けられているトピックの識別子。コース内の既存のトピックと一致する必要があります。
learningGoals[]

object (LearningGoal)

省略可。

このコースの教材に関連付けられている学習目標への参照。CourseWorkMaterial に設定できる学習目標は 10 個までです。このフィールドは、適切な previewVersion が設定されている場合にのみ入力されます。

CourseWorkMaterialState

コースの教材のステータス

列挙型
COURSEWORK_MATERIAL_STATE_UNSPECIFIED ステータスが指定されていません。返されることはありません。
PUBLISHED 公開済みのコースの教材のステータス。これがデフォルトのステータスです。
DRAFT まだ公開されていないコースの教材のステータス。このステータスのコースの教材は、コースの教師とドメイン管理者のみが閲覧できます。
DELETED 公開済みだが削除されたコースの教材のステータス。このステータスのコースの教材は、コースの教師とドメイン管理者のみが閲覧できます。このステータスのコースの教材は、しばらくすると削除されます。

メソッド

create

 コースの教材を作成します。

delete

 コースの教材を削除します。

get

 コースの教材を返します。

getAddOnContext

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

list

 リクエスト元が閲覧できるコースの教材のリストを返します。

patch

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