Управление опекунами, Управление опекунами

Ресурс Guardian представляет пользователя, например родителя, который получает информацию о курсах и работе учащегося. Опекун, который обычно не является членом домена Класса учащегося, должен быть приглашен, используя его адрес электронной почты, чтобы стать опекуном.

Это приглашение создает ресурс GuardianInvitation с состоянием PENDING . Затем пользователь получает электронное письмо с предложением принять приглашение. Если адрес электронной почты не связан с учетной записью Google, пользователю будет предложено создать ее, прежде чем принять приглашение.

Пока приглашение имеет состояние PENDING , пользователь может принять приглашение, при этом создается ресурс Guardian и помечается GuardianInvitation состоянием COMPLETED . Приглашение также может стать COMPLETED , если срок его действия истек или если авторизованный пользователь отменяет приглашение (например, с помощью метода PatchGuardianInvitation ). Отношения Guardian также могут быть разорваны опекуном, учителем Класса или администратором с помощью пользовательского интерфейса Класса или метода DeleteGuardian .

Кто может управлять опекунами

В следующей таблице описаны действия, которые можно выполнить в отношении опекунов, в зависимости от типа пользователя, аутентифицированного в данный момент:

Области применения

Существует три области, позволяющие управлять опекунами:

• 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 для учащихся, которых пользователь преподает или администрирует.

Общие действия

В этом разделе описаны некоторые распространенные действия опекуна, которые вы, возможно, захотите выполнить с помощью API Google Classroom.

Создать приглашение опекуна

В следующем примере показано, как создать приглашение опекуна с помощью метода userProfiles.guardianInvitations.create() :

Ява Питон

класс/фрагменты/src/main/java/CreateGuardianInvitation.java

Посмотреть на GitHub

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': '[e-mail]',
}
guardianInvitation = service.userProfiles().guardianInvitations().create(
                      studentId='[e-mail]',
                          body=guardianInvitation).execute()
print("Invitation created with id: {0}".format(guardianInvitation.get('invitationId')))

Результат включает в себя идентификатор, назначенный сервером, который можно использовать для ссылки на GuardianInvitation.

Отменить приглашение опекуна

Чтобы отменить приглашение, измените состояние приглашения с PENDING на COMPLETE , вызвав метод userProfiles.guardianInvitations.patch() . Обратите внимание, что на данный момент это единственный способ удалить приглашение.

Ява Питон

класс/фрагменты/src/main/java/CancelGuardianInvitation.java

Посмотреть на GitHub

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='[e-mail]',
  invitationId=1234, # Replace with the invitation ID of the invitation you want to cancel
  updateMask='state',
  body=guardianInvitation).execute()

Список приглашений для конкретного учащегося

Получить список всех приглашений, отправленных конкретному студенту, можно с помощью метода userProfiles.guardianInvitations.list() :

Ява Питон

класс/фрагменты/src/main/java/ListGuardianInvitationsByStudent.java

Посмотреть на GitHub

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='[e-mail]').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 приглашения. Как администратор домена, вы также можете получать приглашения в состоянии COMPLETED , указав параметр состояний.

Список активных опекунов

Если вы хотите определить, какие пользователи являются активными опекунами конкретного учащегося, вы можете использовать метод userProfiles.guardians.list() . Активные опекуны — это опекуны, принявшие приглашение по электронной почте.

Ява Питон

класс/фрагменты/src/main/java/ListGuardians.java

Посмотреть на GitHub

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='[e-mail]').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')))

Примечание. Каждый ответ опекуна содержит UserProfile для опекуна. Для просмотра адреса электронной почты и фотографии профиля, прикрепленных к этому профилю, требуются дополнительные возможности, и они доступны только администраторам.

Удалить опекунов

Вы также можете удалить опекуна у учащегося, используя метод userProfiles.guardians.delete() :

Ява Питон

класс/фрагменты/src/main/java/DeleteGuardian.java

Посмотреть на GitHub

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='[e-mail]',
                                        guardianId='[e-mail]').execute()