保護者リソースは、生徒のコースや課題に関する情報を受け取る保護者などのユーザーを表します。保護者（通常は生徒の Classroom ドメインのメンバーではない）が保護者になるには、保護者のメールアドレスを使用して招待される必要があります。
この招待は、状態が PENDING の GuardianInvitation リソースを作成します。ユーザーは、招待の承諾を求めるメールが届きます。メールアドレスが Google アカウントに関連付けられていない場合、ユーザーは招待を承諾する前にアカウントを作成するよう求められます。
招待の状態が PENDING の場合、ユーザーが招待を承諾すると、Guardian リソースが作成され、GuardianInvitation は COMPLETED の状態になります。招待状は、有効期限が切れた場合や、承認済みユーザーが（PatchGuardianInvitation メソッドなどを使用して）招待をキャンセルした場合にも COMPLETED になります。保護者、Classroom の教師、管理者が、Classroom のユーザー インターフェースまたは DeleteGuardian メソッドを使用して保護者との関係を切断することもできます。
保護者を管理できるユーザー
次の表に、現在認証されているユーザーのタイプに応じて、保護者に関して実行できるアクションを示します。
スコープ
保護者を管理できるスコープは 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 では、ユーザーが指導または管理している生徒の保護者と 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 の参照に使用できるサーバー割り当ての識別子が含まれます。
保護者の招待をキャンセルする
招待をキャンセルするには、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()