REST Resource: courses.courseWorkMaterials

Ressource: CourseWorkMaterial

Von einer Lehrkraft für die Schüler/Studenten des Kurses erstelltes Kursmaterial

JSON-Darstellung
{
  "courseId": string,
  "id": string,
  "title": string,
  "description": string,
  "materials": [
    {
      object (Material)
    }
  ],
  "state": enum (CourseWorkMaterialState),
  "alternateLink": string,
  "creationTime": string,
  "updateTime": string,
  "scheduledTime": string,
  "assigneeMode": enum (AssigneeMode),
  "individualStudentsOptions": {
    object (IndividualStudentsOptions)
  },
  "creatorUserId": string,
  "topicId": string,
  "learningGoals": [
    {
      object (LearningGoal)
    }
  ]
}
Felder
courseId

string

Kennung des Kurses.

Schreibgeschützt.

id

string

Von Classroom zugewiesene Kennung dieses Kursmaterials, eindeutig pro Kurs.

Schreibgeschützt.

title

string

Titel dieses Kursmaterials. Der Titel muss ein gültiger UTF‑8-String mit einer Länge zwischen 1 und 3.000 Zeichen sein.

description

string

Optionale Beschreibung dieses Kursmaterials. Der Text muss ein gültiger UTF‑8-String mit maximal 30.000 Zeichen sein.

materials[]

object (Material)

Zusätzliche Materialien

Ein Kursmaterial darf maximal 20 Materialelemente enthalten.

state

enum (CourseWorkMaterialState)

Status dieses Kursmaterials. Wenn nicht angegeben, ist der Standardstatus DRAFT.

creationTime

string (Timestamp format)

Zeitstempel für den Zeitpunkt, zu dem dieses Kursmaterial erstellt wurde.

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)

Zeitstempel der letzten Änderung an diesem Kursmaterial.

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".

scheduledTime

string (Timestamp format)

Optionaler Zeitstempel für den Zeitpunkt, zu dem dieses Kursmaterial veröffentlicht werden soll.

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".

assigneeMode

enum (AssigneeMode)

Modus für die Zuweisung des Kursmaterials. Wenn nicht angegeben, ist der Standardwert ALL_STUDENTS.

individualStudentsOptions

object (IndividualStudentsOptions)

Kennungen der Schüler/Studenten mit Zugriff auf das Kursmaterial. Dieses Feld wird nur festgelegt, wenn assigneeMode den Wert INDIVIDUAL_STUDENTS hat. Wenn assigneeMode den Wert INDIVIDUAL_STUDENTS hat, können nur die in diesem Feld angegebenen Schüler/Studenten das Kursmaterial sehen.

creatorUserId

string

Kennung des Nutzers, der das Kursmaterial erstellt hat.

Schreibgeschützt.

topicId

string

Kennung des Themas, mit dem dieses Kursmaterial verknüpft ist. Muss mit einem vorhandenen Thema im Kurs übereinstimmen.

learningGoals[]

object (LearningGoal)

Optional.

Verweise auf alle Lernziele, die mit diesem Kursmaterial verknüpft sind. Ein Kursmaterial kann maximal 10 Lernziele haben. Dieses Feld wird nur ausgefüllt, wenn die entsprechende previewVersion festgelegt ist.

CourseWorkMaterialState

Mögliche Statuswerte für Kursmaterial

Enums
COURSEWORK_MATERIAL_STATE_UNSPECIFIED Kein Status angegeben. Dieser Wert wird nie zurückgegeben.
PUBLISHED Status für veröffentlichtes Kursmaterial. Dies ist der Standardstatus.
DRAFT Status für Kursmaterial, das noch nicht veröffentlicht wurde. Kursmaterial in diesem Status ist nur für Lehrkräfte und Domainadministratoren sichtbar.
DELETED Status für Kursmaterial, das veröffentlicht, aber jetzt gelöscht wurde. Kursmaterial in diesem Status ist nur für Lehrkräfte und Domainadministratoren sichtbar. Kursmaterial in diesem Status wird nach einiger Zeit gelöscht.

Methoden

create

Erstellt ein Kursmaterial.

delete

Löscht ein Kursmaterial.

get

Gibt ein Kursmaterial zurück.

getAddOnContext

Ruft Metadaten für Classroom-Add-ons im Kontext eines bestimmten Beitrags ab.

list

Gibt eine Liste von Kursmaterial zurück, das der Anfragende ansehen darf.

patch

Aktualisiert ein oder mehrere Felder eines Kursmaterials.