Method: courses.studentGroups.patch

Aktualisiert ein oder mehrere Felder in einer Schüler-/Studentengruppe.

Diese Methode gibt die folgenden Fehlercodes zurück:

  • PERMISSION_DENIED, wenn der anfragende Nutzer nicht berechtigt ist, die angeforderte Schülergruppe zu ändern, oder bei Zugriffsfehlern.
  • NOT_FOUND, wenn die Schülergruppe nicht vorhanden ist oder der Nutzer keinen Zugriff darauf hat.
  • INVALID_ARGUMENT, wenn in der Aktualisierungsmaske ungültige Felder angegeben sind oder keine Aktualisierungsmaske angegeben wurde.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
courseId

string

Erforderlich. Kennung des Kurses.
id

string

Erforderlich. Kennung der Schüler-/Studentengruppe.

Abfrageparameter

Parameter
updateMask

string (FieldMask format)

Erforderlich. Maske, die angibt, welche Felder in der Schüler-/Studentengruppe aktualisiert werden sollen. Dieses Feld ist für ein Update erforderlich. Die Aktualisierung schlägt fehl, wenn ungültige Felder angegeben sind.

Lehrkräfte können die folgenden Felder angeben:

  • title

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

enum (PreviewVersion)

Optional. Die Vorschauversion des Endpunkts. Diese Einstellung ist erforderlich, um auf neue API-Funktionen zuzugreifen, die Entwicklern im Vorabversionsprogramm zur Verfügung gestellt werden.

Anfragetext

Der Anfragetext enthält eine Instanz von StudentGroup.

Antworttext

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

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie im Autorisierungsleitfaden.