अभिभावक बनाना और उन्हें मैनेज करना

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

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

जब उपयोगकर्ता को न्योता भेजा जाता है और वह न्योता स्वीकार नहीं करता है, तब GuardianInvitation का स्टेटस PENDING होता है. जब उपयोगकर्ता न्योता स्वीकार कर लेता है, तो GuardianInvitation को COMPLETED के तौर पर मार्क कर दिया जाता है. साथ ही, एक Guardian संसाधन बना दिया जाता है.

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

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

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

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

स्कोप

अभिभावकों को मैनेज करने के लिए, तीन स्कोप उपलब्ध हैं:

  • 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() तरीके का इस्तेमाल करके,

Java

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;

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

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;

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() तरीके का इस्तेमाल करके, किसी छात्र/छात्रा के लिए भेजे गए सभी न्योतों की सूची देखी जा सकती है. डिफ़ॉल्ट रूप से, सिर्फ़ PENDING स्टेटस वाले न्योते दिखाए जाएंगे. डोमेन का एडमिन, states पैरामीटर देकर, COMPLETED स्टेटस वाले न्योते भी वापस पा सकता है.

Java

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;

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

चालू अभिभावकों की सूची देखना

यह जानने के लिए कि किसी छात्र/छात्रा के लिए कौनसे उपयोगकर्ता चालू अभिभावक हैं, 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()
पीछे जाएं
कोर्स के न्योते बनाना और उन्हें मैनेज करना
आगे बढ़ें
छात्र-छात्राओं के ग्रुप बनाना और उन्हें मैनेज करना