REST Resource: courses

Ресурс: Курс

Курс в аудитории.

JSON-представление 
{
  "id": string,
  "name": string,
  "section": string,
  "descriptionHeading": string,
  "description": string,
  "room": string,
  "ownerId": string,
  "creationTime": string,
  "updateTime": string,
  "enrollmentCode": string,
  "courseState": enum (CourseState),
  "alternateLink": string,
  "teacherGroupEmail": string,
  "courseGroupEmail": string,
  "teacherFolder": {
    object (DriveFolder)
  },
  "courseMaterialSets": [
    {
      object (CourseMaterialSet)
    }
  ],
  "guardiansEnabled": boolean,
  "calendarId": string,
  "gradebookSettings": {
    object (GradebookSettings)
  },
  "subject": string
}
Поля
id

string

Идентификатор для этого курса, присвоенный системой Classroom.

При creating a course вы можете дополнительно указать этот идентификатор в виде alias string в запросе для создания соответствующего псевдонима. id по-прежнему присваивается Classroom и не может быть изменен после создания курса.

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

name

string

Название курса. Например, «Биология, 10 класс». Название обязательно. Оно должно содержать от 1 до 750 символов и представлять собой допустимую строку UTF-8.

section

string

Раздел курса. Например, "Период 2". Если задано, это поле должно представлять собой допустимую строку в кодировке UTF-8 и не превышать 2800 символов.

descriptionHeading

string

Необязательный заголовок для описания. Например, «Добро пожаловать на курс биологии для 10-го класса». Если этот параметр задан, поле должно представлять собой допустимую строку в кодировке UTF-8 и не превышать 3600 символов.

description

string

Необязательное описание. Например: «Мы будем изучать строение живых организмов, используя сочетание учебников, гостевых лекций и лабораторных работ. Будьте готовы к увлекательному процессу!» Если поле задано, оно должно представлять собой допустимую строку в кодировке UTF-8 и не превышать 30 000 символов.

room

string

Необязательное поле для указания местоположения комнаты. Например, "301". Если задано, это поле должно представлять собой допустимую строку в кодировке UTF-8 и не превышать 650 символов.

ownerId

string

Идентификатор владельца курса.

Если это поле указано в качестве параметра create course request , оно является обязательным. Идентификатор может быть одним из следующих:

  • числовой идентификатор пользователя
  • адрес электронной почты пользователя
  • строковый литерал "me" , указывающий на пользователя, отправившего запрос.

Этот параметр необходимо указать в запросе на создание. Администраторы также могут указать это поле в patch course request для передачи прав собственности. В других случаях оно доступно только для чтения.

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" .

enrollmentCode

string

Код регистрации, который следует использовать при присоединении к этому курсу. Указание этого поля в маске обновления курса приведет к ошибке.

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

courseState

enum ( CourseState )

Состояние курса. Если не указано, по умолчанию используется состояние PROVISIONED .

teacherGroupEmail

string

Адрес электронной почты группы Google, содержащей всех преподавателей курса. Эта группа не принимает электронные письма и может использоваться только для предоставления прав доступа.

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

courseGroupEmail

string

Адрес электронной почты группы Google, содержащей всех участников курса. Эта группа не принимает электронные письма и может использоваться только для предоставления прав доступа.

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

teacherFolder

object ( DriveFolder )

Информация о папке на Диске, которая доступна всем преподавателям курса.

Это поле будет доступно только преподавателям курса и администраторам домена.

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

courseMaterialSets[]
(deprecated)

object ( CourseMaterialSet )

Комплекты материалов, представленные на странице «О курсе».

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

guardiansEnabled

boolean

Включены ли уведомления для родителей/опекунов для этого курса.

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

calendarId

string

Идентификатор календаря, доступного для просмотра всем участникам курса, в который Classroom добавляет события для учебных заданий и объявлений в рамках курса.

Календарь для курса создается асинхронно, когда для курса впервые устанавливается состояние CourseState.ACTIVE (во время создания или при обновлении состояния до ACTIVE через пользовательский интерфейс или API). Идентификатор календаря будет заполнен только после завершения процесса создания.

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

gradebookSettings

object ( GradebookSettings )

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

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

subject

string

Факультативный предмет. Тема курса.

CourseState

Возможные состояния, в которых может находиться курс.

Перечисления
COURSE_STATE_UNSPECIFIED Состояние курса отсутствует. В возвращенном сообщении курса это значение использоваться не будет.
ACTIVE Курс активен.
ARCHIVED Курс заархивирован. Вы не можете изменить его, за исключением изменения состояния.
PROVISIONED Курс создан, но ещё не активирован. Он доступен основному преподавателю и администраторам домена, которые могут изменять его или переводить в состояние ACTIVE или DECLINED . Перевод курса в состояние PROVISIONED возможен только в том случае, если он находится в состоянии DECLINED .
DECLINED Курс создан, но отклонен. Он доступен владельцу курса и администраторам домена, но не отображается в веб-интерфейсе. Вы не можете изменить курс, кроме как перевести его в состояние PROVISIONED . Курс можно перевести в DECLINED только в том случае, если он находится в состоянии PROVISIONED .
SUSPENDED Курс приостановлен. Вы не можете изменять курс, и только пользователь, идентифицированный по ownerId может просматривать его. Курс может быть переведен в это состояние, если он потенциально нарушает Условия предоставления услуг.

Набор учебных материалов

Набор материалов, размещенных на странице «О курсе». Эти материалы могут включать программу курса, расписание или другую справочную информацию, относящуюся к курсу в целом.

JSON-представление 
{
  "title": string,
  "materials": [
    {
      object (CourseMaterial)
    }
  ]
}
Поля
title

string

Название для этого набора.

materials[]

object ( CourseMaterial )

Материалы, прилагаемые к этому набору.

Учебные материалы

Материал, прилагаемый к курсу в составе учебного комплекта.

JSON-представление 
{

  // Union field material can be only one of the following:
  "driveFile": {
    object (DriveFile)
  },
  "youTubeVideo": {
    object (YouTubeVideo)
  },
  "link": {
    object (Link)
  },
  "form": {
    object (Form)
  }
  // End of list of possible types for union field material.
}
Поля
material полевого назначения Union. Данные о материалах. material может быть только одним из следующих:
driveFile

object ( DriveFile )

Вложение файла в Google Диск.

youTubeVideo

object ( YouTubeVideo )

Видео с YouTube прилагается.

form

object ( Form )

Вложение из Google Forms.

Настройки журнала оценок

Настройки журнала оценок для курса. Подробности см. в статье справочного центра .

JSON-представление 
{
  "calculationType": enum (CalculationType),
  "displaySetting": enum (DisplaySetting),
  "gradeCategories": [
    {
      object (GradeCategory)
    }
  ]
}
Поля
calculationType

enum ( CalculationType )

Указывает, как рассчитывается общая оценка.

displaySetting

enum ( DisplaySetting )

Указывает, кто может видеть общую оценку.

gradeCategories[]

object ( GradeCategory )

Категории оценок, доступные для выполнения заданий в рамках курса.

CalculationType

Возможные методы расчета общей оценки.

Перечисления
CALCULATION_TYPE_UNSPECIFIED Метод не указан. Этот параметр никогда не возвращается.
TOTAL_POINTS Общая оценка — это сумма оценок, деленная на сумму всех баллов, независимо от категории.
WEIGHTED_CATEGORIES Общая оценка представляет собой средневзвешенное значение по категориям.

Настройки дисплея

Возможные настройки отображения общей оценки.

Перечисления
DISPLAY_SETTING_UNSPECIFIED Настройки не указаны. Этот параметр никогда не возвращается.
SHOW_OVERALL_GRADE Отображает общую оценку в журнале оценок и профиле ученика как для учителей, так и для учеников.
HIDE_OVERALL_GRADE В журнале оценок и профиле студента не отображается общая оценка.
SHOW_TEACHERS_ONLY Отображает общую оценку учителям в журнале оценок и профиле ученика. Скрывается от учеников в их профиле.

Методы

checkAddOnCreationEligibility
(deprecated)

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

checkGradingPeriodsSetupEligibility
(deprecated)

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

create

 Создаёт курс.

delete

 Удаляет курс.

get

 Возвращает курс.

getGradingPeriodSettings

 Возвращает настройки периода выставления оценок в курсе.

list

 Возвращает список курсов, которые пользователь, отправивший запрос, может просмотреть, с ограничением по тем курсам, которые соответствуют запросу.

patch

 Обновляет одно или несколько полей в курсе.

update

 Обновляет курс.

updateGradingPeriodSettings

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