REST Resource: courses

Ressource: Kurs

Ein Kurs in Classroom

JSON-Darstellung 
{
  "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
}
Felder
id

string

Von Classroom zugewiesene Kennung für diesen Kurs.

Wenn creating a course, können Sie diese Kennung optional auf eine alias string in der Anfrage festlegen, um einen entsprechenden Alias zu erstellen. Die id wird weiterhin von Classroom zugewiesen und kann nach dem Erstellen des Kurses nicht mehr aktualisiert werden.

Wenn Sie dieses Feld in einer Kursaktualisierungsmaske angeben, wird ein Fehler ausgegeben.
name

string

Name des Kurses. Beispiel: „Biologie 10. Klasse“. Der Name ist erforderlich. Er muss zwischen 1 und 750 Zeichen lang und ein gültiger UTF-8-String sein.
section

string

Abschnitt des Kurses. Beispiel: „Zeitraum 2“. Falls festgelegt, muss dieses Feld ein gültiger UTF-8-String sein und darf nicht länger als 2.800 Zeichen sein.
descriptionHeading

string

Optionale Überschrift für die Beschreibung. Beispiel: „Willkommen zum Biologieunterricht in der 10. Klasse.“ Falls festgelegt, muss dieses Feld ein gültiger UTF-8-String sein und darf nicht länger als 3.600 Zeichen sein.
description

string

Optionale Beschreibung. Zum Beispiel: „Wir werden die Struktur von Lebewesen anhand von Lehrbüchern, Gastvorträgen und Laborarbeiten kennenlernen. Freu dich darauf!“ Falls festgelegt, muss dieses Feld ein gültiger UTF‑8-String sein und darf nicht länger als 30.000 Zeichen sein.
room

string

Optionaler Raumstandort. Beispiel: „301“. Falls festgelegt, muss dieses Feld ein gültiger UTF-8-String sein und darf nicht länger als 650 Zeichen sein.
ownerId

string

Die Kennung des Inhabers eines Kurses.

Wenn dieses Feld als Parameter eines create course request angegeben wird, ist es erforderlich. Die Kennung kann einer der folgenden Werte sein:

  • Die numerische Kennung für den Nutzer
  • die E‑Mail-Adresse des Nutzers
  • das Stringliteral "me", das den anfragenden Nutzer angibt

Dies muss in einer Erstellungsanfrage festgelegt werden. Administratoren können dieses Feld auch in einer patch course request angeben, um die Inhaberschaft zu übertragen. In anderen Kontexten ist sie schreibgeschützt.
creationTime

string (Timestamp format)

Erstellungszeitpunkt des Kurses. Wenn Sie dieses Feld in einer Kursaktualisierungsmaske angeben, wird ein Fehler ausgegeben.

Schreibgeschützt.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Zeitpunkt der letzten Aktualisierung dieses Kurses. Wenn Sie dieses Feld in einer Kursaktualisierungsmaske angeben, wird ein Fehler ausgegeben.

Schreibgeschützt.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
enrollmentCode

string

Anmeldecode für die Teilnahme an diesem Kurs. Wenn Sie dieses Feld in einer Kursaktualisierungsmaske angeben, wird ein Fehler ausgegeben.

Schreibgeschützt.
courseState

enum (CourseState)

Status des Kurses. Wenn nicht angegeben, ist der Standardstatus PROVISIONED.
teacherGroupEmail

string

Die E-Mail-Adresse einer Google-Gruppe, die alle Lehrkräfte des Kurses enthält. Diese Gruppe akzeptiert keine E-Mails und kann nur für Berechtigungen verwendet werden.

Schreibgeschützt.
courseGroupEmail

string

Die E-Mail-Adresse einer Google-Gruppe, die alle Mitglieder des Kurses enthält. Diese Gruppe akzeptiert keine E-Mails und kann nur für Berechtigungen verwendet werden.

Schreibgeschützt.
teacherFolder

object (DriveFolder)

Informationen zu einem Google Drive-Ordner, der für alle Kursleiter des Kurses freigegeben ist.

Dieses Feld wird nur für Lehrkräfte des Kurses und Domainadministratoren festgelegt.

Schreibgeschützt.
courseMaterialSets[]
(deprecated)

object (CourseMaterialSet)

Materialien, die auf der Seite „Über diesen Kurs“ angezeigt werden.

Schreibgeschützt.
guardiansEnabled

boolean

Gibt an, ob Benachrichtigungen für Erziehungsberechtigte für diesen Kurs aktiviert sind.

Schreibgeschützt.
calendarId

string

Die Kalender-ID für einen Kalender, der für alle Kursmitglieder sichtbar ist und dem in Classroom Termine für Kursaufgaben und Mitteilungen im Kurs hinzugefügt werden.

Der Kalender für einen Kurs wird asynchron erstellt, wenn der Kurs zum ersten Mal auf CourseState.ACTIVE gesetzt wird (bei der Erstellung oder wenn er über die Benutzeroberfläche oder die API auf ACTIVE aktualisiert wird). Die Kalender-ID wird erst nach Abschluss des Erstellungsvorgangs ausgefüllt.

Schreibgeschützt.
gradebookSettings

object (GradebookSettings)

Die Notenbuch-Einstellungen, in denen festgelegt wird, wie die Gesamtnote eines Schülers/Studenten für den Kurs berechnet wird und wem sie angezeigt wird.

Schreibgeschützt.
subject

string

Optional. Das Thema des Kurses.
learningStandardSettings

object (CourseLearningStandardSettings)

Optional.

Einstellungen für die im Kurs verfügbaren Bildungsstandards. Einem Kurs können maximal fünf Gruppen von Lernstandards zugewiesen werden.
levels

string

Optional. Niveaus für den Kurs. Beispiele: „9. Klasse“, „Mittelschule“, „4. – 5. Klasse“, „K–2“, „3000“. Wenn dieses Feld festgelegt ist, muss es ein gültiger UTF‑8-String mit weniger als 1.000 Zeichen sein.

Dieses Feld kann nur mit der Methode courses.patch gelöscht werden.

CourseState

Mögliche Status eines Kurses.

Enums
COURSE_STATE_UNSPECIFIED Kein Kursstatus. Dieser Wert wird in keiner zurückgegebenen Kursmitteilung verwendet.
ACTIVE Der Kurs ist aktiv.
ARCHIVED Der Kurs wurde archiviert. Sie können ihn nur ändern, indem Sie ihn in einen anderen Status versetzen.
PROVISIONED Der Kurs wurde erstellt, aber noch nicht aktiviert. Sie ist für die primäre Lehrkraft und Domainadministratoren zugänglich, die sie ändern oder in den Status ACTIVE oder DECLINED ändern können. Ein Kurs kann nur in PROVISIONED geändert werden, wenn er den Status DECLINED hat.
DECLINED Der Kurs wurde erstellt, aber abgelehnt. Sie ist für den Kursinhaber und die Domainadministratoren zugänglich, wird aber nicht in der Weboberfläche angezeigt. Sie können den Kurs nur ändern, indem Sie ihn in den Status PROVISIONED versetzen. Ein Kurs kann nur in DECLINED geändert werden, wenn er den Status PROVISIONED hat.
SUSPENDED Der Kurs wurde gesperrt. Sie können den Kurs nicht ändern und nur der Nutzer mit der ID ownerId kann ihn aufrufen. Ein Kurs kann in diesen Status versetzt werden, wenn er möglicherweise gegen die Nutzungsbedingungen verstößt.

CourseMaterialSet

Eine Reihe von Materialien, die auf der Seite „Über“ des Kurses angezeigt werden. Dazu können ein Lehrplan, ein Zeitplan oder andere Hintergrundinformationen zum Kurs insgesamt gehören.

JSON-Darstellung 
{
  "title": string,
  "materials": [
    {
      object (CourseMaterial)
    }
  ]
}
Felder
title

string

Titel für dieses Set.
materials[]

object (CourseMaterial)

Materialien, die dieser Gruppe zugeordnet sind.

CourseMaterial

Ein Material, das als Teil eines Materialsets an einen Kurs angehängt ist.

JSON-Darstellung 
{

  "driveFile": {
    object (DriveFile)
  },
  "youTubeVideo": {
    object (YouTubeVideo)
  },
  "link": {
    object (Link)
  },
  "form": {
    object (Form)
  }
}
Felder
Union-Feld material. Materialdaten Für material ist nur einer der folgenden Werte zulässig:
driveFile

object (DriveFile)

Google Drive-Dateianhang.
youTubeVideo

object (YouTubeVideo)

YouTube-Videoanhang
form

object (Form)

Google Formulare-Anhang

GradebookSettings

Die Notenbuch-Einstellungen für einen Kurs. Weitere Informationen finden Sie in diesem Hilfeartikel.

JSON-Darstellung 
{
  "calculationType": enum (CalculationType),
  "displaySetting": enum (DisplaySetting),
  "gradeCategories": [
    {
      object (GradeCategory)
    }
  ]
}
Felder
calculationType

enum (CalculationType)

Gibt an, wie die Gesamtnote berechnet wird.
displaySetting

enum (DisplaySetting)

Gibt an, wer die Gesamtnote sehen kann.
gradeCategories[]

object (GradeCategory)

Notenkategorien, die für Kursaufgaben im Kurs verfügbar sind.

CalculationType

Mögliche Methoden zur Berechnung der Gesamtnote.

Enums
CALCULATION_TYPE_UNSPECIFIED Keine Methode angegeben. Dieser Wert wird nie zurückgegeben.
TOTAL_POINTS Die Gesamtnote ist die Summe der Noten geteilt durch die Summe der Gesamtpunkte, unabhängig von der Kategorie.
WEIGHTED_CATEGORIES Die Gesamtnote ist der gewichtete Durchschnitt nach Kategorie.

DisplaySetting

Mögliche Einstellungen für die Anzeige der Gesamtnote.

Enums
DISPLAY_SETTING_UNSPECIFIED Es wurde keine Einstellung angegeben. Dieser Wert wird nie zurückgegeben.
SHOW_OVERALL_GRADE Die Gesamtnote wird sowohl Lehrkräften als auch Schülern/Studenten im Notenbuch und im Schüler-/Studentenprofil angezeigt.
HIDE_OVERALL_GRADE Die Gesamtnote wird im Notenbuch oder im Schüler-/Studentenprofil nicht angezeigt.
SHOW_TEACHERS_ONLY Zeigt die Gesamtnote für Lehrkräfte im Notenbuch und im Schüler-/Studentenprofil an. Sie wird Schülern in ihrem Schülerprofil nicht angezeigt.

CourseLearningStandardSettings

Die Einstellungen für Lernstandards für einen Kurs.

JSON-Darstellung 
{
  "standardSets": [
    {
      object (LearningStandardSetRoot)
    }
  ]
}
Felder
standardSets[]

object (LearningStandardSetRoot)

Erforderlich. Die Gruppe der Lernstandard-Roots, die auf diesen Kurs angewendet werden.

LearningStandardSetRoot

Stellt den Stamm einer ausgewählten Gruppe von Bildungsstandards dar. Untergeordnete Elemente der ausgewählten Stammknoten werden angezeigt, wenn Sie in der Classroom-Benutzeroberfläche Lernziele für Stream-Elemente festlegen.

JSON-Darstellung 
{
  "caseGuid": {
    object (CaseGuid)
  },
  "documentTitle": string,
  "standardTitle": string,
  "sourceDataAvailabilityStatus": enum (LearningStandardAvailabilityState)
}
Felder
caseGuid

object (CaseGuid)

Erforderlich. Die Satchel Rosetta Exchange-GUID für einen Stamm eines Lernstandardsets.
documentTitle

string

Nur Ausgabe. Der Dokumenttitel des Lernstandardsets.
standardTitle

string

Nur Ausgabe. Der Titel des Stammelements der Gruppe von Lernstandards.
sourceDataAvailabilityStatus

enum (LearningStandardAvailabilityState)

Nur Ausgabe. Der Verfügbarkeitsstatus des Stammelements der Gruppe von Lernstandards. Damit können Sie feststellen, ob der Stamm des festgelegten Lernstandards aus der Quelle gelöscht wurde.

Methoden

checkAddOnCreationEligibility
(deprecated)

 Gibt zurück, ob ein Nutzer berechtigt ist, Add-on-Anhänge in einem bestimmten Kurs zu erstellen.

checkGradingPeriodsSetupEligibility
(deprecated)

 Gibt zurück, ob ein Nutzer berechtigt ist, die GradingPeriodSettings in einem bestimmten Kurs zu aktualisieren.

create

 Erstellt einen Kurs.

delete

 Löscht einen Kurs.

get

 Gibt einen Kurs zurück.

getGradingPeriodSettings

 Gibt die Einstellungen für den Benotungszeitraum in einem Kurs zurück.

list

 Gibt eine Liste der Kurse zurück, die der anfragende Nutzer ansehen darf. Die Liste ist auf die Kurse beschränkt, die der Anfrage entsprechen.

patch

 Aktualisiert ein oder mehrere Felder in einem Kurs.

update

 Aktualisiert einen Kurs.

updateGradingPeriodSettings

 Aktualisiert die Einstellungen für Benotungszeiträume eines Kurses.