Method: courses.announcements.patch

Aktualisiert ein oder mehrere Felder einer Ankündigung.

Diese Methode gibt die folgenden Fehlercodes zurück:

  • PERMISSION_DENIED, wenn das anfragende Entwicklerprojekt die entsprechende Mitteilung nicht erstellt hat oder Zugriffsfehler vorliegen.
  • INVALID_ARGUMENT, wenn die Anfrage fehlerhaft ist.
  • FAILED_PRECONDITION, wenn die angeforderte Ankündigung bereits gelöscht wurde.
  • NOT_FOUND, wenn der angeforderte Kurs oder die angeforderte Ankündigung nicht vorhanden ist

HTTP-Anfrage

PATCH https://classroom.googleapis.com/v1/courses/{courseId}/announcements/{id}

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
courseId

string

ID des Kurses. Diese Kennung kann entweder die von Classroom zugewiesene ID oder eine alias sein.
id

string

ID der Mitteilung.

Abfrageparameter

Parameter
updateMask

string (FieldMask format)

Maske, die angibt, welche Felder in der Mitteilung aktualisiert werden sollen. Dieses Feld ist für eine Aktualisierung erforderlich. Die Aktualisierung schlägt fehl, wenn ungültige Felder angegeben sind. Wenn ein Feld leere Werte unterstützt, können Sie es löschen, indem Sie es in der Aktualisierungsmaske und nicht im Objekt „Ankündigung“ angeben. Wenn ein Feld, das keine leeren Werte unterstützt, in die Aktualisierungsmaske aufgenommen und nicht im Ankündigungsobjekt festgelegt ist, wird der Fehler INVALID_ARGUMENT zurückgegeben.

Die folgenden Felder können von Lehrkräften festgelegt werden:

  • text
  • state
  • scheduledTime

Dies ist eine durch Kommas getrennte Liste voll qualifizierter Feldnamen. Beispiel: "user.displayName,photo".

Anfragetext

Der Anfragetext enthält eine Instanz von Announcement.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Announcement.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/classroom.announcements

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.