Method: userProfiles.guardians.list

Gibt eine Liste der Erziehungsberechtigten zurück, die der anfragende Nutzer aufrufen darf, beschränkt auf diejenigen, die der Anfrage entsprechen.

Wenn Sie Erziehungsberechtigte für alle Schüler/Studenten auflisten möchten, für die der anfragende Nutzer Erziehungsberechtigte sehen kann, verwenden Sie das Literalzeichen - für die Schüler-/Studenten-ID.

Diese Methode gibt die folgenden Fehlercodes zurück:

  • PERMISSION_DENIED, wenn eine studentId angegeben ist und der anfragende Nutzer keine Informationen zu Erziehungsberechtigten für diesen Schüler/Studenten einsehen darf, wenn "-" als studentId angegeben ist und der Nutzer kein Domainadministrator ist, wenn Erziehungsberechtigte für die betreffende Domain nicht aktiviert sind, wenn der invitedEmailAddress-Filter von einem Nutzer festgelegt wurde, der kein Domainadministrator ist, oder bei anderen Zugriffsfehlern.
  • INVALID_ARGUMENT, wenn ein studentId angegeben ist, dessen Format jedoch nicht erkannt werden kann (es ist keine E-Mail-Adresse, kein studentId aus der API und kein Literalstring me). Kann auch zurückgegeben werden, wenn ein ungültiger pageToken angegeben wird.
  • NOT_FOUND, wenn eine studentId angegeben ist und das Format erkannt werden kann, in Classroom aber keine Daten zu diesem 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 oder Studenten filtern, mit dem der Erziehungsberechtigte verknüpft ist. Die Kennung kann eine der folgenden sein:

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

Abfrageparameter

Parameter
invitedEmailAddress

string

Filtern Sie die Ergebnisse nach der E-Mail-Adresse, an die die ursprüngliche Einladung gesendet wurde, die zu diesem Elternteil-Link geführt hat. Dieser Filter kann nur von Domainadministratoren verwendet werden.
pageToken

string

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.
pageSize

integer

Die maximale Anzahl der Elemente, die zurückgegeben werden sollen. „0“ oder „nicht angegeben“ bedeutet, dass der Server ein Maximum zuweisen kann.

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

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwort, wenn Erziehungsberechtigte angegeben werden.

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 Seite mit Ergebnissen, die die in der Anfrage angegebenen Kriterien erfüllen.
nextPageToken

string

Token, das die nächste Ergebnisseite identifiziert, die zurückgegeben werden soll. Ist das Feld leer, 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.