Method: courses.studentGroups.studentGroupMembers.list

Gibt eine Liste der Schüler/Studenten in einer Gruppe zurück.

Diese Methode gibt die folgenden Fehlercodes zurück:

  • NOT_FOUND, wenn der Kurs oder die Schüler-/Studentengruppe nicht vorhanden ist.

HTTP-Anfrage

GET https://classroom.googleapis.com/v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
courseId

string

Erforderlich. Die Kennung des Kurses.

studentGroupId

string

Erforderlich. Die Kennung der Schüler-/Studentengruppe.

Abfrageparameter

Parameter
pageSize

integer

Maximale Anzahl der zurückzugebenden Elemente. Wenn der Wert 0 oder nicht angegeben ist, kann der Server ein Maximum zuweisen.

Der Server gibt möglicherweise weniger als die angegebene Anzahl von Ergebnissen zurück.

pageToken

string

Der nextPageToken-Wert, der von einem vorherigen list-Aufruf zurückgegeben wurde und angibt, dass die nächste Ergebnisseite zurückgegeben werden soll.

Die list-Anfrage muss ansonsten mit der Anfrage identisch sein, die zu diesem Token geführt hat.

previewVersion

enum (PreviewVersion)

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

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwort beim Auflisten von Schülern/Studenten in einer Gruppe.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung
{
  "studentGroupMembers": [
    {
      object (StudentGroupMember)
    }
  ],
  "nextPageToken": string
}
Felder
studentGroupMembers[]

object (StudentGroupMember)

Die Mitglieder der Schüler-/Studentengruppe.

nextPageToken

string

Token, das die nächste Ergebnisseite identifiziert, die zurückgegeben werden soll. Wenn das Feld leer ist, sind keine weiteren Ergebnisse verfügbar.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie im Autorisierungsleitfaden.