Method: userProfiles.guardians.list

Gibt eine Liste der Erziehungsberechtigten zurück, die der anfragende Nutzer einsehen darf, wobei die Betreuer auf die Erziehungsberechtigten beschränkt sind, die der Anfrage entsprechen.

Wenn Sie die Erziehungsberechtigten für jeden Schüler auflisten möchten, deren Erziehungsberechtigte der anfragende Nutzer sehen kann, verwenden Sie - als Schüler-/Studentenausweis.

Diese Methode gibt die folgenden Fehlercodes zurück:

  • PERMISSION_DENIED, wenn ein studentId angegeben ist und der anfragende Nutzer nicht berechtigt ist, Informationen zu den Erziehungsberechtigten für diesen Schüler anzusehen, wenn "-" als studentId angegeben ist und der Nutzer kein Domainadministrator ist, wenn keine Erziehungsberechtigten für die betreffende Domain aktiviert sind, der invitedEmailAddress-Filter von einem Nutzer festgelegt wurde, der kein Domainadministrator ist, oder andere Zugriffsfehler vorliegen.
  • INVALID_ARGUMENT, wenn eine studentId angegeben ist, ihr Format jedoch nicht erkannt werden kann (es ist weder eine E-Mail-Adresse noch ein studentId von der API oder der literale String me). Kann auch zurückgegeben werden, wenn ein ungültiger pageToken angegeben wird.
  • NOT_FOUND, wenn studentId angegeben wurde und sein Format erkannt werden kann, in Classroom aber keine Aufzeichnungen über diesen Schüler/Studenten vorhanden sind.

HTTP-Anfrage

GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardians

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
studentId

string

Ergebnisse nach dem Schüler filtern, mit dem der Erziehungsberechtigte verknüpft ist Folgende Kennzeichnungen sind möglich:

  • Numerische Kennung des Nutzers
  • die E-Mail-Adresse des Nutzers
  • das String-Literal "me", das den anfragenden Nutzer angibt
  • das Stringliteral "-", das angibt, dass für alle Schüler und Studenten, auf die der anfragende Nutzer Zugriff hat, Ergebnisse zurückgegeben werden sollen.

Abfrageparameter

Parameter
invitedEmailAddress

string

Sie können die Ergebnisse nach der E-Mail-Adresse filtern, an die die ursprüngliche Einladung gesendet wurde, sodass dieser Link für Erziehungsberechtigte angezeigt wird. Dieser Filter kann nur von Domainadministratoren verwendet werden.

pageToken

string

nextPageToken-Wert, der von einem vorherigen list-Aufruf zurückgegeben wurde. Dieser gibt an, dass die nachfolgende Ergebnisseite zurückgegeben werden soll.

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

pageSize

integer

Maximale Anzahl der Artikel, die zurückgegeben werden sollen. Null oder nicht angegeben bedeutet, dass der Server ein Maximum zuweisen kann.

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

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwort beim Auflisten der Erziehungsberechtigten.

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

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

object (Guardian)

Erziehungsberechtigte auf dieser Ergebnisseite, die den im Ersuchen angegebenen Kriterien entsprechen.

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.guardianlinks.me.readonly
  • https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly
  • https://www.googleapis.com/auth/classroom.guardianlinks.students

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.