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,
  "learningStandardSettings": {
    object (CourseLearningStandardSettings)
  },
  "levels": string
}
Поля
id

string

Идентификатор курса, назначенный Классом.

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

Если указать это поле в маске обновления курса, возникнет ошибка.
name

string

Название курса. Например: "Биология, 10-й класс". Укажите название. Это должна быть действительная строка UTF-8 длиной от 1 до 750 символов.
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. Допустимы и другие типы нормализации. Примеры: "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. Допустимы и другие типы нормализации. Примеры: "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

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

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

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

object (GradebookSettings)

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

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

string

Необязательное поле. Тема курса.
learningStandardSettings

object (CourseLearningStandardSettings)

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

Настройки, связанные с образовательными стандартами, доступными в курсе. К курсу можно привязать не более 20 корневых наборов образовательных стандартов.
levels

string

Необязательное поле. Уровни курса. Примеры: "9 класс", "Средняя школа", "4–5 классы", "K-2", "3000". Если это поле заполнено, оно должно содержать действительную строку UTF-8 длиной менее 1000 символов.

Это поле можно очистить только с помощью метода courses.patch.

CourseState

Возможные состояния курса.

Перечисления
COURSE_STATE_UNSPECIFIED Нет статуса курса. Это значение не будет использоваться ни в одном возвращенном сообщении Course.
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)

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

CourseMaterial

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

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

  "driveFile": {
    object (DriveFile)
  },
  "youTubeVideo": {
    object (YouTubeVideo)
  },
  "link": {
    object (Link)
  },
  "form": {
    object (Form)
  }
}
Поля
Данные о материалах. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
driveFile

object (DriveFile)

Прикрепленный файл с Google Диска.
youTubeVideo

object (YouTubeVideo)

Прикрепленное видео YouTube.
form

object (Form)

Прикрепленный файл Google Форм.
Конец взаимоисключающих полей.

GradebookSettings

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

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 Общая оценка – это средневзвешенное значение по категориям.

DisplaySetting

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

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

CourseLearningStandardSettings

Настройки образовательных стандартов для курса.

JSON-представление 
{
  "standardSets": [
    {
      object (LearningStandardSetRoot)
    }
  ]
}
Поля
standardSets[]

object (LearningStandardSetRoot)

Обязательно. Набор корневых образовательных стандартов, применяемых к этому курсу.

LearningStandardSetRoot

Представляет корень выбранного набора образовательных стандартов. Дочерние элементы выбранных корневых элементов будут показаны при настройке учебных целей для элементов ленты в интерфейсе Класса.

JSON-представление 
{
  "caseGuid": {
    object (CaseGuid)
  },
  "documentTitle": string,
  "standardTitle": string,
  "sourceDataAvailabilityStatus": enum (LearningStandardAvailabilityState)
}
Поля
caseGuid

object (CaseGuid)

Обязательно. GUID Satchel Rosetta Exchange для корневого набора образовательных стандартов.
documentTitle

string

Только для вывода. Название документа, в котором содержится набор образовательных стандартов.
standardTitle

string

Только для вывода. Название корневого элемента набора образовательных стандартов.
sourceDataAvailabilityStatus

enum (LearningStandardAvailabilityState)

Только для вывода. Статус доступности корневого набора образовательных стандартов. Используйте это поле, чтобы определить, был ли удален из источника корневой набор образовательных стандартов.

Методы

checkAddOnCreationEligibility
(deprecated)

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

checkGradingPeriodsSetupEligibility
(deprecated)

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

create

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

delete

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

get

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

getGradingPeriodSettings

 Возвращает настройки академического периода в курсе.

list

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

patch

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

update

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

updateGradingPeriodSettings

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