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.guardianInvitations.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 vom Nutzer angefordert werden dürfen, gefiltert nach den angegebenen Parametern.

Diese Methode gibt die folgenden Fehlercodes zurück:

  • PERMISSION_DENIED, wenn ein studentId angegeben ist und der anfragende Nutzer keine Einladungen zu Erziehungsberechtigten für diesen Schüler/Studenten sehen darf, wenn "-" als studentId angegeben ist und der Nutzer kein Domainadministrator ist, wenn Erziehungsberechtigte nicht für die betreffende Domain aktiviert sind oder wenn andere Zugriffsfehler vorliegen.
  • INVALID_ARGUMENT, wenn ein studentId angegeben ist, sein Format aber nicht erkannt werden kann. Es handelt sich weder um eine E-Mail-Adresse noch um ein studentId aus der API oder das Literalstring me. Kann auch zurückgegeben werden, wenn ein ungültiger pageToken- oder state-Wert angegeben ist.
  • 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}/guardianInvitations

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
studentId

string

Die ID des Schülers/Studenten, dessen Einladungen zu Erziehungsberechtigten zurückgegeben werden sollen. 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 "-", das angibt, dass Ergebnisse für alle Schüler/Studenten zurückgegeben werden sollen, bei denen der anfragende Nutzer die Einladungen zu Erziehungsberechtigten sehen darf

Abfrageparameter

Parameter
invitedEmailAddress

string

Wenn angegeben, werden nur Ergebnisse mit dem angegebenen invitedEmailAddress zurückgegeben.

states[]

enum (GuardianInvitationState)

Wenn angegeben, werden nur Ergebnisse mit den angegebenen state-Werten zurückgegeben. Andernfalls werden Ergebnisse mit einem state von PENDING zurückgegeben.

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 Einladungen an Erziehungsberechtigte.

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

object (GuardianInvitation)

Einladungen von Erziehungsberechtigten, die der Listenanfrage 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.students.readonly
  • https://www.googleapis.com/auth/classroom.guardianlinks.students

Weitere Informationen finden Sie in der Übersicht zu OAuth 2.0.