Verwenden Ihre Nutzer Classroom mit Google Meet? Sehen Sie sich die Apps Script-Kurzanleitung zum Ansehen der Teilnahme von Schülern/Studenten in Google Meet-Kursen an.

Method: userProfiles.guardians.list

Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.

Gibt eine Liste der Erziehungsberechtigten zurück, die der anfragende Nutzer sehen darf und auf die Anfragen beschränkt ist.

Wenn Sie Erziehungsberechtigte für einen Schüler oder Studenten auflisten möchten, für den sich der anfragende Nutzer ansehen kann, verwenden Sie für die Schüler-/Studenten-ID das Literalzeichen -.

Diese Methode gibt die folgenden Fehlercodes zurück:

  • PERMISSION_DENIED, wenn eine studentId angegeben ist und der anfragende Nutzer nicht berechtigt ist, Informationen zu Erziehungsberechtigten für diesen Schüler/Studenten anzusehen, wenn "-" als studentId angegeben ist und der Nutzer kein Domainadministrator ist, wenn die Erziehungsberechtigten für die betreffende Domain nicht aktiviert sind, 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 aber nicht erkannt werden kann. Es handelt sich weder um eine E-Mail-Adresse noch um eine studentId aus der API oder um den literalen String me. Kann auch zurückgegeben werden, wenn eine ungültige pageToken angegeben wird.
  • NOT_FOUND, wenn eine studentId angegeben ist und ihr Format erkannt werden kann, in Classroom jedoch keine Aufzeichnungen zu diesem Schüler/Studenten vorliegen.

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 Schüler oder Studenten zurückgegeben werden sollen, auf die der anfragende Nutzer Zugriff hat.

Abfrageparameter

Parameter
invitedEmailAddress

string

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

pageToken

string

nextPageToken-Wert, der von einem vorherigen list-Aufruf zurückgegeben wurde. Damit wird angegeben, dass die folgende 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 zurückzugebenden Elemente. Null 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

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

Antwort beim Auflisten von Erziehungsberechtigten.

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

object (Guardian)

Erziehungsberechtigte auf dieser Seite mit Ergebnissen, die den in der Anfrage angegebenen Kriterien entsprechen.

nextPageToken

string

Token, das die nächste Ergebnisseite angibt. 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 Übersicht zu OAuth 2.0.