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

REST Resource: userProfiles.guardianInvitations

Ressource: GuardianInvitation

Eine Einladung, der Erziehungsberechtigte eines bestimmten Nutzers zu werden, die an eine bestimmte E-Mail-Adresse gesendet wurde.

JSON-Darstellung
{
  "studentId": string,
  "invitationId": string,
  "invitedEmailAddress": string,
  "state": enum (GuardianInvitationState),
  "creationTime": string
}
Felder
studentId

string

ID des Schülers (im Standardformat)

invitationId

string

Eindeutige Kennung für diese Einladung.

Schreibgeschützt.

invitedEmailAddress

string

E-Mail-Adresse, an die die Einladung gesendet wurde. Dieses Feld ist nur für Domainadministratoren sichtbar.

state

enum (GuardianInvitationState)

Der Status, in dem sich diese Einladung befindet.

creationTime

string (Timestamp format)

Der Zeitpunkt, zu dem diese Einladung erstellt wurde

Schreibgeschützt.

Zeitstempel im Format RFC3339 UTC ZuZulu“ mit einer Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

GuardianInvitationState

Status der Einladung eines Erziehungsberechtigten.

Enums
GUARDIAN_INVITATION_STATE_UNSPECIFIED Sollte nie zurückgegeben werden.
PENDING Die Einladung ist aktiv und wartet auf eine Antwort.
COMPLETE Die Einladung ist nicht mehr aktiv. Er wurde akzeptiert, abgelehnt, zurückgezogen oder ist abgelaufen.

Methoden

create

Es wird eine Einladung für Erziehungsberechtigte erstellt. Der Erziehungsberechtigte wird per E-Mail gebeten, zu bestätigen, dass er der Erziehungsberechtigte des Kindes ist.

get

Gibt eine bestimmte Einladung für Erziehungsberechtigte zurück.

list

Gibt eine Liste der Einladungen von Erziehungsberechtigten zurück, die der anfragende Nutzer ansehen darf. Diese Liste ist nach den angegebenen Parametern gefiltert.

patch

Ändert die Einladung eines Erziehungsberechtigten.