REST Resource: courses.announcements

Ressource: Ankündigung

Von einer Lehrkraft erstellte Ankündigung für Schüler und Studenten 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 für diese Ankündigung, 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 nicht mehr als 20 Materialien enthalten.

state

enum (AnnouncementState)

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

creationTime

string (Timestamp format)

Zeitstempel für die Erstellung dieser Mitteilung.

Schreibgeschützt.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich 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 einer Auflösung im Nanosekundenbereich 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 die geplante Veröffentlichung dieser Mitteilung.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

assigneeMode

enum (AssigneeMode)

Modus „Zugewiesene Person“ der Ankündigung. Wenn keine Vorgabe erfolgt, gilt der Standardwert ALL_STUDENTS.

individualStudentsOptions

object (IndividualStudentsOptions)

IDs der Schüler/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 Mitteilung erstellt hat.

Schreibgeschützt.

AnnouncementState

Mögliche Status von Ankündigungen

Enums
ANNOUNCEMENT_STATE_UNSPECIFIED Kein Status angegeben. Dies wird nie zurückgegeben.
PUBLISHED Status für bereits veröffentlichte Ankündigungen. Dies ist der Standardstatus.
DRAFT Status für eine noch nicht veröffentlichte Ankündigung. Ankündigungen mit diesem Status sind nur für Lehrkräfte und Domainadministratoren sichtbar.
DELETED Status für eine bereits veröffentlichte Ankündigung, die jetzt gelöscht ist. Ankündigungen mit diesem Status sind nur für Lehrkräfte und Domainadministratoren sichtbar. Die Mitteilung mit diesem Status wird nach einiger Zeit gelöscht.

Methoden

create

Erstellt eine Ankündigung.

delete

Löscht die Ankündigung.

get

Gibt eine Ankündigung zurück.

getAddOnContext

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

list

Gibt eine Liste der Ankündigungen zurück, die der Anforderer sehen darf.

modifyAssignees

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

patch

Aktualisiert ein oder mehrere Felder einer Ankündigung.