Method: userProfiles.guardianInvitations.create

अभिभावक के लिए न्योता बनाता है और उसे ईमेल भेजता है. इसमें अभिभावक से यह पुष्टि करने के लिए कहा जाता है कि वे छात्र या छात्रा के अभिभावक हैं.

न्योता स्वीकार करने के बाद, अभिभावक का state स्टेटस COMPLETED में बदल जाएगा. साथ ही, उन्हें अभिभावक के तौर पर सूचनाएं मिलना शुरू हो जाएंगी. ऐक्टिव अभिभावक की जानकारी दिखाने के लिए, एक Guardian संसाधन भी बनाया जाएगा.

अनुरोध ऑब्जेक्ट में studentId और invitedEmailAddress फ़ील्ड सेट होने चाहिए. इन फ़ील्ड को सेट न करने या अनुरोध में कोई दूसरा फ़ील्ड सेट करने पर, गड़बड़ी का मैसेज दिखेगा.

इस तरीके से, गड़बड़ी के ये कोड मिलते हैं:

• PERMISSION_DENIED अगर मौजूदा उपयोगकर्ता के पास अभिभावकों को मैनेज करने की अनुमति नहीं है, अगर जिस अभिभावक की बात हो रही है उसने उस छात्र या छात्रा के लिए पहले ही बहुत ज़्यादा अनुरोध अस्वीकार कर दिए हैं, अगर उस डोमेन के लिए अभिभावकों को अनुमति नहीं दी गई है या ऐक्सेस से जुड़ी अन्य गड़बड़ियों की वजह से.
• RESOURCE_EXHAUSTED अगर छात्र/छात्रा या अभिभावक ने, अभिभावक के खाते को लिंक करने की तय सीमा से ज़्यादा खाते लिंक किए हैं.
• INVALID_ARGUMENT अगर अभिभावक का ईमेल पता मान्य नहीं है (उदाहरण के लिए, अगर वह बहुत लंबा है) या छात्र/छात्रा के दिए गए आईडी का फ़ॉर्मैट नहीं पहचाना जा सकता (यह ईमेल पता नहीं है और न ही यह इस एपीआई का userId है). यह गड़बड़ी तब भी दिखेगी, जब रीड-ओनली फ़ील्ड सेट किए गए हों या state फ़ील्ड को PENDING के अलावा किसी दूसरी वैल्यू पर सेट किया गया हो.
• NOT_FOUND अगर दिया गया स्टूडेंट आईडी मान्य है, लेकिन Classroom में उस छात्र या छात्रा का कोई रिकॉर्ड नहीं है.
• ALREADY_EXISTS अगर छात्र/छात्रा के लिए, अभिभावक को न्योता पहले ही भेजा जा चुका है और दिया गया invitedEmailAddress मौजूद है या दिया गया invitedEmailAddress, इस उपयोगकर्ता के लिए किसी मौजूदा Guardian के Google खाते से मेल खाता है.