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

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

読み取り専用です。
title

string

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

string

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

object (Material)

補足資料

1 つのコースの教材に含めることができる教材は 20 個以下です。
state

enum (CourseWorkMaterialState)

このコースの教材のステータス。指定しない場合、デフォルトの状態は 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"。
scheduledTime

string (Timestamp format)

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

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
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 つ以上のフィールドを更新します。