保護者の作成と管理

Guardian リソースは、生徒のコースと課題に関する情報を受け取るユーザー（保護者など）を表します。保護者は通常、生徒の Classroom ドメインのメンバーではないため、メールアドレスを使用して招待する必要があります。

招待は GuardianInvitation リソースで表されます。招待されたユーザーには、招待を承諾するよう求めるメールが届きます。メールアドレスが Google アカウントに関連付けられていない場合は、招待を承諾する前にアカウントを作成するよう求められます。

ユーザーが招待されてから招待を承諾するまでの間、GuardianInvitation の状態は PENDING です。ユーザーが招待を承諾すると、GuardianInvitation は COMPLETED としてマークされ、Guardian リソースが作成されます。

GuardianInvitation の状態は、有効期限が切れた場合や、承認済みユーザーが招待をキャンセルした場合（PatchGuardianInvitation メソッドを使用するなど）に COMPLETED に変更されることもあります。保護者の関係は、保護者、Classroom 教師、管理者が Classroom ウェブ アプリケーションまたは DeleteGuardian メソッドを使用して解除することもできます。

保護者を管理できるユーザー

次の表に、認証されたユーザーのタイプに応じて、保護者に対して実行できるアクションを示します。

ユーザータイプ別の保護者関連の ACL の表

スコープ

保護者を管理できるスコープは 3 つあります。

  • https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly: ユーザー自身の保護者を表示します。
  • https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly: ユーザーが指導または管理している生徒の保護者と保護者招待状を表示します。
  • https://www.googleapis.com/auth/classroom.guardianlinks.students: ユーザーが指導または管理している生徒の保護者と保護者の招待状を表示、管理します。

一般的な操作

このセクションでは、Google Classroom API を使用して実行する一般的な保護者向けアクションについて説明します。

保護者への招待状を作成する

次の例は、userProfiles.guardianInvitations.create() メソッドを使用して保護者招待状を作成する方法を示しています。

JavaPython
classroom/snippets/src/main/java/CreateGuardianInvitation.java
GuardianInvitation guardianInvitation = null;

/* Create a GuardianInvitation object with state set to PENDING. See
https://developers.google.com/classroom/reference/rest/v1/userProfiles.guardianInvitations#guardianinvitationstate
for other possible states of guardian invitations. */
GuardianInvitation content =
    new GuardianInvitation()
        .setStudentId(studentId)
        .setInvitedEmailAddress(guardianEmail)
        .setState("PENDING");
try {
  guardianInvitation =
      service.userProfiles().guardianInvitations().create(studentId, content).execute();

  System.out.printf("Invitation created: %s\n", guardianInvitation.getInvitationId());
} catch (GoogleJsonResponseException e) {
  // TODO (developer) - handle error appropriately
  GoogleJsonError error = e.getDetails();
  if (error.getCode() == 404) {
    System.out.printf("There is no record of studentId: %s", studentId);
  } else {
    throw e;
  }
} catch (Exception e) {
  throw e;
}
return guardianInvitation;
 
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 に変更します。招待を削除する方法はこれが唯一の方法です。

JavaPython
classroom/snippets/src/main/java/CancelGuardianInvitation.java
GuardianInvitation guardianInvitation = null;

try {
  /* Change the state of the GuardianInvitation from PENDING to COMPLETE. See
  https://developers.google.com/classroom/reference/rest/v1/userProfiles.guardianInvitations#guardianinvitationstate
  for other possible states of guardian invitations. */
  GuardianInvitation content =
      service.userProfiles().guardianInvitations().get(studentId, invitationId).execute();
  content.setState("COMPLETE");

  guardianInvitation =
      service
          .userProfiles()
          .guardianInvitations()
          .patch(studentId, invitationId, content)
          .set("updateMask", "state")
          .execute();

  System.out.printf(
      "Invitation (%s) state set to %s\n.",
      guardianInvitation.getInvitationId(), guardianInvitation.getState());
} catch (GoogleJsonResponseException e) {
  // TODO (developer) - handle error appropriately
  GoogleJsonError error = e.getDetails();
  if (error.getCode() == 404) {
    System.out.printf(
        "There is no record of studentId (%s) or invitationId (%s).", studentId, invitationId);
  } else {
    throw e;
  }
} catch (Exception e) {
  throw e;
}
return guardianInvitation;
 
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() メソッドを使用して、特定の生徒に送信されたすべての招待状のリストを取得できます。デフォルトでは、PENDING 招待のみが返されます。ドメイン管理者は、states パラメータを指定して、COMPLETED 状態の招待状を取得することもできます。

JavaPython
classroom/snippets/src/main/java/ListGuardianInvitationsByStudent.java
List<GuardianInvitation> guardianInvitations = new ArrayList<>();
String pageToken = null;

try {
  do {
    ListGuardianInvitationsResponse response =
        service
            .userProfiles()
            .guardianInvitations()
            .list(studentId)
            .setPageToken(pageToken)
            .execute();

    /* Ensure that the response is not null before retrieving data from it to avoid errors. */
    if (response.getGuardianInvitations() != null) {
      guardianInvitations.addAll(response.getGuardianInvitations());
      pageToken = response.getNextPageToken();
    }
  } while (pageToken != null);

  if (guardianInvitations.isEmpty()) {
    System.out.println("No guardian invitations found.");
  } else {
    for (GuardianInvitation invitation : guardianInvitations) {
      System.out.printf("Guardian invitation id: %s\n", invitation.getInvitationId());
    }
  }
} catch (GoogleJsonResponseException e) {
  GoogleJsonError error = e.getDetails();
  if (error.getCode() == 404) {
    System.out.printf("There is no record of studentId (%s).", studentId);
  } else {
    throw e;
  }
} catch (Exception e) {
  throw e;
}
return guardianInvitations;
 
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')))

アクティブな保護者を一覧表示する

特定の生徒のアクティブな保護者を特定するには、userProfiles.guardians.list() メソッドを使用します。アクティブな保護者は、招待を承諾した保護者です。

JavaPython
classroom/snippets/src/main/java/ListGuardians.java
List<Guardian> guardians = new ArrayList<>();
String pageToken = null;

try {
  do {
    ListGuardiansResponse response =
        service.userProfiles().guardians().list(studentId).setPageToken(pageToken).execute();

    /* Ensure that the response is not null before retrieving data from it to avoid errors. */
    if (response.getGuardians() != null) {
      guardians.addAll(response.getGuardians());
      pageToken = response.getNextPageToken();
    }
  } while (pageToken != null);

  if (guardians.isEmpty()) {
    System.out.println("No guardians found.");
  } else {
    for (Guardian guardian : guardians) {
      System.out.printf(
          "Guardian name: %s, guardian id: %s, guardian email: %s\n",
          guardian.getGuardianProfile().getName().getFullName(),
          guardian.getGuardianId(),
          guardian.getInvitedEmailAddress());
    }
  }

} catch (GoogleJsonResponseException e) {
  GoogleJsonError error = e.getDetails();
  if (error.getCode() == 404) {
    System.out.printf("There is no record of studentId (%s).", studentId);
  } else {
    throw e;
  }
} catch (Exception e) {
  throw e;
}
return guardians;
 
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() メソッドを使用して、生徒から保護者を削除することもできます。

JavaPython
classroom/snippets/src/main/java/DeleteGuardian.java
try {
  service.userProfiles().guardians().delete(studentId, guardianId).execute();
  System.out.printf("The guardian with id %s was deleted.\n", guardianId);
} catch (GoogleJsonResponseException e) {
  GoogleJsonError error = e.getDetails();
  if (error.getCode() == 404) {
    System.out.printf("There is no record of guardianId (%s).", guardianId);
  }
}
 
service.userProfiles().guardians().delete(studentId='student@mydomain.edu',
                                        guardianId='guardian@gmail.com').execute()
前へ
コースの招待状を作成、管理する