REST Resource: courses.announcements

Ressource: Ankündigung

Von einer Lehrkraft erstellte Ankündigung für die Teilnehmer des Kurses

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

ID des Kurses.

Schreibgeschützt.

id

string

Die von Classroom zugewiesene ID dieser Ankündigung, die pro Kurs eindeutig ist.

Schreibgeschützt.

text

string

Beschreibung dieser Mitteilung. Der Text muss ein gültiger UTF-8-String sein,der nicht mehr als 30.000 Zeichen enthält.

materials[]

object (Material)

Zusätzliche Materialien.

Ankündigungen dürfen nicht mehr als 20 Materialelemente enthalten.

state

enum (AnnouncementState)

Status dieser Mitteilung. Wenn keine Vorgabe erfolgt, gilt der Standardstatus DRAFT.

creationTime

string (Timestamp format)

Zeitstempel für die Erstellung dieser Ankündigung.

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)

Zeitstempel der letzten Änderung an dieser Mitteilung.

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

scheduledTime

string (Timestamp format)

Optionaler Zeitstempel für den Zeitpunkt, zu dem diese Ankündigung voraussichtlich veröffentlicht wird.

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

assigneeMode

enum (AssigneeMode)

Zuweisungsmodus der Ankündigung. Wenn keine Vorgabe erfolgt, gilt der Standardwert ALL_STUDENTS.

individualStudentsOptions

object (IndividualStudentsOptions)

Kennungen der Schüler oder Studenten, die Zugriff auf die Ankündigung haben. 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 oder Studenten die Ankündigung sehen.

creatorUserId

string

ID des Nutzers, der die Ankündigung erstellt hat.

Schreibgeschützt.

Ankündigungsstatus

Mögliche Status von Ankündigungen

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

Methoden

create

Erstellt eine Ankündigung.

delete

Löscht eine Ankündigung.

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 von Ankündigungen zurück, die der Anforderer anzeigen darf.

modifyAssignees

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

patch

Aktualisiert ein oder mehrere Felder einer Ankündigung.