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.

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

Określenie tego pola w masce aktualizacji szkolenia 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 znaków UTF-8.
section

string

Sekcja szkolenia. np. „Okres 2”. Jeśli to pole jest ustawione, musi być prawidłowym ciągiem znaków UTF-8 i może mieć maksymalnie 2800 znaków.
descriptionHeading

string

Opcjonalny nagłówek opisu. Na przykład „Witamy w klasie 10 z biologii”. Jeśli to pole jest skonfigurowane, musi być prawidłowym ciągiem znaków UTF-8 i może mieć maksymalnie 3600 znaków.
description

string

Opcjonalny opis. Na przykład „Poznamy strukturę żywych stworzeń dzięki podręcznikom, wykładom gościnnym i pracom laboratoryjnym. Możesz się spodziewać! Jeśli to pole jest skonfigurowane, musi być prawidłowym ciągiem znaków UTF-8 i może mieć maksymalnie 30 tys. znaków.
room

string

Opcjonalna lokalizacja sali. Przykład: „301”. Jeśli to pole jest skonfigurowane, musi być prawidłowym ciągiem znaków UTF-8 i może mieć maksymalnie 650 znaków.
ownerId

string

Identyfikator właściciela zajęć.

Gdy określasz to pole jako parametr obiektu create course request, jest ono wymagane. Może to być jeden z tych identyfikatorów:

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

Należy to ustawić w żądaniu utworzenia. Administratorzy mogą też podać to pole w patch course request, aby przenieść prawo własności. W pozostałych kontekstach jest on dostępny tylko do odczytu.
creationTime

string (Timestamp format)

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

Tylko do odczytu.

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową 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 szkolenia. Określenie tego pola w masce aktualizacji szkolenia powoduje błąd.

Tylko do odczytu.

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową 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 szkolenia powoduje błąd.

Tylko do odczytu.
courseState

enum (CourseState)

Stan kursu. Jeśli stan nie jest określony, domyślny to PROVISIONED.
teacherGroupEmail

string

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

Tylko do odczytu.
courseGroupEmail

string

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

Tylko do odczytu.
teacherFolder

object (DriveFolder)

Informacje o folderze na Dysku, który jest udostępniany wszystkim nauczycielom biorącym udział w zajęciach.

To pole zostanie ustawione tylko dla nauczycieli prowadzących zajęcia oraz administratorów domeny.

Tylko do odczytu.
courseMaterialSets[]
(deprecated)

object (CourseMaterialSet)

Zestawy materiałów, które pojawiają się na stronie „Informacje” tego szkolenia.

Tylko do odczytu.
guardiansEnabled

boolean

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

Tylko do odczytu.
calendarId

string

Identyfikator kalendarza widoczny dla wszystkich uczestników zajęć, do którego Classroom dodaje wydarzenia dotyczące zadań i ogłoszeń w ramach zajęć.

Kalendarz zajęć jest tworzony asynchronicznie, gdy zajęcia są ustawione na CourseState.ACTIVE po raz pierwszy (w momencie tworzenia albo gdy jest aktualizowany do wersji ACTIVE za pomocą interfejsu użytkownika lub interfejsu API). Identyfikator kalendarza nie zostanie uzupeł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 zajęć, a także komu będzie ona widoczna.

Tylko do odczytu

CourseState

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

Wartości w polu enum
COURSE_STATE_UNSPECIFIED Brak stanu szkolenia. Tej wartości nie będzie używać żadna zwrócona wiadomość dotycząca kursu.
ACTIVE Szkolenie jest aktywne.
ARCHIVED Szkolenie zostało zarchiwizowane. Nie możesz go modyfikować, chyba że zmienisz jego stan.
PROVISIONED Szkolenie zostało utworzone, ale nie zostało jeszcze aktywowane. Jest dostępny dla nauczyciela głównego i administratorów domeny, którzy mogą go zmodyfikować lub zmienić na stan ACTIVE lub DECLINED. Szkolenie można zmienić na PROVISIONED tylko wtedy, gdy ma stan DECLINED.
DECLINED Szkolenie zostało utworzone, ale zostało odrzucone. Dostęp do niego ma właściciel zajęć i administratorzy domeny, ale nie będzie widoczny w interfejsie internetowym. Nie możesz zmodyfikować szkolenia, zmieniając je na stan PROVISIONED. Szkolenie można zmienić na DECLINED tylko wtedy, gdy ma stan PROVISIONED.
SUSPENDED Szkolenie zostało zawieszone. Nie możesz zmodyfikować szkolenia, a jedynie użytkownik wskazany przez ownerId może go wyświetlić. Szkolenie może zostać umieszczone w tym stanie, jeśli potencjalnie narusza Warunki korzystania z usługi.

CourseMaterialSet

Zestaw materiałów wyświetlanych na stronie „Informacje” stronie kursu. Materiały te mogą zawierać 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 dołączone do tego zestawu.

CourseMaterial

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

object (DriveFile)

Załącznik pliku z Dysku Google.
youTubeVideo

object (YouTubeVideo)

Załącznik wideo w YouTube.
form

object (Form)

Załącznik do 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, jak obliczana jest ocena ogólna.
displaySetting

enum (DisplaySetting)

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

object (GradeCategory)

Kategorie ocen dostępne w przypadku zadań w ramach zajęć.

CalculationType

Możliwe metody obliczania oceny ogólnej.

Wartości w polu enum
CALCULATION_TYPE_UNSPECIFIED Nie określono metody. Nigdy nie jest zwracany.
TOTAL_POINTS Ocena ogólna to suma ocen podzielona przez łączną liczbę 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. Nigdy nie jest zwracany.
SHOW_OVERALL_GRADE Pokazuje ocenę ogólną w dzienniku ocen i profilu ucznia, zarówno nauczycielom, jak i uczniom.
HIDE_OVERALL_GRADE Nie pokazuje oceny ogólnej w dzienniku ocen ani w profilu ucznia.
SHOW_TEACHERS_ONLY Pokazuje ocenę ogólną nauczycielom w dzienniku ocen i profilu ucznia. niewidoczne dla uczniów w ich profilach;

Metody

checkAddOnCreationEligibility

 Wskazuje, czy użytkownik może tworzyć załączniki dodatków w ramach danych zajęć.

checkGradingPeriodsSetupEligibility

 Zwraca informację o tym, czy użytkownik może aktualizować ustawienia GradingPeriodSettings w danym kursie.

create

 Tworzy kurs.

delete

 Usuwa zajęcia.

get

 Zwraca kurs.

getGradingPeriodSettings

 Zwraca ustawienia okresu oceniania danego zajęć.

list

 Zwraca listę kursów, które może przeglądać użytkownik wysyłający prośbę, ograniczona do tych, które pasują do żądania.

patch

 Aktualizuje co najmniej jedno pole w kursie.

update

 Aktualizuje kurs.

updateGradingPeriodSettings

 Aktualizuje ustawienia okresu oceniania zajęć.