Eine Guardian-Ressource stellt einen Nutzer dar, z. B. einen Elternteil, der Informationen zu den Kursen und Kursarbeiten eines Schülers erhält. Der Erziehungsberechtigte, der in der Regel kein Mitglied der Classroom-Domain des Schülers oder Studenten ist, muss über seine E‑Mail-Adresse eingeladen werden.
Einladungen werden durch die GuardianInvitation-Ressource dargestellt. Der eingeladene Nutzer erhält eine E‑Mail mit der Aufforderung, die Einladung anzunehmen. Wenn die E‑Mail-Adresse nicht mit einem Google-Konto verknüpft ist, wird der Nutzer aufgefordert, ein Konto zu erstellen, bevor er die Einladung annehmen kann.
Wenn der Nutzer eingeladen wird und bevor er die Einladung annimmt, hat die GuardianInvitation den Status PENDING. Sobald der Nutzer die Einladung annimmt, wird GuardianInvitation als COMPLETED gekennzeichnet und eine Guardian-Ressource wird erstellt.
Der Status GuardianInvitation kann auch in COMPLETED geändert werden, wenn er abläuft oder wenn ein autorisierter Nutzer die Einladung storniert (z. B. mit der Methode PatchGuardianInvitation). Die Beziehung zwischen Erziehungsberechtigten und Schülern kann auch von einem Erziehungsberechtigten, einem Classroom-Kursleiter oder einem Administrator über die Classroom-Webanwendung oder die DeleteGuardian-Methode beendet werden.
Wer darf Erziehungsberechtigte verwalten?
In der folgenden Tabelle werden die Aktionen beschrieben, die in Bezug auf Erziehungsberechtigte ausgeführt werden können, je nach Art des authentifizierten Nutzers:
Bereiche
Es gibt drei Bereiche, mit denen Sie Erziehungsberechtigte verwalten können:
https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly: Die eigenen Erziehungsberechtigten eines Nutzers ansehen.https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly: Erziehungsberechtigte und Einladungen für Erziehungsberechtigte für Schüler und Studenten ansehen, die der Nutzer unterrichtet oder verwaltet.https://www.googleapis.com/auth/classroom.guardianlinks.students: Erziehungsberechtigte und Einladungen für Erziehungsberechtigte für Schüler und Studenten, die der Nutzer unterrichtet oder verwaltet, ansehen und verwalten.
Häufige Aktionen
In diesem Abschnitt werden einige der häufigsten Aktionen beschrieben, die Sie mit der Google Classroom API als Erziehungsberechtigte ausführen können.
Einladung für einen Erziehungsberechtigten erstellen
Das folgende Beispiel zeigt, wie Sie eine Einladung für Erziehungsberechtigte mit der Methode userProfiles.guardianInvitations.create() erstellen können:
Java
Python
guardianInvitation = {
'invitedEmailAddress': 'guardian@gmail.com',
}
guardianInvitation = service.userProfiles().guardianInvitations().create(
studentId='student@mydomain.edu',
body=guardianInvitation).execute()
print("Invitation created with id: {0}".format(guardianInvitation.get('invitationId')))
Die Antwort enthält eine vom Server zugewiesene Kennung, mit der auf die GuardianInvitation verwiesen werden kann.
Einladung zur Elternaufsicht zurücknehmen
Wenn Sie eine Einladung stornieren möchten, ändern Sie den Status der Einladung von PENDING in COMPLETE, indem Sie die Methode userProfiles.guardianInvitations.patch() aufrufen.
Das ist die einzige Möglichkeit, eine Einladung zu entfernen.
Java
Python
guardian_invite = {
'state': 'COMPLETE'
}
guardianInvitation = service.userProfiles().guardianInvitations().patch(
studentId='student@mydomain.edu',
invitationId=1234, # Replace with the invitation ID of the invitation you want to cancel
updateMask='state',
body=guardianInvitation).execute()
Einladungen für einen bestimmten Schüler/Student auflisten
Mit der Methode userProfiles.guardianInvitations.list() können Sie eine Liste aller Einladungen abrufen, die für einen bestimmten Schüler gesendet wurden. Standardmäßig werden nur PENDING-Einladungen zurückgegeben. Ein Domainadministrator kann Einladungen im Status COMPLETED auch abrufen, indem er einen states-Parameter angibt.
Java
Python
guardian_invites = []
page_token = None
while True:
response = service.userProfiles().guardianInvitations().list(
studentId='student@mydomain.edu').execute()
guardian_invites.extend(response.get('guardian_invites', []))
page_token = response.get('nextPageToken', None)
if not page_token:
break
if not courses:
print('No guardians invited for this {0}.'.format(response.get('studentId')))
else:
print('Guardian Invite:')
for guardian in guardian_invites:
print('An invite was sent to '.format(guardian.get('id'),
guardian.get('guardianId')))
Aktive Erziehungsberechtigte auflisten
Mit der Methode userProfiles.guardians.list() können Sie ermitteln, welche Nutzer aktive Erziehungsberechtigte für einen bestimmten Schüler sind. Aktive Erziehungsberechtigte sind Erziehungsberechtigte, die die Einladung angenommen haben.
Java
Python
guardian_invites = []
page_token = None
while True:
response = service.userProfiles().guardians().list(studentId='student@mydomain.edu').execute()
guardian_invites.extend(response.get('guardian_invites', []))
page_token = response.get('nextPageToken', None)
if not page_token:
break
if not courses:
print('No guardians invited for this {0}.'.format(response.get('studentId')))
else:
print('Guardian Invite:')
for guardian in guardian_invites:
print('An invite was sent to '.format(guardian.get('id'),
guardian.get('guardianId')))
Erziehungsberechtigte entfernen
Sie können einen Erziehungsberechtigten auch mit der Methode userProfiles.guardians.delete() aus einem Schüler oder Studenten entfernen:
Java
Python
service.userProfiles().guardians().delete(studentId='student@mydomain.edu',
guardianId='guardian@gmail.com').execute()