Дополнения Google Classroom теперь общедоступны для разработчиков! Дополнительную информацию см. в документации по дополнениям .

Эта страница переведена с помощью Cloud Translation API.

REST Resource: courses

Ресурс: Курс
- JSON-представление
КурсСтат
КурсМатериалНабор
- JSON-представление
КурсМатериал
- JSON-представление
Настройки журнала успеваемости
- JSON-представление
Тип расчета
Настройка дисплея
Методы

Ресурс: Курс

Курс в классе.

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

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,
  "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` по-прежнему назначается Классом и не может быть обновлен после создания курса. Указание этого поля в маске обновления курса приводит к ошибке.
`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)` Время создания курса. Указание этого поля в маске обновления курса приводит к ошибке. Только для чтения. Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: `"2014-10-02T15:01:23Z"` и `"2014-10-02T15:01:23.045123456Z"` .
`updateTime`	`string ( Timestamp format)` Время последнего обновления этого курса. Указание этого поля в маске обновления курса приводит к ошибке. Только для чтения. Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: `"2014-10-02T15:01:23Z"` и `"2014-10-02T15:01:23.045123456Z"` .
`enrollmentCode`	`string` Код регистрации, который можно использовать при присоединении к этому курсу. Указание этого поля в маске обновления курса приводит к ошибке. Только для чтения.
`courseState`	`enum ( CourseState )` Состояние курса. Если не указано, состояние по умолчанию — `PROVISIONED` .
`alternateLink`	`string` Полная ссылка на этот курс в веб-интерфейсе Класса. Только для чтения.
`teacherGroupEmail`	`string` Адрес электронной почты группы Google, в которую входят все преподаватели курса. Эта группа не принимает электронную почту и может использоваться только для получения разрешений. Только для чтения.
`courseGroupEmail`	`string` Адрес электронной почты группы Google, в которую входят все участники курса. Эта группа не принимает электронную почту и может использоваться только для получения разрешений. Только для чтения.
`teacherFolder`	`object ( DriveFolder )` Информация о папке на Диске, которая доступна всем преподавателям курса. Это поле будет установлено только для преподавателей курса и администраторов домена. Только для чтения.
`courseMaterialSets[] (deprecated)`	`object ( CourseMaterialSet )` Этот товар устарел! Наборы материалов, которые появляются на странице «О курсе» этого курса. Только для чтения.
`guardiansEnabled`	`boolean` Включены ли уведомления опекуна для этого курса. Только для чтения.
`calendarId`	`string` Идентификатор календаря, доступный всем участникам курса, в который Класс добавляет события для курсовой работы и объявления в курсе. Календарь курса создается асинхронно, когда для курса впервые устанавливается значение `CourseState.ACTIVE` (во время создания или когда он обновляется до `ACTIVE` через пользовательский интерфейс или API). Идентификатор календаря не будет заполнен до завершения процесса создания. Только для чтения.
`gradebookSettings`	`object ( GradebookSettings )` Настройки журнала оценок, определяющие, как будет рассчитываться общая оценка учащегося за курс и кому она будет отображаться. Только чтение

КурсСтат

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

Перечисления
`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 )` Материалы прилагаются к этому набору.

title

string

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

materials[]

object ( CourseMaterial )

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

КурсМатериал

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

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

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`. }

{

  // 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` Союза. Данные о материале. `material` может быть только одним из следующих:
`driveFile`	`object ( DriveFile )` Вложенный файл Google Диска.
`youTubeVideo`	`object ( YouTubeVideo )` Вложение видео с Ютуба.
`link`	`object ( Link )` Прикрепление ссылки.
`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

enum ( CalculationType )

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

displaySetting

enum ( DisplaySetting )

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

gradeCategories[]

object ( GradeCategory )

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

Тип расчета

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

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

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

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

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

Методы
`checkAddOnCreationEligibility (deprecated)`	Возвращает, имеет ли пользователь право создавать дополнительные вложения в данном курсе.
`checkGradingPeriodsSetupEligibility (deprecated)`	Предварительная версия для разработчиков: доступна в рамках программы Google Workspace Developer Preview Program , которая предоставляет ранний доступ к определенным функциям. Эта функция доступна в `V1_20240401_PREVIEW` и более поздних версиях. Дополнительные сведения см. в разделе API-интерфейсы Access Preview . Возвращает, имеет ли пользователь право обновлять GradingPeriodSettings в данном курсе.
`create`	Создает курс.
`delete`	Удаляет курс.
`get`	Возвращает курс.
`getGradingPeriodSettings`	Предварительная версия для разработчиков: доступна в рамках программы Google Workspace Developer Preview Program , которая предоставляет ранний доступ к определенным функциям. Эта функция доступна в `V1_20240401_PREVIEW` и более поздних версиях. Дополнительные сведения см. в разделе API Access Preview . Возвращает настройки оценочного периода в курсе.
`list`	Возвращает список курсов, которые разрешено просматривать запрашивающему пользователю, ограниченный теми, которые соответствуют запросу.
`patch`	Обновляет одно или несколько полей в курсе.
`update`	Обновляет курс.
`updateGradingPeriodSettings`	Предварительная версия для разработчиков: доступна в рамках программы Google Workspace Developer Preview Program , которая предоставляет ранний доступ к определенным функциям. Эта функция доступна в `V1_20240401_PREVIEW` и более поздних версиях. Дополнительные сведения см. в разделе API Access Preview . Обновляет настройки оценивания курса.

REST Resource: courses

Ресурс: Курс

КурсСтат

КурсМатериалНабор

КурсМатериал

Настройки журнала успеваемости

Тип расчета

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

Методы

`checkAddOnCreationEligibility (deprecated)`

`checkGradingPeriodsSetupEligibility (deprecated)`

`create`

`delete`

`get`

`getGradingPeriodSettings`

`list`

`patch`

`update`

`updateGradingPeriodSettings`