Verwenden Ihre Nutzer Classroom mit Google Meet? Weitere Informationen finden Sie unter Apps Script – Kurzanleitung.

Method: userProfiles.guardians.list

Gibt eine Liste der Erziehungsberechtigten zurück, die der anfragende Nutzer ansehen darf. Sie erhalten nur diejenigen, die der Anfrage entsprechen.

Wenn Sie Erziehungsberechtigte für jeden Schüler oder Studenten auflisten möchten, für den dieser Erziehungsberechtigte Erziehungsberechtigte aufrufen darf, verwenden Sie das Literalzeichen - für die Teilnehmer-ID.

Diese Methode gibt die folgenden Fehlercodes zurück:

  • PERMISSION_DENIED, wenn ein studentId angegeben ist und der anfragende Nutzer keine Informationen zu Erziehungsberechtigten für diesen Schüler ansehen darf, wenn "-" als studentId angegeben ist und der Nutzer kein Domainadministrator ist, Wenn Erziehungsberechtigte für die betreffende Domain nicht aktiviert sind, wenn der Filter invitedEmailAddress von einem Nutzer festgelegt wurde, der kein Domainadministrator ist, oder wenn andere Zugriffsfehler auftreten.
  • INVALID_ARGUMENT, wenn ein studentId angegeben wird, sein Format jedoch nicht erkannt wird (es ist weder eine E-Mail-Adresse noch ein studentId-Wert aus der API oder der Literalstring me). Kann auch zurückgegeben werden, wenn eine ungültige pageToken angegeben wurde.
  • NOT_FOUND, wenn eine studentId angegeben und ihr Format erkannt wird. Classroom hat aber keine Informationen zu diesem Schüler/Studenten.

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/Studenten filtern, mit dem der Erziehungsberechtigte verknüpft ist Die Kennung kann eine der folgenden sein:

  • Die numerische Kennung für den Nutzer
  • die E-Mail-Adresse des Nutzers
  • Das Stringliteral "me", das den anfragenden Nutzer angibt
  • Das Stringliteral "-" gibt an, dass Ergebnisse für alle Kursteilnehmer zurückgegeben werden sollen, auf die der anfragende Nutzer zugreifen kann.

Suchparameter

Parameter
invitedEmailAddress

string

Ergebnisse nach der E-Mail-Adresse filtern, an die die ursprüngliche Einladung gesendet wurde. Dadurch ergibt sich dieser Link zu Erziehungsberechtigten. Dieser Filter kann nur von Domainadministratoren verwendet werden.

pageToken

string

nextPageToken-Wert aus einem vorherigen list-Aufruf, der angibt, dass die nachfolgende Ergebnisseite zurückgegeben werden soll.

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

pageSize

integer

Maximale Anzahl der Artikel, die zurückgegeben werden sollen. Null oder keine Angabe gibt an, 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

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

Antwort beim Auflisten der Erziehungsberechtigten.

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 angibt, 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 in der OAuth 2.0-Übersicht.