REST Resource: courses

Zasób: kurs

Zajęcia 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)
  },
  "subject": string,
  "learningStandardSettings": {
    object (CourseLearningStandardSettings)
  },
  "levels": string
}
Pola
id

string

Identyfikator tych zajęć przypisany przez Classroom.

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

Podanie tego pola w masce aktualizacji zajęć spowoduje błąd.
name

string

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

string

Sekcja kursu. Na przykład „Okres 2”. Jeśli to pole jest ustawione, musi być prawidłowym ciągiem znaków UTF-8 i nie może mieć więcej niż 2800 znaków.
descriptionHeading

string

Opcjonalny nagłówek opisu. Na przykład: „Witaj na lekcji biologii w klasie 10”. Jeśli to pole jest ustawione, musi być prawidłowym ciągiem znaków UTF-8 i nie może mieć więcej niż 3600 znaków.
description

string

Opcjonalny opis. Na przykład: „Będziemy uczyć się o strukturze żywych organizmów, korzystając z podręczników, wykładów gościnnych i zajęć laboratoryjnych. Spodziewaj się ekscytacji!” Jeśli to pole jest ustawione, musi być prawidłowym ciągiem znaków UTF-8 i nie może mieć więcej niż 30 000 znaków.
room

string

Opcjonalna lokalizacja sali. Na przykład „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ęć.

To pole jest wymagane, gdy jest określone jako parametr create course request. Identyfikator może być jednym z tych elementów:

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

Należy to ustawić w żądaniu utworzenia. 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. Podanie tego pola w masce aktualizacji zajęć spowoduje błąd.

Tylko do odczytu.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. 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 kursu. Podanie tego pola w masce aktualizacji zajęć spowoduje błąd.

Tylko do odczytu.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. 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 rejestracji, którego należy użyć podczas dołączania do tego kursu. Podanie tego pola w masce aktualizacji zajęć spowoduje błąd.

Tylko do odczytu.
courseState

enum (CourseState)

Stan kursu. Jeśli nie określono inaczej, domyślnym stanem jest 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że być używana tylko do 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że być używana tylko do uprawnień.

Tylko do odczytu.
teacherFolder

object (DriveFolder)

Informacje o folderze na Dysku, który jest udostępniany wszystkim nauczycielom prowadzącym dany kurs.

To pole będzie ustawione 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 na tych zajęciach są włączone powiadomienia dla opiekunów.

Tylko do odczytu.
calendarId

string

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

Kalendarz zajęć jest tworzony asynchronicznie, gdy zajęcia zostaną po raz pierwszy ustawione na CourseState.ACTIVE (w momencie utworzenia lub gdy zostaną zaktualizowane do ACTIVE za pomocą interfejsu użytkownika lub interfejsu API). Identyfikator kalendarza nie zostanie wypełniony, dopóki proces tworzenia nie zostanie zakończony.

Tylko do odczytu.
gradebookSettings

object (GradebookSettings)

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

Tylko do odczytu.
subject

string

Opcjonalnie: Temat kursu.
learningStandardSettings

object (CourseLearningStandardSettings)

Opcjonalnie:

Ustawienia związane ze standardami nauczania dostępnymi na zajęciach. Do kursu można przypisać maksymalnie 20 głównych zestawów standardów nauczania.
levels

string

Opcjonalnie: Poziomy kursu. Przykłady: „9 klasa”, „Gimnazjum”, „4–5”, „K-2”, „3000”. Jeśli to pole jest ustawione, musi być prawidłowym ciągiem znaków UTF-8 i zawierać mniej niż 1000 znaków.

To pole można wyczyścić tylko za pomocą metody courses.patch.

CourseState

Możliwe stany, w których mogą znajdować się zajęcia.

Wartości w polu enum
COURSE_STATE_UNSPECIFIED Brak stanu kursu. Żadna zwrócona wiadomość dotycząca kursu nie będzie używać tej wartości.
ACTIVE Kurs jest aktywny.
ARCHIVED Zajęcia zostały zarchiwizowane. Nie możesz jej zmienić, chyba że chcesz zmienić stan.
PROVISIONED Kurs został utworzony, ale nie został jeszcze aktywowany. Dostęp do niego mają nauczyciel główny i administratorzy domeny, którzy mogą go modyfikować lub zmieniać jego stan na ACTIVE lub DECLINED. Kurs można zmienić na PROVISIONED tylko wtedy, gdy jest w stanie DECLINED.
DECLINED Kurs został utworzony, ale odrzucony. Jest on dostępny dla właściciela zajęć i administratorów domeny, ale nie będzie wyświetlany w interfejsie internetowym. Nie możesz modyfikować kursu, chyba że chcesz zmienić jego stan na PROVISIONED. Kurs można zmienić na DECLINED tylko wtedy, gdy jest w stanie PROVISIONED.
SUSPENDED Kurs został zawieszony. Nie możesz modyfikować kursu, a wyświetlać go może tylko użytkownik określony przez ownerId. Kurs może zostać oznaczony w ten sposób, 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 ogólne 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ł dołączony do kursu jako część zestawu materiałów.

Zapis JSON 
{

  "driveFile": {
    object (DriveFile)
  },
  "youTubeVideo": {
    object (YouTubeVideo)
  },
  "link": {
    object (Link)
  },
  "form": {
    object (Form)
  }
}
Pola
Dane dotyczące materiałów. Poniżej znajduje się lista pól, które wzajemnie się wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
driveFile

object (DriveFile)

Załącznik z Dysku Google.
youTubeVideo

object (YouTubeVideo)

Załącznik z filmem na YouTube.
form

object (Form)

załącznik z Formularzy Google,
Koniec pól wykluczających się wzajemnie.

GradebookSettings

Ustawienia dziennika ocen dla kursu. Więcej informacji znajdziesz w tym artykule w Centrum pomocy.

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

enum (CalculationType)

Wskazuje, jak jest obliczana ocena ogólna.
displaySetting

enum (DisplaySetting)

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

object (GradeCategory)

Kategorie ocen dostępne w przypadku materiałów dydaktycznych na kursie.

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ę wszystkich punktów, niezależnie od kategorii.
WEIGHTED_CATEGORIES Ocena ogólna to średnia ważona według kategorii.

DisplaySetting

Dostępne 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 nauczycielom, jak i uczniom.
HIDE_OVERALL_GRADE Nie pokazuje oceny ogólnej w dzienniku ocen ani na profilu ucznia.
SHOW_TEACHERS_ONLY Pokazuje nauczycielom ocenę ogólną w dzienniku ocen i profilu ucznia. Ukrywa przed uczniami w ich profilu ucznia.

CourseLearningStandardSettings

Ustawienia standardów nauczania dla kursu.

Zapis JSON 
{
  "standardSets": [
    {
      object (LearningStandardSetRoot)
    }
  ]
}
Pola
standardSets[]

object (LearningStandardSetRoot)

Wymagane. Zestaw standardów nauczania zastosowanych do tego kursu.

LearningStandardSetRoot

Reprezentuje katalog główny wybranego zestawu standardów nauczania. Elementy podrzędne wybranych elementów głównych będą wyświetlane podczas ustawiania celów edukacyjnych w elementach strumienia w interfejsie Classroom.

Zapis JSON 
{
  "caseGuid": {
    object (CaseGuid)
  },
  "documentTitle": string,
  "standardTitle": string,
  "sourceDataAvailabilityStatus": enum (LearningStandardAvailabilityState)
}
Pola
caseGuid

object (CaseGuid)

Wymagane. Identyfikator GUID Satchel Rosetta Exchange dla katalogu głównego zestawu standardów nauczania.
documentTitle

string

Tylko dane wyjściowe. Tytuł dokumentu głównego zestawu standardów nauczania.
standardTitle

string

Tylko dane wyjściowe. Tytuł katalogu głównego zestawu standardów nauczania.
sourceDataAvailabilityStatus

enum (LearningStandardAvailabilityState)

Tylko dane wyjściowe. Stan dostępności katalogu głównego zestawu standardów nauczania. Użyj tej opcji, aby określić, czy katalog główny zestawu standardów nauczania został usunięty ze źródła.

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 zaktualizować GradingPeriodSettings na danych zajęciach.

create

 Tworzy kurs.

delete

 Usuwa kurs.

get

 Zwraca kurs.

getGradingPeriodSettings

 Zwraca ustawienia okresu oceniania na kursie.

list

 Zwraca listę zajęć, 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 zajęciach.

update

 Aktualizuje kurs.

updateGradingPeriodSettings

 Aktualizuje ustawienia okresu oceniania kursu.