Um recurso para o responsável representa um usuário, como um familiar responsável, que recebe informações sobre os cursos e trabalhos de um estudante. O responsável, que normalmente não é membro do domínio do Google Sala de Aula do estudante, precisa ser convidado usando o endereço de e-mail dele para se tornar responsável.
Este convite cria um
recurso "GuardianInvitation
com um estado de PENDING
. Em seguida, o usuário recebe um e-mail pedindo que
aceite o convite. Se o endereço de e-mail não estiver associado a uma Conta do Google, o usuário será solicitado a criar uma antes de aceitar o convite.
Enquanto o convite tem um estado PENDING
, o usuário pode aceitar o
convite, o que cria um recurso "Responsável" e marca o convite
com um estado COMPLETED
. Um convite também pode se tornar COMPLETED
se expirar ou se um usuário autorizado cancelá-lo (por exemplo, usando o método PatchGuardianInvitation
). A relação com os responsáveis também pode ser quebrada por um responsável, um professor do Google Sala de Aula ou um administrador usando a interface do usuário do Google Sala de Aula ou o método DeleteGuardian
.
Quem pode gerenciar os responsáveis
A tabela a seguir descreve as ações que podem ser realizadas para os responsáveis, de acordo com o tipo de usuário autenticado no momento:
Escopos
Existem três escopos para você gerenciar os responsáveis:
- https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly permite que você veja os responsáveis de um usuário.
- https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly você pode ver os convites dos responsáveis e dos responsáveis dos alunos ensinados ou administrados pelo usuário.
- Na página https://www.googleapis.com/auth/classroom.guardianlinks.students, você pode ver e modificar os convites dos responsáveis e responsáveis para os alunos que o usuário ensina ou administra.
Ações comuns
Esta seção descreve algumas ações comuns que podem ser feitas usando a API Google Classroom.
Criar um convite para os responsáveis
O exemplo a seguir mostra como criar um convite para o responsável usando o método 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')))
O resultado inclui um identificador atribuído pelo servidor que pode ser usado para consultar o convite do responsável.
Cancelar um convite de responsável
Para cancelar um convite, modifique o estado dele de PENDING
para COMPLETE
chamando o método userProfiles.guardianInvitations.patch()
.
No momento, essa é a única maneira de remover um convite.
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()
Listar convites para um aluno específico
Veja uma lista de todos os convites enviados para um estudante específico
usando o método 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')))
Por padrão, apenas PENDING
convites serão retornados. Como administrador
do domínio, também é possível recuperar convites no estado COMPLETED
fornecendo um parâmetro de estados.
Listar responsáveis ativos
Para determinar quais usuários são responsáveis ativos por um estudante
específico, use o método userProfiles.guardians.list()
. Os responsáveis
ativos são aqueles que aceitaram o convite por 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')))
Remover responsáveis
Você também pode remover um responsável de um aluno usando o método userProfiles.guardians.delete()
:
Java
Python
service.userProfiles().guardians().delete(studentId='student@mydomain.edu',
guardianId='guardian@gmail.com').execute()