REST Resource: courses.courseWorkMaterials

Resource: CourseWorkMaterial

Course work material created by a teacher for students of the course

JSON representation 
{
  "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
}
Fields
courseId

string

Identifier of the course.

Read-only.
id

string

Classroom-assigned identifier of this course work material, unique per course.

Read-only.
title

string

Title of this course work material. The title must be a valid UTF-8 string containing between 1 and 3000 characters.
description

string

Optional description of this course work material. The text must be a valid UTF-8 string containing no more than 30,000 characters.
materials[]

object (Material)

Additional materials.

A course work material must have no more than 20 material items.
state

enum (CourseWorkMaterialState)

Status of this course work material. If unspecified, the default state is DRAFT.
creationTime

string (Timestamp format)

Timestamp when this course work material was created.

Read-only.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Timestamp of the most recent change to this course work material.

Read-only.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
scheduledTime

string (Timestamp format)

Optional timestamp when this course work material is scheduled to be published.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
assigneeMode

enum (AssigneeMode)

Assignee mode of the course work material. If unspecified, the default value is ALL_STUDENTS.
individualStudentsOptions

object (IndividualStudentsOptions)

Identifiers of students with access to the course work material. This field is set only if assigneeMode is INDIVIDUAL_STUDENTS. If the assigneeMode is INDIVIDUAL_STUDENTS, then only students specified in this field can see the course work material.
creatorUserId

string

Identifier for the user that created the course work material.

Read-only.
topicId

string

Identifier for the topic that this course work material is associated with. Must match an existing topic in the course.

CourseWorkMaterialState

Possible states of course work material

Enums
COURSEWORK_MATERIAL_STATE_UNSPECIFIED No state specified. This is never returned.
PUBLISHED Status for course work material that has been published. This is the default state.
DRAFT Status for a course work material that is not yet published. Course work material in this state is visible only to course teachers and domain administrators.
DELETED Status for course work material that was published but is now deleted. Course work material in this state is visible only to course teachers and domain administrators. Course work material in this state is deleted after some time.

Methods

create

 Creates a course work material.

delete

 Deletes a course work material.

get

 Returns a course work material.

getAddOnContext

 Gets metadata for Classroom add-ons in the context of a specific post.

list

 Returns a list of course work material that the requester is permitted to view.

patch

 Updates one or more fields of a course work material.