REST Resource: courses

Zasób: Course

Kurs w Classroom.

Zapis 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)
  }
}
Pola
id

string

Identyfikator tych zajęć przypisany przez Classroom.

Gdy creating a course, możesz opcjonalnie ustawić ten identyfikator na alias string w żądaniu utworzenia odpowiedniego aliasu. id jest nadal przypisywany przez Classroom i nie można go zaktualizować po utworzeniu kursu.

Określenie tego pola w masce aktualizacji kursu powoduje błąd.
name

string

Nazwa kursu. Na przykład „Biologia w klasie 10”. Nazwa jest wymagana. Musi mieć od 1 do 750 znaków i być prawidłowym ciągiem UTF-8.
section

string

Sekcja szkolenia. Na przykład „Okres 2”. Jeśli to pole jest ustawione, musi zawierać prawidłowy ciąg znaków UTF-8 o długości nie większej niż 2800 znaków.
descriptionHeading

string

Opcjonalny nagłówek opisu. Na przykład „Witamy na lekcji biologii w klasie 10”. Jeśli to pole jest ustawione, musi zawierać prawidłowy ciąg UTF-8 o długości nie większej niż 3600 znaków.
description

string

Opcjonalny opis. Na przykład: „Strukturę żywych organizmów poznamy dzięki podręcznikom, wykładom gości i pracy w laboratorium. Spodziewaj się emocji! Jeśli to pole jest ustawione, musi zawierać prawidłowy ciąg UTF-8 i nie może mieć więcej niż 30 000 znaków.
room

string

Opcjonalna lokalizacja pokoju. np. „301”. Jeśli to pole jest ustawione, musi zawierać prawidłowy ciąg znaków UTF-8 o długości maksymalnie 650 znaków.
ownerId

string

Identyfikator właściciela zajęć.

Jeśli to pole jest określone jako parametr create course request, jest wymagane. Identyfikator może być jednym z tych typów:

  • identyfikator numeryczny użytkownika;
  • adres e-mail użytkownika;
  • ciąg literału "me", który wskazuje użytkownika wysyłającego żądanie;

Musisz ustawić tę wartość w prośbie o utworzenie. Administratorzy mogą też określić to pole w patch course request, aby przenieść własność. W innych kontekstach jest tylko do odczytu.
creationTime

string (Timestamp format)

Czas utworzenia kursu. Określenie tego pola w masce aktualizacji kursu powoduje błąd.

Tylko do odczytu.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i używają 0, 3, 6 lub 9 cyfr ułamkowych. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Czas ostatniej aktualizacji tego szkolenia. Określenie tego pola w masce aktualizacji kursu powoduje błąd.

Tylko do odczytu.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i używają 0, 3, 6 lub 9 cyfr ułamkowych. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".
enrollmentCode

string

Kod rejestracyjny, którego należy użyć podczas dołączania do tego kursu. Określenie tego pola w masce aktualizacji kursu powoduje błąd.

Tylko do odczytu.
courseState

enum (CourseState)

Stan kursu. Jeśli nie określisz tu żadnej wartości, zostanie użyty stan domyślny PROVISIONED.
teacherGroupEmail

string

Adres e-mail grupy dyskusyjnej Google zawierającej wszystkich nauczycieli kursu. Ta grupa nie akceptuje e-maili i może być używana tylko do przyznawania uprawnień.

Tylko do odczytu.
courseGroupEmail

string

Adres e-mail grupy dyskusyjnej Google zawierającej wszystkich członków kursu. Ta grupa nie akceptuje e-maili i może być używana tylko do przyznawania uprawnień.

Tylko do odczytu.
teacherFolder

object (DriveFolder)

Informacje o folderze na Dysku, który jest udostępniony wszystkim nauczycielom kursu.

To pole będzie ustawione tylko dla nauczycieli kursu i administratorów domeny.

Tylko do odczytu.
courseMaterialSets[]
(deprecated)

object (CourseMaterialSet)

zestawy materiałów, które pojawiają się na stronie „Informacje” tego kursu;

Tylko do odczytu.
guardiansEnabled

boolean

Określa, czy powiadomienia dla opiekunów są włączone w przypadku tych zajęć.

Tylko do odczytu.
calendarId

string

Identyfikator kalendarza, który jest widoczny dla wszystkich uczestników kursu i do którego Classroom dodaje wydarzenia dotyczące zadań i ogłoszeń na kursie.

Kalendarz kursu jest tworzony asynchronicznie, gdy kurs jest po raz pierwszy ustawiany jako CourseState.ACTIVE (podczas tworzenia lub gdy jest aktualizowany do ACTIVE w interfejsie lub za pomocą interfejsu API). Identyfikator kalendarza nie zostanie wypełniony, dopóki proces tworzenia nie zostanie ukończony.

Tylko do odczytu.
gradebookSettings

object (GradebookSettings)

Ustawienia dziennika ocen, które określają, jak będzie obliczana ogólna ocena ucznia z kursu i komu będzie wyświetlana.

Tylko do odczytu

CourseState

Możliwe stany kursu.

Wartości w polu enum
COURSE_STATE_UNSPECIFIED Brak stanu kursu. Żadna zwrócona wiadomość z kursu nie będzie używać tej wartości.
ACTIVE Szkolenie jest aktywne.
ARCHIVED Szkolenie zostało zarchiwizowane. Nie możesz go modyfikować, z wyjątkiem zmiany stanu.
PROVISIONED Kurs został utworzony, ale nie został jeszcze aktywowany. Jest on dostępny dla nauczyciela głównego i administratorów domeny, którzy mogą go modyfikować lub zmieniać na stan ACTIVE lub DECLINED. Kurs można zmienić na stan PROVISIONED tylko wtedy, gdy jest w stanie DECLINED.
DECLINED Kurs został utworzony, ale odrzucony. Jest on dostępny dla właściciela kursu i administratorów domeny, ale nie będzie wyświetlany w interfejsie internetowym. Nie możesz modyfikować kursu, z wyjątkiem zmiany jego stanu na PROVISIONED. Kurs można zmienić na stan DECLINED tylko wtedy, gdy jest w stanie PROVISIONED.
SUSPENDED Szkolenie zostało zawieszone. Nie możesz modyfikować kursu, a może go wyświetlać tylko użytkownik z identyfikatorem ownerId. Kurs może zostać oznaczony tym stanem, jeśli potencjalnie narusza Warunki korzystania z usługi.

CourseMaterialSet

Zestaw materiałów, który pojawia się na stronie „Informacje” kursu. Mogą to być sylabus, harmonogram lub inne informacje dotyczące całego kursu.

Zapis JSON 
{
  "title": string,
  "materials": [
    {
      object (CourseMaterial)
    }
  ]
}
Pola
title

string

Nazwa tego zestawu.
materials[]

object (CourseMaterial)

Materiały dołączone do tego zestawu.

CourseMaterial

Materiał dołączony do kursu w ramach zestawu materiałów.

Zapis 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.
}
Pola
Pole unii material. Dane materiału. material może mieć tylko jedną z tych wartości:
driveFile

object (DriveFile)

załącznik z Dysku Google;
youTubeVideo

object (YouTubeVideo)

Załącznik wideo z YouTube.
form

object (Form)

załącznik z Formularzy Google,

GradebookSettings

Ustawienia dziennika ocen dla zajęć. Więcej informacji znajdziesz w artykule w Centrum pomocy.

Zapis JSON 
{
  "calculationType": enum (CalculationType),
  "displaySetting": enum (DisplaySetting),
  "gradeCategories": [
    {
      object (GradeCategory)
    }
  ]
}
Pola
calculationType

enum (CalculationType)

Określa sposób obliczania oceny ogólnej.
displaySetting

enum (DisplaySetting)

Określa, kto może zobaczyć ocenę ogólną.
gradeCategories[]

object (GradeCategory)

Kategorie ocen dostępne w przypadku zadań w ramach kursu.

CalculationType

Możliwe metody obliczania oceny ogólnej.

Wartości w polu enum
CALCULATION_TYPE_UNSPECIFIED Nie określono metody. Nie jest on nigdy zwracany.
TOTAL_POINTS Ocena ogólna to suma ocen podzielona przez sumę wszystkich punktów niezależnie od kategorii.
WEIGHTED_CATEGORIES Ocena ogólna to średnia ważona według kategorii.

DisplaySetting

Możliwe ustawienia wyświetlania oceny ogólnej.

Wartości w polu enum
DISPLAY_SETTING_UNSPECIFIED Nie określono ustawienia. Nie jest on nigdy zwracany.
SHOW_OVERALL_GRADE Wyświetla ocenę ogólną w dzienniku ocen i na profilu ucznia zarówno nauczycielom, jak i uczniom.
HIDE_OVERALL_GRADE Nie wyświetla oceny ogólnej w dzienniku ocen ani w profilu ucznia.
SHOW_TEACHERS_ONLY Wyświetla ocenę ogólną nauczycielom w dzienniku ocen i na profilu ucznia. Ukrywa się przed uczniami w ich profilu.

Metody

checkAddOnCreationEligibility
(deprecated)

 Zwraca informację, czy użytkownik może tworzyć załączniki dodatków w danym kursie.

checkGradingPeriodsSetupEligibility
(deprecated)

 Zwraca informację, czy użytkownik może aktualizować ustawienia okresu oceniania na danych zajęciach.

create

 Tworzy kurs.

delete

 Usuwa zajęcia.

get

 Zwraca kurs.

getGradingPeriodSettings

 Zwraca ustawienia okresu oceniania na zajęciach.

list

 Zwraca listę kursów, które użytkownik wysyłający żądanie może wyświetlić, ograniczoną do tych, które pasują do żądania.

patch

 Aktualizuje co najmniej jedno pole w kursie.

update

 Aktualizuje kurs.

updateGradingPeriodSettings

 Aktualizuje ustawienia okresu oceniania kursu.