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 によって割り当てられた ID(コースごとに一意)。

読み取り専用です。

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)

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

読み取り専用です。

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)

コースの課題にアクセスできる生徒の ID。このフィールドは、assigneeModeINDIVIDUAL_STUDENTS の場合にのみ設定されます。assigneeModeINDIVIDUAL_STUDENTS の場合は、このフィールドで指定された生徒のみがコースの課題を表示できます。

creatorUserId

string

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

読み取り専用です。

topicId

string

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

CourseWorkMaterialState

コースの教材の状態

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

Methods

create

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

delete

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

get

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

getAddOnContext

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

list

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

patch

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