अभिभावकों को मैनेज करना

अभिभावक के लिए संसाधन उपयोगकर्ता के बारे में बताता है, जैसे कि अभिभावक, जिसे छात्र/छात्रा के कोर्स और उसके काम के बारे में जानकारी मिलती है. अभिभावक जो आम तौर पर छात्र/छात्रा के Classroom डोमेन का सदस्य नहीं होता है उसे अभिभावक बनने के लिए, उनके ईमेल पते का इस्तेमाल करके न्योता भेजा जाना चाहिए.

इस न्योते से, PENDING की स्थिति वाला अभिभावक को न्योता भेजने का संसाधन बनाया जाता है. इसके बाद, उपयोगकर्ता को एक ईमेल मिलता है, जिसमें उससे न्योता स्वीकार करने के लिए कहा जाता है. अगर ईमेल पता किसी Google खाते से नहीं जुड़ा है, तो न्योता स्वीकार करने से पहले उपयोगकर्ता को एक नया ईमेल पता बनाने का संकेत दिया जाता है.

न्योते की स्थिति PENDING होने पर, उपयोगकर्ता इस न्योते को स्वीकार कर सकता है. इससे एक अभिभावक संसाधन बनाता है और अभिभावकों को न्योता भेजने पर COMPLETED की स्थिति दिखाता है. किसी न्योते की समयसीमा खत्म होने पर भी वह COMPLETED बन सकता है. इसके अलावा, ऐसा तब भी हो सकता है, जब कोई ऐसा उपयोगकर्ता न्योता रद्द कर देता हो जिसे अनुमति मिली हुई है (उदाहरण के लिए, PatchGuardianInvitation का इस्तेमाल करके). Classroom के यूज़र इंटरफ़ेस या DeleteGuardian तरीके की मदद से, अभिभावक, Classroom का शिक्षक या एडमिन, अभिभावकों के साथ संबंध को भी तोड़ सकते हैं.

अभिभावकों को कौन मैनेज कर सकता है

फ़िलहाल जिस उपयोगकर्ता की पुष्टि की गई है उसके हिसाब से, नीचे दी गई टेबल में अभिभावकों के संबंध में की जा सकने वाली कार्रवाइयों के बारे में बताया गया है:

उपयोगकर्ता टाइप के हिसाब से, अभिभावकों से जुड़े एसीएल की टेबल

स्कोप

अभिभावकों को मैनेज करने के लिए, इन तीन दायरों की मदद ली जा सकती है:

सामान्य कार्रवाइयां

इस सेक्शन में अभिभावकों की ऐसी कुछ सामान्य कार्रवाइयों के बारे में बताया गया है जिन्हें शायद आप Google Classroom API का इस्तेमाल करके करना चाहें.

अभिभावक को न्योता दें

नीचे दिए गए उदाहरण में, userProfiles.guardianInvitations.create() तरीके का इस्तेमाल करके अभिभावक को न्योता देने का तरीका बताया गया है:

Java

classroom/snippets/src/main/java/CreateGuardian इनोवेशन.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;

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')))

इस नतीजे में, सर्वर से असाइन किया गया आइडेंटिफ़ायर शामिल होता है. इसका इस्तेमाल, Guardianन्योता को भेजने के लिए किया जा सकता है.

अभिभावक का न्योता रद्द करना

किसी न्योते को रद्द करने के लिए, userProfiles.guardianInvitations.patch() वाले तरीके का इस्तेमाल करके, PENDING से COMPLETE के लिए न्योते की स्थिति में बदलाव करें. ध्यान दें कि फ़िलहाल किसी न्योते को हटाने का यही एक तरीका है.

Java

classroom/snippets/src/main/java/CancelGuardian समर्थन.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;

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

Classroom/snippets/src/main/java/ListGuardian समर्थनsByछात्र.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;

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 न्योते मिलेंगे. डोमेन एडमिन के तौर पर, आपके पास स्टेट पैरामीटर देकर, COMPLETED स्टेटस में न्योते वापस पाने का विकल्प होता है.

सक्रिय अभिभावकों की सूची बनाएं

अगर आपको यह पता करना है कि किसी खास छात्र/छात्रा के कौनसे उपयोगकर्ता, अभिभावक के तौर पर सक्रिय हैं, तो आपके पास userProfiles.guardians.list() वाला तरीका इस्तेमाल करने का विकल्प होता है. सक्रिय अभिभावक वे अभिभावक होते हैं जिन्होंने ईमेल का न्योता स्वीकार कर लिया है.

Java

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;

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

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);
  }
}

Python

service.userProfiles().guardians().delete(studentId='student@mydomain.edu',
                                        guardianId='guardian@gmail.com').execute()