保護者リソースは、受講生のコースや提出物に関する情報を受け取る保護者などのユーザーを表します。通常、生徒の 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() メソッドを呼び出して、招待の状態を PENDING から COMPLETE に変更します。現在のところ、これが招待を削除する唯一の方法です。
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()