保護者向けリソースとは、生徒のコースおよび提出物に関する情報を受け取るユーザー（保護者など）のことです。通常、生徒の Classroom ドメインのメンバーではない保護者は、メールアドレスを使用して保護者に招待される必要があります。
この招待により、状態が PENDING の GuardianInvitation リソースが作成されます。ユーザーは、招待を承認するように求めるメールを受け取ります。メールアドレスが Google アカウントに関連付けられていない場合、ユーザーは招待を受諾する前にアカウントを作成するよう求められます。
招待の状態が PENDING である間、ユーザーは招待を承諾できます。これにより、Guardian リソースが作成され、GuardianInvitation は COMPLETED 状態に設定されます。有効期限が切れた場合や、承認されたユーザーが（PatchGuardianInvitation メソッドなどを使用して）招待をキャンセルした場合も、COMPLETED になる可能性があります。また、Classroom のユーザー インターフェースまたは DeleteGuardian メソッドを使用して、保護者、Classroom の教師、管理者によって保護者の関係が壊れることもあります。
保護者を管理できるユーザー
次の表に、現在認証されているユーザーのタイプに応じて、保護者に関して実施できるアクションを示します。
スコープ
保護者を管理できる範囲は 3 つあります。
- https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly では、ユーザーの独自の保護者を表示できます。
- https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly では、ユーザーが担当または管理する生徒の Guardians と GuardianInvitations を表示できます。
- https://www.googleapis.com/auth/classroom.guardianlinks.students では、ユーザーが教育または管理する生徒の Guardians と GuardianInvitations を表示、変更できます。
一般的な操作
このセクションでは、Google Classroom API を使用して実行する一般的な保護者向け操作の一部について説明します。
保護者宛の招待状を作成
次の例は、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')))
結果には、GuardianInvitation を参照するために使用できるサーバー割り当ての ID が含まれます。
保護者への招待をキャンセルする
次の例は、userProfiles.guardianInvitations.patch() メソッドを使用して招待をキャンセルする方法を示しています。
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()
特定の生徒の招待状を一覧表示する
特定の生徒に送信されたすべての招待状のリストを取得するには、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')))
デフォルトでは PENDING 通の招待状のみが返されます。ドメイン管理者は、states パラメータを指定して COMPLETED 状態の招待を取得することもできます。
アクティブな保護者を一覧表示する
特定の生徒の有効な保護者を確認するには、userProfiles.guardians.list() メソッドを使用します。アクティブな保護者は、招待を承諾した保護者です。
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')))
保護者を削除する
userProfiles.guardians.delete() メソッドを使用して、生徒から保護者を削除することもできます。
Java
Python
service.userProfiles().guardians().delete(studentId='student@mydomain.edu',
guardianId='guardian@gmail.com').execute()