REST Resource: courses.courseWorkMaterials

Ресурс: Учебные материалы

Учебные материалы, разработанные преподавателем для студентов данного курса.

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

Присваиваемый классом идентификатор данного учебного материала, уникальный для каждого курса.

Только для чтения.

title

string

Название данного учебного материала. Название должно представлять собой допустимую строку в кодировке UTF-8, содержащую от 1 до 3000 символов.

description

string

Описание учебных материалов (необязательно). Текст должен представлять собой допустимую строку UTF-8, содержащую не более 30 000 символов.

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 )

Необязательный.

Ссылки на любые учебные цели, связанные с данным учебным материалом. Учебный материал может содержать не более 10 учебных целей. Это поле заполняется только в том случае, если указана соответствующая previewVersion .

Состояние учебных материалов

Возможные состояния учебных материалов

Перечисления
COURSEWORK_MATERIAL_STATE_UNSPECIFIED Штат не указан. Этот запрос никогда не возвращается.
PUBLISHED Статус опубликованных учебных материалов. Это состояние по умолчанию.
DRAFT Статус учебных материалов, которые еще не опубликованы. Учебные материалы в этом состоянии видны только преподавателям курса и администраторам домена.
DELETED Статус учебных материалов, которые были опубликованы, но теперь удалены. Учебные материалы в этом состоянии видны только преподавателям курса и администраторам домена. Учебные материалы в этом состоянии удаляются через некоторое время.

Методы

create

 Создает учебные материалы для курса.

delete

 Удаляет материалы учебного курса.

get

 Возвращает учебные материалы.

getAddOnContext

 Получает метаданные для дополнений Classroom в контексте конкретной публикации.

list

 Возвращает список учебных материалов, к просмотру которых имеет право запросить данные.

patch

 Обновляет одно или несколько полей учебных материалов.