REST Resource: courses.announcements

Ressource: Ankündigung

Ankündigung, die von einer Lehrkraft für die Schüler/Studenten des Kurses erstellt wurde

JSON-Darstellung
{
  "courseId": string,
  "id": string,
  "text": string,
  "materials": [
    {
      object (Material)
    }
  ],
  "state": enum (AnnouncementState),
  "alternateLink": string,
  "creationTime": string,
  "updateTime": string,
  "scheduledTime": string,
  "assigneeMode": enum (AssigneeMode),
  "individualStudentsOptions": {
    object (IndividualStudentsOptions)
  },
  "creatorUserId": string
}
Felder
courseId

string

Kennung des Kurses.

Schreibgeschützt.

id

string

Von Classroom zugewiesene Kennung dieser Mitteilung, die für jeden Kurs eindeutig ist.

Schreibgeschützt.

text

string

Beschreibung dieser Mitteilung. Der Text muss ein gültiger UTF‑8-String mit maximal 30.000 Zeichen sein.

materials[]

object (Material)

Zusätzliche Materialien

Ankündigungen dürfen maximal 20 Materialelemente enthalten.

state

enum (AnnouncementState)

Status dieser Mitteilung. Wenn nicht angegeben, ist der Standardstatus DRAFT.

creationTime

string (Timestamp format)

Zeitstempel für die Erstellung dieser Ankündigung.

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 dieser Ankündigung.

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, zu dem diese Ankündigung 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)

Zuweisungsmodus der Mitteilung. Wenn nicht angegeben, ist der Standardwert ALL_STUDENTS.

individualStudentsOptions

object (IndividualStudentsOptions)

Kennungen der Schüler/Studenten, die Zugriff auf die Mitteilung haben. Dieses Feld wird nur festgelegt, wenn assigneeMode INDIVIDUAL_STUDENTS ist. Wenn assigneeMode INDIVIDUAL_STUDENTS ist, können nur die in diesem Feld angegebenen Schüler und Studenten die Ankündigung sehen.

creatorUserId

string

Kennung für den Nutzer, der die Mitteilung erstellt hat.

Schreibgeschützt.

AnnouncementState

Mögliche Status von Ankündigungen

Enums
ANNOUNCEMENT_STATE_UNSPECIFIED Kein Status angegeben. Dieser Wert wird nie zurückgegeben.
PUBLISHED Status für eine veröffentlichte Ankündigung. Dies ist der Standardstatus.
DRAFT Status für eine Ankündigung, die noch nicht veröffentlicht wurde. Ankündigungen in diesem Status sind nur für Kursleiter und Domainadministratoren sichtbar.
DELETED Status für eine Ankündigung, die veröffentlicht, aber inzwischen gelöscht wurde. Ankündigungen in diesem Status sind nur für Kursleiter und Domainadministratoren sichtbar. Mitteilungen in diesem Status werden nach einiger Zeit gelöscht.

Methoden

create

Erstellt eine Ankündigung.

delete

Löscht eine Mitteilung.

get

Gibt eine Ankündigung zurück.

getAddOnContext

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

list

Gibt eine Liste der Ankündigungen zurück, die der Anfragende ansehen darf.

modifyAssignees

Ändert den Zuweisungsmodus und die Optionen einer Mitteilung.

patch

Aktualisiert ein oder mehrere Felder einer Ankündigung.