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

Von Classroom zugewiesene ID für diesen Kurs.

Wenn creating a course, können Sie diese ID 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 Maske zur Kursaktualisierung angeben, wird ein Fehler ausgegeben.

name

string

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

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. 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. Beispiel: „Wir werden die Struktur von Lebewesen anhand einer Kombination aus Lehrbüchern, Gastvorträgen und Laborarbeiten kennenlernen. Ich freue mich schon darauf.“ 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 ID des Kursinhabers.

Wenn dieses Feld als Parameter für create course request angegeben wird, ist es erforderlich. Folgende Kennzeichnungen sind möglich:

  • Numerische Kennung des Nutzers
  • die E-Mail-Adresse des Nutzers
  • das String-Literal "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 sind sie schreibgeschützt.

creationTime

string (Timestamp format)

Erstellungszeit des Kurses. Wenn Sie dieses Feld in einer Maske zur Kursaktualisierung angeben, wird ein Fehler ausgegeben.

Schreibgeschützt.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung 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. Wenn Sie dieses Feld in einer Maske zur Kursaktualisierung angeben, wird ein Fehler ausgegeben.

Schreibgeschützt.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung 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. Wenn Sie dieses Feld in einer Maske zur Kursaktualisierung angeben, wird ein Fehler ausgegeben.

Schreibgeschützt.

courseState

enum (CourseState)

Status des Kurses. Wenn keine Vorgabe erfolgt, gilt der Standardstatus PROVISIONED.

teacherGroupEmail

string

Die E-Mail-Adresse einer Google-Gruppe, in der alle Lehrkräfte des Kurses enthalten sind. 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 Kursmitglieder 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 eines Kalenders, den alle Kursmitglieder sehen können und dem Classroom Termine für Kursarbeiten und Ankündigungen im Kurs hinzufügt.

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 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 wem sie angezeigt wird.

Schreibgeschützt

CourseState

Mögliche Statuswerte für einen Kurs.

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, sondern ihn lediglich in einen anderen Status ändern.
PROVISIONED Der Kurs wurde erstellt, aber noch nicht aktiviert. Die primäre Lehrkraft und die Domainadministratoren können darauf zugreifen und sie bearbeiten oder in den Status ACTIVE oder DECLINED ändern. Ein Kurs kann nur in PROVISIONED geändert werden, wenn er den Status DECLINED hat.
DECLINED Der Kurs wurde erstellt, aber abgelehnt. Der Kursinhaber und die Domainadministratoren haben Zugriff darauf, werden aber nicht in der Web-UI angezeigt. Sie können den Kurs nicht ändern, sondern ihn in den Status PROVISIONED ändern. 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 durch ownerId identifizierte Nutzer kann den Kurs sehen. Ein Kurs kann diesen Status erhalten, wenn er möglicherweise gegen die Nutzungsbedingungen verstößt.

CourseMaterialSet

Eine Reihe von Materialien, die auf der Infoseite des Kurses angezeigt werden. Diese Materialien können einen Lehrplan, einen Zeitplan oder andere Hintergrundinformationen zum Kurs als Ganzes enthalten.

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

string

Titel für diesen Satz.

materials[]

object (CourseMaterial)

An diesen Satz angehängte Materialien.

CourseMaterial

Material, das als Teil eines Materialsatzes an einen Kurs angehängt wurde.

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 Notenbucheinstellungen für einen Kurs. Weitere Informationen

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 ergibt sich aus der Summe der Noten geteilt durch die Gesamtpunktzahl unabhängig von der Kategorie.
WEIGHTED_CATEGORIES Die Gesamtnote ist der nach Kategorie gewichtete Durchschnitt.

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 Zeigt Lehrkräften und Schülern/Studenten die Gesamtnote im Notenbuch und im Profil des Schülers/Studenten an.
HIDE_OVERALL_GRADE Die Gesamtnote wird nicht im Notenbuch oder im Profil des Schülers/Studenten angezeigt.
SHOW_TEACHERS_ONLY Lehrkräften wird im Notenbuch und im Profil des Schülers/Studenten die Gesamtnote angezeigt. Wird im Profil der Schüler/Studenten ausgeblendet.

Methoden

checkAddOnCreationEligibility

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

create

Erstellt einen Kurs.

delete

Löscht einen Kurs.

get

Gibt einen Kurs zurück.

list

Gibt eine Liste der Kurse zurück, die der anfragende Nutzer ansehen darf, wobei die Kurse nur mit der Anfrage übereinstimmen.

patch

Aktualisiert ein oder mehrere Felder in einem Kurs.

update

Aktualisiert einen Kurs.