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

string

Die von Classroom zugewiesene Kennung für diesen Kurs.

Wenn creating a course, können Sie diese ID in der Anfrage optional auf eine alias string 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.

Die Angabe dieses Felds in einer Maske für die Aktualisierung des Kurses führt zu einem Fehler.
name

string

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

string

Abschnitt des Kurses. Beispiel: „Zeitraum 2“. Wenn dieses Feld festgelegt ist, muss es 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. Zum Beispiel: „Willkommen bei der 10. Klasse, Biologie“. Wenn dieses Feld festgelegt ist, muss es 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 aus einer Kombination aus Lehrbüchern, Gastvorträgen und Laborarbeit etwas über den Aufbau von Lebewesen lernen. Seien Sie gespannt!“ Wenn dieses Feld festgelegt ist, muss es ein gültiger UTF-8-String sein und darf nicht länger als 30.000 Zeichen sein.
room

string

Optionaler Raumstandort. Beispiel: „301“. Wenn dieses Feld festgelegt ist, muss es 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 einer create course request angegeben wird, ist es erforderlich. Folgende Kennzeichnungen sind möglich:

  • 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 Anfrage zur Erstellung festgelegt werden. Administratoren können dieses Feld auch in einem patch course request angeben, um die Inhaberschaft zu übertragen. In anderen Kontexten ist sie schreibgeschützt.
creationTime

string (Timestamp format)

Erstellungszeit des Kurses. Die Angabe dieses Felds in einer Maske für die Aktualisierung des Kurses führt zu einem Fehler.

Schreibgeschützt.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Zeitpunkt der letzten Aktualisierung dieses Kurses. Die Angabe dieses Felds in einer Maske für die Aktualisierung des Kurses führt zu einem Fehler.

Schreibgeschützt.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
enrollmentCode

string

Anmeldecode für die Teilnahme an diesem Kurs. Die Angabe dieses Felds in einer Maske für die Aktualisierung des Kurses führt zu einem Fehler.

Schreibgeschützt.
courseState

enum (CourseState)

Status des Kurses. Wenn keine Vorgabe erfolgt, lautet 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 Drive-Ordner, der für alle Lehrkräfte des Kurses freigegeben ist.

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

Schreibgeschützt.
courseMaterialSets[]
(deprecated)

object (CourseMaterialSet)

Gruppen von Materialien, die auf der Seite „Info“ dieses Kurses 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, den alle Kursmitglieder sehen können und dem in Classroom Termine für Kursarbeiten und Ankündigungen im Kurs hinzugefügt werden.

Der Kalender für einen Kurs wird asynchron erstellt, wenn er 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 eingefügt, wenn die Erstellung abgeschlossen ist.

Schreibgeschützt.
gradebookSettings

object (GradebookSettings)

Die Notenbucheinstellungen, mit denen festgelegt wird, wie die Gesamtnote eines Schülers/Studenten für den Kurs berechnet wird und für wen sie sichtbar ist.

Schreibgeschützt

CourseState

Mögliche Status eines Kurses.

Enums
COURSE_STATE_UNSPECIFIED Kein Kursstatus. Dieser Wert wird von keiner zurückgegebenen Kursnachricht verwendet.
ACTIVE Der Kurs ist aktiv.
ARCHIVED Der Kurs wurde archiviert. Sie können ihn nicht ändern, außer ihn in einen anderen Status zu ändern.
PROVISIONED Der Kurs wurde erstellt, aber noch nicht aktiviert. Die primäre Lehrkraft und die Domainadministratoren können darauf zugreifen und sie ändern oder in den Status ACTIVE oder DECLINED ändern. Ein Kurs kann nur zu PROVISIONED geändert werden, wenn er den Status DECLINED hat.
DECLINED Der Kurs wurde erstellt, aber abgelehnt. Der Kursinhaber und die Domainadministratoren können auf den Kurs zugreifen, er wird aber nicht in der Weboberfläche angezeigt. Sie können den Kurs nur ändern, wenn Sie ihn in den Status PROVISIONED versetzen. Ein Kurs kann nur zu DECLINED geändert werden, wenn er den Status PROVISIONED hat.
SUSPENDED Der Kurs wurde gesperrt. Sie können den Kurs nicht ändern. Nur der über die ownerId angegebene Nutzer kann ihn sehen. Ein Kurs kann diesen Status erhalten, wenn er möglicherweise gegen die Nutzungsbedingungen verstößt.

CourseMaterialSet

Eine Reihe von Materialien, die auf der Seite „Info“ des Kurses angezeigt werden. Diese Materialien können einen Lehrplan, einen Zeitplan oder andere Hintergrundinformationen zum gesamten Kurs umfassen.

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

string

Titel für diese Gruppe.
materials[]

object (CourseMaterial)

An diesen Satz angehängte Materialien.

CourseMaterial

Ein Material, das als Teil eines Materialsets einem Kurs beigefügt ist.

JSON-Darstellung 
{

  // 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.
}
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. Dies 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 Keine Einstellung angegeben. Dies wird nie zurückgegeben.
SHOW_OVERALL_GRADE Die Gesamtnote wird Lehrkräften und Schülern/Studenten im Notenbuch und im Schüler-/Studentenprofil angezeigt.
HIDE_OVERALL_GRADE Die Gesamtnote wird nicht im Notenbuch oder im Profil des Schülers/Studenten angezeigt.
SHOW_TEACHERS_ONLY Die Gesamtnote wird Lehrkräften im Notenbuch und im Schüler-/Studentenprofil angezeigt. Wird im Profil des Schülers/Studenten ausgeblendet.

Methoden

checkAddOnCreationEligibility

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

checkGradingPeriodsSetupEligibility

 Gibt zurück, ob ein Nutzer „GradingPeriodSettings“ in einem bestimmten Kurs aktualisieren kann.

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, beschränkt auf die Kurse, die der Anfrage entsprechen.

patch

 Aktualisiert ein oder mehrere Felder in einem Kurs.

update

 Aktualisiert einen Kurs.

updateGradingPeriodSettings

 Aktualisiert die Einstellungen für den Benotungszeitraum eines Kurses.