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
}
フィールド
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

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

CourseWorkMaterialState

コースの教材の取り得る状態

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

メソッド

create

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

delete

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

get

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

getAddOnContext

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

list

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

patch

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