REST Resource: courses

Zasób: Course

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

string

Identyfikator zajęć przypisany przez Classroom.

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

Podanie tego pola w masce aktualizacji kursu powoduje błąd.
name

string

Nazwa kursu. 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 zawierać prawidłowy ciąg znaków w formacie UTF-8 i nie może mieć więcej niż 2800 znaków.
descriptionHeading

string

Opcjonalny nagłówek opisu. Na przykład „Witamy na zajęciach z biologii dla klasy 10”. Jeśli to pole jest ustawione, musi zawierać prawidłowy ciąg UTF-8 o długości nieprzekraczającej 3600 znaków.
description

string

Opcjonalny opis. Na przykład: „Będziemy się uczyć o strukturze organizmów żywych na podstawie podręczników, wykładów gościnnych i zajęć laboratoryjnych. Bądźcie podekscytowani!” Jeśli to pole jest ustawione, musi zawierać prawidłowy ciąg znaków UTF-8 i nie może mieć więcej niż 30 tys. znaków.
room

string

Opcjonalna lokalizacja pokoju. Na przykład „301”. Jeśli jest ustawione, to pole musi zawierać prawidłowy ciąg znaków w formacie UTF-8 i nie może mieć więcej niż 650 znaków.
ownerId

string

Identyfikator właściciela zajęć.

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

  • identyfikator liczbowy użytkownika;
  • adres e-mail użytkownika.
  • ciąg znaków "me" wskazujący użytkownika, który wysłał żądanie;

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

string (Timestamp format)

Czas utworzenia kursu. Podanie tego pola w masce aktualizacji kursu powoduje błąd.

Tylko do odczytu.

Sygnatura czasowa w formacie UTC „Zulu” zdefiniowanym w dokumencie RFC 3339, z dokładnością do nanosekund i maksymalnie 9 miejsc 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. Podanie tego pola w masce aktualizacji kursu powoduje błąd.

Tylko do odczytu.

Sygnatura czasowa w formacie UTC „Zulu” zdefiniowanym w dokumencie RFC 3339, z dokładnością do nanosekund i maksymalnie 9 miejsc po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
enrollmentCode

string

Kod rejestracji do użycia podczas rejestracji na ten kurs. Podanie tego pola w masce aktualizacji kursu powoduje błąd.

Tylko do odczytu.
courseState

enum (CourseState)

Stan kursu. Jeśli nie określisz tego ustawienia, zostanie użyta wartość domyślna PROVISIONED.
teacherGroupEmail

string

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

Tylko do odczytu.
courseGroupEmail

string

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

Tylko do odczytu.
teacherFolder

object (DriveFolder)

informacje o folderze na Dysku udostępnionym wszystkim nauczycielom kursu;

To pole będzie ustawiane 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” danego kursu.

Tylko do odczytu.
guardiansEnabled

boolean

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

Tylko do odczytu.
calendarId

string

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

Kalendarz zajęć jest tworzony asynchronicznie, gdy zajęcia po raz pierwszy zostaną ustawione jako CourseState.ACTIVE (w momencie utworzenia lub gdy zostaną zaktualizowane do ACTIVE za pomocą interfejsu lub 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 danego kursu i kto będzie mieć do niej dostęp.

Tylko do odczytu

CourseState

Możliwe stany zajęć.

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 Szkolenie jest aktywne.
ARCHIVED Zajęcia zostały zarchiwizowane. Nie możesz go modyfikować, z wyjątkiem zmiany stanu.
PROVISIONED Kurs został utworzony, ale nie został jeszcze aktywowany. Jest ona dostępna dla nauczyciela głównego i administratorów domeny, którzy mogą ją modyfikować lub zmieniać na ACTIVE lub DECLINED. Kurs można zmienić na PROVISIONED tylko wtedy, gdy ma stan DECLINED.
DECLINED Kurs został utworzony, ale został odrzucony. Jest ona dostępna dla właściciela kursu i administratorów domen, ale nie będzie wyświetlana w interfejsie internetowym. Nie możesz modyfikować kursu, z wyjątkiem zmiany jego stanu na PROVISIONED. Kurs można zmienić na DECLINED tylko wtedy, gdy ma stan PROVISIONED.
SUSPENDED Kurs został zawieszony. Nie możesz modyfikować kursu. Tylko użytkownik z identyfikatorem ownerId może go wyświetlać. Kurs może zostać umieszczony w tym stanie, jeśli potencjalnie narusza Warunki korzystania z usługi.

CourseMaterialSet

Zestaw materiałów, który pojawia się na stronie „Informacje” kursu. Materiały te mogą obejmować program nauczania, harmonogram lub inne informacje dotyczące kursu jako całości.

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 zajęć 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 unii material. Dane dotyczące materiału. material może być tylko jednym z tych elementów:
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 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 jest obliczana ocena ogólna.
displaySetting

enum (DisplaySetting)

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

object (GradeCategory)

Kategorie ocen dostępne dla zadań na zajęciach.

CalculationType

Możliwe metody obliczania ogólnej oceny

Wartości w polu enum
CALCULATION_TYPE_UNSPECIFIED Nie określono metody. Ten parametr nigdy nie jest zwracany.
TOTAL_POINTS Ocena ogólna to suma ocen podzielona przez sumę łącznej liczby punktów bez względu na kategorię.
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 Brak ustawień. Ten parametr nigdy nie jest zwracany.
SHOW_OVERALL_GRADE Ogólna ocena jest widoczna w dzienniku i na profilu ucznia zarówno dla nauczycieli, jak i uczniów.
HIDE_OVERALL_GRADE Nie wyświetla oceny ogólnej w dzienniku ocen ani na profilu ucznia.
SHOW_TEACHERS_ONLY Ogólna ocena jest widoczna dla nauczycieli w dzienniku i na profilu ucznia. Uczeń nie widzi go na swoim 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 zaktualizować ustawienia GradingPeriodSettings w danym kursie.

create

 tworzy kurs.

delete

 usuwa zajęcia,

get

 Zwraca kurs.

getGradingPeriodSettings

 Zwraca ustawienia okresu oceniania na zajęciach.

list

 Zwraca listę zajęć, które użytkownik może wyświetlić, ograniczając ją do tych, które pasują do żądania.

patch

 Zaktualizuje co najmniej 1 pole w kursie.

update

 Aktualizuje zajęcia.

updateGradingPeriodSettings

 Aktualizuje ustawienia okresu oceniania w kursie.