Eine Ressource für Erziehungsberechtigte steht für einen Nutzer, beispielsweise einen Elternteil, der Informationen über die Kurse und Aufgaben eines Schülers/Studenten erhält. Der Erziehungsberechtigte, der normalerweise kein Mitglied der Classroom-Domain des Schülers oder Studenten ist, muss mit seiner E-Mail-Adresse eingeladen werden, ein Erziehungsberechtigter zu werden.
Mit dieser Einladung wird eine Ressource vom Typ "GuardianInvitation" mit dem Status PENDING erstellt. Der Nutzer erhält dann 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 annimmt.
Während die Einladung den Status PENDING hat, kann der Nutzer die Einladung annehmen. Dadurch wird eine Guardian-Ressource erstellt und die Guardian-Einladung mit dem Status COMPLETED gekennzeichnet. Eine Einladung kann auch zu COMPLETED werden, wenn sie abläuft oder wenn ein autorisierter Nutzer die Einladung zurückzieht (z. B. mit der Methode PatchGuardianInvitation). Eine Guardian-Beziehung kann auch von einem Erziehungsberechtigten, einer Classroom-Lehrkraft oder einem Administrator über die Classroom-Benutzeroberfläche oder die DeleteGuardian-Methode unterbrochen werden.
Wer darf Erziehungsberechtigte verwalten?
In der folgenden Tabelle werden die Aktionen beschrieben, die je nach Art des authentifizierten Nutzers für Erziehungsberechtigte ausgeführt werden können:
Ebenen
Es gibt drei Bereiche, mit denen Sie Erziehungsberechtigte verwalten können:
- Mit https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly können Sie die eigenen Erziehungsberechtigten eines Nutzers aufrufen.
- Mit https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly können Sie Erziehungsberechtigte und Erziehungsberechtigte für Teilnehmer aufrufen, die der Nutzer unterrichtet oder verwaltet.
- Über https://www.googleapis.com/auth/classroom.guardianlinks.students können Sie Erziehungsberechtigte und Erziehungsberechtigte für Teilnehmer aufrufen und ändern, die der Nutzer unterrichtet oder verwaltet.
Häufige Aktionen
In diesem Abschnitt werden einige häufige Aktionen von Erziehungsberechtigten beschrieben, die Sie mit der Google Classroom API ausführen können.
Einladung für Erziehungsberechtigte erstellen
Das folgende Beispiel zeigt, wie Sie eine Einladung für Erziehungsberechtigte mit der Methode userProfiles.guardianInvitations.create() erstellen:
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')))
Das Ergebnis enthält eine vom Server zugewiesene Kennung, mit der auf die GuardianInvitation verwiesen werden kann.
Einladung eines Erziehungsberechtigten zurücknehmen
Das folgende Beispiel zeigt, wie Sie eine Einladung mithilfe der Methode userProfiles.guardianInvitations.patch() zurücknehmen können:
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 oder Studenten auflisten
Mit der Methode userProfiles.guardianInvitations.list() können Sie eine Liste aller Einladungen abrufen, die für einen bestimmten Schüler/Studenten gesendet wurden:
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')))
Standardmäßig werden nur PENDING Einladungen zurückgegeben. Als Domainadministrator können Sie auch Einladungen im Status COMPLETED abrufen, indem Sie einen Parameter „states“ angeben.
Aktive Erziehungsberechtigte auflisten
Wenn Sie ermitteln möchten, welche Nutzer aktive Erziehungsberechtigte für einen bestimmten Schüler oder Studenten sind, können Sie die Methode userProfiles.guardians.list() verwenden. Aktive Erziehungsberechtigte sind Erziehungsberechtigte, die die E-Mail-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 mit der Methode userProfiles.guardians.delete() auch einen Erziehungsberechtigten von einem Schüler oder Studenten entfernen:
Java
Python
service.userProfiles().guardians().delete(studentId='student@mydomain.edu',
guardianId='guardian@gmail.com').execute()