Method: userProfiles.guardians.list

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

Wenn Sie die Erziehungsberechtigten aller Schüler auflisten möchten, für die der anfragende Nutzer die Erziehungsberechtigten aufrufen darf, verwenden Sie das buchstäbliche Zeichen - 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 nicht berechtigt ist, die Informationen zum Erziehungsberechtigten für diesen Schüler oder Studenten anzusehen, wenn "-" als studentId angegeben ist und der Nutzer kein Domainadministrator ist, wenn keine Erziehungsberechtigten für die betreffende Domain aktiviert sind, wenn der Filter invitedEmailAddress von einem Nutzer festgelegt wurde, der kein Domainadministrator ist, oder wenn andere Zugriffsfehler vorliegen.
  • INVALID_ARGUMENT, wenn eine studentId angegeben ist, ihr Format jedoch nicht erkannt wird (weder eine E-Mail-Adresse noch ein studentId von der API noch der literale String me). Kann auch zurückgegeben werden, wenn ein ungültiger pageToken angegeben wird.
  • NOT_FOUND, wenn eine studentId angegeben ist und ihr Format erkannt werden kann, aber in Classroom sind keine Aufzeichnungen zu diesem Schüler/Studenten vorhanden.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
studentId

string

Sie können die Ergebnisse nach dem Schüler/Studenten filtern, mit dem der Erziehungsberechtigte verknüpft ist. Folgende Kennzeichnungen sind möglich:

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

Abfrageparameter

Parameter
invitedEmailAddress

string

Sie können die Ergebnisse nach der E-Mail-Adresse filtern, an die die ursprüngliche Einladung gesendet wurde, und so diesen Link für Erziehungsberechtigte erhalten. Dieser Filter kann nur von Domainadministratoren verwendet werden.
pageToken

string

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

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

integer

Maximale Anzahl der Elemente, die zurückgegeben werden sollen. Null oder nicht angegeben bedeutet, dass der Server einen Höchstwert zuweisen kann.

Der Server gibt möglicherweise weniger als die angegebene Anzahl von Ergebnissen 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 Seite mit Ergebnissen, die die in der Anfrage angegebenen Kriterien erfüllt haben.
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.