Une ressource de représentant légal représente un utilisateur, comme un parent, qui reçoit des informations sur les cours et le travail d'un élève. Le représentant légal, qui n'est généralement pas membre du domaine Classroom de l'élève, doit être invité à devenir représentant légal à l'aide de son adresse e-mail.
Cette invitation crée une ressource GuardianInvitation avec un état de PENDING. L'utilisateur reçoit ensuite un e-mail l'invitant à accepter l'invitation. Si l'adresse e-mail n'est pas associée à un compte Google, l'utilisateur est invité à en créer un avant d'accepter l'invitation.
Bien que l'invitation soit à l'état PENDING, l'utilisateur peut accepter l'invitation, ce qui crée une ressource Guardian et lui attribue l'état COMPLETED. Une invitation peut également devenir COMPLETED si elle expire ou si un utilisateur autorisé l'annule (par exemple, à l'aide de la méthode PatchGuardianInvitation). Un représentant légal, un enseignant Classroom ou un administrateur peut également mettre fin à une relation de représentant légal à l'aide de l'interface utilisateur Classroom ou de la méthode DeleteGuardian.
Qui peut gérer les représentants légaux
Le tableau suivant décrit les actions pouvant être effectuées par rapport aux représentants légaux, en fonction du type d'utilisateur actuellement authentifié:
Niveaux d'accès
Trois niveaux d'accès vous permettent de gérer les représentants légaux:
- https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly vous permet d'afficher les propres représentants légaux d'un utilisateur.
- https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly vous permet d'afficher les représentants légaux et les invitations aux représentants légaux des élèves que l'utilisateur enseigne ou administre.
- https://www.googleapis.com/auth/classroom.guardianlinks.students vous permet d'afficher et de modifier les représentants légaux et les invitations de représentants légaux pour les élèves que l'utilisateur enseigne ou administre.
Actions courantes
Cette section décrit certaines des actions courantes que vous pouvez effectuer en tant que responsable légal à l'aide de l'API Google Classroom.
Créer une invitation de représentant légal
L'exemple suivant montre comment créer une invitation de responsable à l'aide de la méthode userProfiles.guardianInvitations.create():
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')))
Le résultat inclut un identifiant attribué par le serveur qui peut être utilisé pour faire référence à l'objet GuardianInvitation.
Annuler une invitation de responsable
Pour annuler une invitation, modifiez son état de PENDING à COMPLETE en appelant la méthode userProfiles.guardianInvitations.patch().
Notez qu'il s'agit actuellement du seul moyen de supprimer une invitation.
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()
Lister les invitations d'un élève spécifique
Vous pouvez obtenir la liste de toutes les invitations envoyées pour un élève spécifique à l'aide de la méthode userProfiles.guardianInvitations.list():
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')))
Par défaut, seules les invitations PENDING sont renvoyées. En tant qu'administrateur de domaine, vous pouvez également récupérer les invitations à l'état COMPLETED en fournissant un paramètre d'état.
Lister les représentants légaux actifs
Si vous souhaitez déterminer quels utilisateurs sont des représentants légaux actifs pour un élève spécifique, vous pouvez utiliser la méthode userProfiles.guardians.list(). Les représentants légaux actifs sont ceux qui ont accepté l'invitation par e-mail.
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')))
Supprimer des représentants légaux
Vous pouvez également supprimer un représentant légal d'un élève à l'aide de la méthode userProfiles.guardians.delete():
Java
Python
service.userProfiles().guardians().delete(studentId='student@mydomain.edu',
guardianId='guardian@gmail.com').execute()