Method: courses.patch

Aktualisiert ein oder mehrere Felder in einem Kurs.

Diese Methode gibt die folgenden Fehlercodes zurück:

  • PERMISSION_DENIED wenn der anfragende Nutzer nicht berechtigt ist, den angeforderten Kurs zu ändern, oder bei Zugriffsfehlern.
  • NOT_FOUND, wenn kein Kurs mit der angeforderten ID vorhanden ist.
  • INVALID_ARGUMENT, wenn in der Aktualisierungsmaske ungültige Felder angegeben sind oder keine Aktualisierungsmaske angegeben wurde.
  • FAILED_PRECONDITION für die folgenden Anfragenfehler:
    • CourseNotModifiable
    • InactiveCourseOwner
    • IneligibleOwner
    • CourseTitleCannotContainUrl

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
id

string

ID des zu aktualisierenden Kurses. Diese ID kann entweder die von Classroom zugewiesene ID oder ein alias sein.

Suchparameter

Parameter
updateMask

string (FieldMask format)

Maske, die angibt, welche Felder im Kurs aktualisiert werden sollen. Dieses Feld ist für eine Aktualisierung erforderlich. Die Aktualisierung schlägt fehl, wenn ungültige Felder angegeben werden. Die folgenden Felder sind gültig:

  • courseState
  • description
  • descriptionHeading
  • name
  • ownerId
  • room
  • section
  • subject
  • learningStandardSettings
  • levels

Hinweis: Änderungen an „ownerId“ werden sofort wirksam. Es kann jedoch einige Zeit dauern, bis die Inhaberschaft aller betroffenen Ressourcen übertragen wurde.

Wenn dieses Feld in einem Suchparameter festgelegt wird, muss es so angegeben werden:

updateMask=<field1>,<field2>,...

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

enum (PreviewVersion)

Optional. Die Preview-Version der API. Dies muss festgelegt werden, um auf neue API-Funktionen zuzugreifen, die Entwicklern im Vorschauprogramm zur Verfügung stehen.

Anfragetext

Der Anfragetext enthält eine Instanz von Course.

Antworttext

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

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie im Autorisierungsleitfaden.