REST Resource: courses

Zasób: Kurs

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 zajęć przypisany przez Classroom.

Jeśli ustawiona jest wartość creating a course, możesz opcjonalnie ustawić ten identyfikator w żądaniu na alias string, aby utworzyć odpowiedni alias. Kursor id jest nadal przypisany przez Classroom i nie można go zaktualizować po utworzeniu zajęć.

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

name

string

Nazwa zajęć. Na przykład „Biologia 10 klasy”. Nazwa jest wymagana. Musi mieć od 1 do 750 znaków i prawidłowy ciąg UTF-8.

section

string

Sekcja kursu. np. „Okres 2”. Jeśli jest ustawione, pole musi zawierać prawidłowy ciąg UTF-8 o długości maksymalnie 2800 znaków.

descriptionHeading

string

Opcjonalny nagłówek opisu. Na przykład „Witamy w klasie 10”. Jeśli jest ustawione, pole musi zawierać prawidłowy ciąg UTF-8 o długości maksymalnie 3600 znaków.

description

string

Opcjonalny opis. Na przykład: „Poznamy budowę żywych istot dzięki podręcznikom, wykładom z gościnnych wykładów i pracom laboratoryjnym. Spodziewam się ekscytacji!” Jeśli jest ustawione, pole musi zawierać prawidłowy ciąg UTF-8 o długości maksymalnie 30 000 znaków.

room

string

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

ownerId

string

Identyfikator właściciela zajęć.

To pole jest wymagane, gdy określisz parametr create course request. Może on mieć jeden z tych identyfikatorów:

  • identyfikator numeryczny użytkownika
  • adres e-mail użytkownika.
  • literał ciągu znaków "me" wskazujący użytkownika wysyłającego żądanie

Musisz go ustawić w żądaniu utworzenia. Administratorzy mogą też przenieść własność za pomocą tego pola w patch course request. W pozostałych kontekstach jest ona tylko do odczytu.

creationTime

string (Timestamp format)

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

Tylko do odczytu.

Sygnatura czasowa w formacie RFC3339 UTC „Zulu”, z rozdzielczością nanosekundy i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

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

Tylko do odczytu.

Sygnatura czasowa w formacie RFC3339 UTC „Zulu”, z rozdzielczością nanosekundy i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

enrollmentCode

string

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

Tylko do odczytu.

courseState

enum (CourseState)

Stan kursu. Jeśli nie określono inaczej, stan domyślny to PROVISIONED.

teacherGroupEmail

string

Adres e-mail grupy dyskusyjnej Google zawierającej wszystkich nauczycieli prowadzących zajęcia. Ta grupa nie akceptuje e-maili i można jej używać tylko w przypadku uprawnień.

Tylko do odczytu.

courseGroupEmail

string

Adres e-mail grupy dyskusyjnej Google zawierającej wszystkich uczestników zajęć. Ta grupa nie akceptuje e-maili i można jej używać tylko w przypadku uprawnień.

Tylko do odczytu.

teacherFolder

object (DriveFolder)

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

To pole zostanie skonfigurowane tylko dla nauczycieli zajęć 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 w przypadku tych zajęć są włączone powiadomienia dla opiekunów.

Tylko do odczytu.

calendarId

string

Identyfikator kalendarza, który jest widoczny dla wszystkich uczestników zajęć, do którego Classroom dodaje wydarzenia związane z zadaniami i ogłoszeniami na zajęciach.

Kalendarz jest tworzony asynchronicznie, gdy kurs zostanie po raz pierwszy ustawiony na CourseState.ACTIVE (w momencie tworzenia lub po zaktualizowaniu do ACTIVE za pomocą interfejsu użytkownika lub interfejsu API). Identyfikator kalendarza nie będzie wypełniany, 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 za zajęcia i komu będzie ona wyświetlana.

Tylko do odczytu

CourseState

Możliwe stany, w których może znajdować się kurs.

Wartości w polu enum
COURSE_STATE_UNSPECIFIED Brak stanu zajęć. Żadna zwrócona wiadomość kursu będzie używać tej wartości.
ACTIVE Kurs jest aktywny.
ARCHIVED Kurs został zarchiwizowany. Nie można go zmodyfikować, chyba że zostanie zmieniony na inny.
PROVISIONED Kurs został utworzony, ale nie został jeszcze aktywowany. Jest dostępny dla nauczyciela głównego i administratorów domeny, którzy mogą go zmodyfikować lub zmienić na stan ACTIVE lub DECLINED. Kurs można zmienić na PROVISIONED tylko wtedy, gdy ma stan DECLINED.
DECLINED Zajęcia zostały utworzone, ale zostały odrzucone. Jest dostępny dla właściciela zajęć i administratorów domeny, ale nie będzie wyświetlany w interfejsie internetowym. Nie możesz zmodyfikować zajęć, chyba że zmienisz je na PROVISIONED. Kurs można zmienić na DECLINED tylko wtedy, gdy ma stan PROVISIONED.
SUSPENDED Kurs został zawieszony. Nie możesz modyfikować zajęć, a tylko użytkownik wskazany przez ownerId może je wyświetlić. Kurs może zostać oznaczony jako taki, jeśli potencjalnie narusza on Warunki korzystania z usługi.

CourseMaterialSet

Zestaw materiałów, które pojawiają się na stronie „Informacje” kursu. Mogą one obejmować program nauczania, harmonogram lub inne ogólne informacje dotyczące całego kursu.

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

string

Tytuł tego zestawu.

materials[]

object (CourseMaterial)

Materiały załączone do tego zestawu.

CourseMaterial

Materiały dołączone do kursu jako część 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 sumy material. Dane materialne. material może mieć tylko jedną z tych wartości:
driveFile

object (DriveFile)

Plik załącznika z Dysku Google.

youTubeVideo

object (YouTubeVideo)

Załącznik wideo w YouTube.

form

object (Form)

Załącznik Formularzy Google.

GradebookSettings

Ustawienia dziennika ocen 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)

Wskazuje 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 na potrzeby zadań w ramach kursu.

CalculationType

Możliwe metody obliczania oceny ogólnej.

Wartości w polu enum
CALCULATION_TYPE_UNSPECIFIED Nie określono metody. Ta wartość nigdy nie jest zwracana.
TOTAL_POINTS Ocena ogólna to suma ocen podzielona przez sumę 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. Ta wartość nigdy nie jest zwracana.
SHOW_OVERALL_GRADE Pokazuje ocenę ogólną w dzienniku ocen i profilu ucznia zarówno dla nauczycieli, jak i uczniów.
HIDE_OVERALL_GRADE nie wyświetla oceny ogólnej w dzienniku ocen ani w profilu ucznia.
SHOW_TEACHERS_ONLY Pokazuje ocenę ogólną nauczycielom w dzienniku ocen i profilu ucznia. są ukryte przed uczniami w ich profilach uczniów;

Metody

checkAddOnCreationEligibility

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

create

Tworzy zajęcia.

delete

Usuwa zajęcia.

get

Zwraca kurs.

list

Zwraca listę kursów, które może wyświetlać użytkownik wysyłający prośbę. Zwracana jest tylko lista kursów zgodnych z żądaniem.

patch

Aktualizuje jedno lub więcej pól w kursie.

update

Aktualizuje zajęcia.