REST Resource: courses.announcements

Ressource: Mitteilung

Eine Ankündigung, die von einer Lehrkraft für die Schüler oder 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

Die von Classroom zugewiesene Kennung dieser Mitteilung, die pro 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 nicht mehr als 20 Materialelemente enthalten.
state

enum (AnnouncementState)

Status dieser Mitteilung. Wenn keine Angabe erfolgt, ist der Standardstatus DRAFT.
creationTime

string (Timestamp format)

Zeitstempel für den Zeitpunkt, zu dem diese Mitteilung erstellt wurde.

Schreibgeschützt.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. 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 dieser Mitteilung.

Schreibgeschützt.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. 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 die geplante Veröffentlichung dieser Mitteilung.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
assigneeMode

enum (AssigneeMode)

Der Modus für die Zuweisung der Mitteilung. Wenn keine Angabe erfolgt, ist der Standardwert ALL_STUDENTS.
individualStudentsOptions

object (IndividualStudentsOptions)

IDs 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/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 der veröffentlichten Ankündigung. Das ist der Standardstatus.
DRAFT Status für eine Ankündigung, die noch nicht veröffentlicht wurde. In diesem Status ist die Ankündigung nur für Kursleiter und Domainadministratoren sichtbar.
DELETED Status für eine Ankündigung, die veröffentlicht, aber jetzt gelöscht wurde. In diesem Status ist die Ankündigung 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 mit Mitteilungen zurück, die der Antragsteller ansehen darf.

modifyAssignees

 Ändert den Modus für die Zuweisung und die Optionen einer Ankündigung.

patch

 Aktualisiert ein oder mehrere Felder einer Mitteilung.