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)
  }
}
Поля
id

string

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

При 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 )

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

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

CourseState

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

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

CourseMaterialSet

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

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 )

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

Тип расчета

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

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

DisplaySetting

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

Перечисления
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

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