एपीआई के रिसॉर्स

इस गाइड में, Google Classroom API के मुख्य कॉम्पोनेंट के बारे में खास जानकारी दी गई है. Google Classroom API में संसाधन और सेवाएं शामिल हैं. Google Classroom में रिसॉर्स, इकाइयों को दिखाते हैं. जैसे, कोई कोर्स या असाइनमेंट. सेवाएं इन रिसॉर्स को वापस पाती हैं और मैनेज करती हैं. इनमें से कुछ इकाइयों में, Classroom में मौजूद प्रॉपर्टी के अलावा, API के लिए खास तौर पर बनाई गई अतिरिक्त प्रॉपर्टी होती हैं. मुख्य इकाई के टाइप ये हैं:

इकाई	Classroom में कैसे दिखेगा
कोर्स	कोई क्लास, जैसे कि "M. स्मिथ की चौथी क्लास की गणित" के तौर पर सेव किया गया है.
उपनाम	किसी कोर्स के लिए वैकल्पिक आईडी.
न्योते	उपयोगकर्ताओं को क्लास में जोड़ने का तरीका.
छात्र-छात्राएं	किसी क्लास में मौजूद छात्र या छात्रा.
शिक्षकों के लिए	क्लास में शामिल कोई शिक्षक.
उपयोगकर्ता प्रोफ़ाइलें	छात्र-छात्रा या शिक्षक के अलावा, कोई अन्य व्यक्ति.
CourseWork	किसी क्लास में असाइनमेंट.
StudentSubmissions	किसी असाइनमेंट के लिए छात्र-छात्राओं का काम, जैसे कि जवाब या वर्कशीट.
CourseWorkMaterials	किसी क्लास में शामिल छात्र-छात्राओं के लिए संसाधन.
सूचनाएं	किसी क्लास के छात्र-छात्राओं के लिए सूचना.
AddOnAttachment	किसी असाइनमेंट या मटीरियल पर मौजूद ऐसा कॉन्टेंट या गतिविधि जिसे आम तौर पर एम्बेड किए गए iframe के तौर पर दिखाया जाता है.
विषय	किसी क्लास में असाइनमेंट और स्टडी मटीरियल को विज़ुअली ग्रुप करना.
रजिस्ट्रेशन	डेटा में हुए बदलावों के लिए, आपके ऐप्लिकेशन को सूचनाएं भेजने का निर्देश. जैसे, क्लास में शामिल छात्र-छात्राओं की सूची.

ज़्यादातर संसाधनों में, स्टैंडर्ड कार्रवाइयों के लिए सेवा के तरीके होते हैं. जैसे, संसाधन के इंस्टेंस को पढ़ना, अपडेट करना, और मिटाना. कुछ संसाधनों में अन्य कार्रवाइयों के लिए भी कस्टम तरीके होते हैं. जैसे, किसी असाइनमेंट के लिए असाइन किए गए छात्र-छात्राओं की सूची में बदलाव करना.

एपीआई के संसाधनों और तरीकों के बारे में ज़्यादा जानकारी के लिए, Classroom API का रेफ़रंस देखें.

संसाधन के संबंधों की खास जानकारी

• कोर्स, Google Classroom में डेटा का मुख्य ऑब्जेक्ट होता है.
• उपनामों का इस्तेमाल, Courses के लिए वैकल्पिक आइडेंटिफ़ायर के तौर पर किया जाता है.
• न्योते का इस्तेमाल, Course में उपयोगकर्ता प्रोफ़ाइलों को शिक्षक या छात्र-छात्राएं बनने का न्योता देने के लिए किया जाता है. हालांकि, Google Workspace for Education डोमेन के एडमिन भी उपयोगकर्ताओं को सीधे तौर पर जोड़ सकते हैं.
• शिक्षक स्ट्रीम आइटम बनाते हैं और उन्हें अपने कोर्स में शामिल छात्र-छात्राओं के साथ शेयर करते हैं. स्ट्रीम आइटम के ये टाइप हो सकते हैं: Coursework, CourseWorkMaterials, और Announcements. CourseWork और CourseWorkMaterials को विषयों के हिसाब से व्यवस्थित किया जा सकता है. साथ ही, इनमें AddOnAttachments शामिल हो सकते हैं. छात्र-छात्राएं अपने CourseWork के लिए StudentSubmissions सबमिट करते हैं.
• डेवलपर, रजिस्ट्रेशन बना सकते हैं. इससे उन्हें इस डेटा में बदलाव होने पर सूचनाएं मिलेंगी.

Google Classroom, उन डोमेन के लिए उपलब्ध है जिन्होंने Google Workspace for Education की सदस्यता ली है. Classroom के संदर्भ में, डोमेन आम तौर पर किसी स्कूल डिस्ट्रिक्ट को दिखाता है. डेवलपमेंट के लिए, Google Workspace for Education का टेस्ट डोमेन बनाया जा सकता है. इससे आपको Classroom के प्रोडक्शन इंस्टेंस को कंट्रोल करने की सुविधा मिलती है. साथ ही, इससे असली उपयोगकर्ताओं पर कोई असर नहीं पड़ता.

कोर्स और उपनाम

Courses किसी क्लास को दिखाता है, जैसे कि "M. स्मिथ की चौथी क्लास में गणित" और उसके लिए असाइन किए गए शिक्षकों, छात्र-छात्राओं की सूची, और मेटाडेटा को मिटा दिया जाएगा. हर कोर्स की पहचान, सर्वर से असाइन किए गए यूनीक आईडी से की जाती है. Course संसाधन में, कोर्स के बारे में पूरा मेटाडेटा शामिल होता है. जैसे, नाम, ब्यौरा, जगह, और समय. कोर्स की सूचियां, छात्र-छात्रा, शिक्षक, और न्योता संसाधनों और उनके तरीकों से मैनेज की जाती हैं.

Aliases, क्लास के लिए वैकल्पिक आइडेंटिफ़ायर होते हैं. इन्हें किसी कोर्स से जोड़ा जा सकता है और यूनीक आईडी की जगह इस्तेमाल किया जा सकता है. हर उपनाम, ऐसे नेमस्पेस में मौजूद होता है जो यह तय करता है कि इसे कौन बना सकता है और कौन देख सकता है. दो नेमस्पेस काम करते हैं:

• डोमेन: डोमेन नेमस्पेस का इस्तेमाल ऐसे एलियास बनाने के लिए किया जाता है जिन्हें सभी उपयोगकर्ताओं को ऐक्सेस करने की ज़रूरत होती है, लेकिन जो किसी एक प्रोग्राम के लिए खास नहीं होते. उदाहरण के लिए, किसी कोर्स की अन्य लिस्टिंग, जैसे कि MATH 127 और COMSCI 127, को डोमेन नेमस्पेस में बनाया जाना चाहिए. डोमेन नेमस्पेस में अन्य नाम सिर्फ़ डोमेन एडमिन बना सकते हैं. हालांकि, ये डोमेन में मौजूद सभी उपयोगकर्ताओं को दिखते हैं.
• डेवलपर प्रोजेक्ट: डेवलपर प्रोजेक्ट नेमस्पेस, किसी ऐप्लिकेशन से जुड़े उपनामों को मैनेज करने के लिए काम आता है. उदाहरण के लिए, अगर कोई ऐप्लिकेशन कोर्स के लिए किसी दूसरे आइडेंटिफ़ायर का इस्तेमाल करता है, तो वह अपने आइडेंटिफ़ायर को Classroom के कोर्स से मैप करने के लिए, उपनाम बना सकता है. इस नेमस्पेस में बनाए गए उपनाम, किसी खास Google API कंसोल से जुड़े होते हैं. किसी ऐप्लिकेशन का कोई भी उपयोगकर्ता, उस ऐप्लिकेशन के डेवलपर प्रोजेक्ट के नेमस्पेस में उपनाम बना सकता है और उन्हें देख सकता है.

कोर्स के मेटाडेटा और अन्य नामों को मैनेज करने के बारे में ज़्यादा जानने के लिए, कोर्स मैनेज करना लेख पढ़ें.

कोर्स की सूचियां और उपयोगकर्ता

Students और Teachers, उपयोगकर्ता प्रोफ़ाइल और कोर्स के बीच की खास मैपिंग हैं. इनसे कोर्स में उपयोगकर्ता की भूमिका के बारे में पता चलता है. छात्र-छात्राओं और शिक्षकों की भूमिकाएं ग्लोबल नहीं होती हैं: किसी उपयोगकर्ता को एक कोर्स के लिए शिक्षक और दूसरे कोर्स के लिए छात्र-छात्रा के तौर पर असाइन किया जा सकता है. "छात्र-छात्रा" या "शिक्षक-शिक्षिका" पदनाम, किसी खास कोर्स में किसी उपयोगकर्ता के लिए अनुमतियों के सेट को दिखाता है. किसी कोर्स में एक से ज़्यादा शिक्षक हो सकते हैं या उसमें कोई छात्र-छात्रा नहीं हो सकती. शिक्षकों और छात्र-छात्राओं को किसी भी समय किसी कोर्स में जोड़ा या हटाया जा सकता है.

छात्र/छात्राएं

Student रिसॉर्स, किसी ऐसे उपयोगकर्ता को दिखाता है जिसने किसी कोर्स में छात्र या छात्रा के तौर पर रजिस्टर किया है.

छात्र-छात्राओं को कोर्स और शिक्षकों की जानकारी देखने की अनुमति होती है.

शिक्षक

Teacher संसाधन, किसी ऐसे उपयोगकर्ता को दिखाता है जो कोई खास कोर्स सिखाता है.

शिक्षकों को कोर्स की जानकारी देखने और उसमें बदलाव करने की अनुमति होती है. वे शिक्षकों और छात्र-छात्राओं की सूची देख सकते हैं. साथ ही, अतिरिक्त शिक्षकों और छात्र-छात्राओं को मैनेज कर सकते हैं.

Invitations और इनसे जुड़े तरीकों से, छात्र-छात्राओं और शिक्षकों को कोर्स में आसानी से जोड़ा जा सकता है. न्योते बनाने की सुविधा से, उपयोगकर्ताओं को यह चुनने का विकल्प मिलता है कि उन्हें किसी कोर्स में शामिल होना है या नहीं. इसके बजाय, शिक्षक और छात्र-छात्राओं के संसाधनों के ज़रिए उन्हें सीधे तौर पर जोड़ा जा सकता है.

UserProfiles, उपयोगकर्ता की डोमेन प्रोफ़ाइल की मैपिंग को दिखाता है. इसकी पहचान, Directory API से मिले उपयोगकर्ता के यूनीक आईडी या ईमेल पते से होती है. मौजूदा उपयोगकर्ता, "me" शॉर्टहैंड का इस्तेमाल करके अपना आईडी भी देख सकता है.

UserProfiles सेवा का इस्तेमाल, Guardians को मैनेज करने और उन्हें न्योता भेजने के लिए भी किया जा सकता है. Guardians, छात्र या छात्रा और अभिभावक के बीच की मैपिंग होती है. Classroom में अभिभावकों के पास छात्र-छात्राओं की कुछ जानकारी का ऐक्सेस होता है. जैसे, उनके असाइनमेंट.

रोस्टर मैनेज करने के बारे में ज़्यादा जानने के लिए, शिक्षकों और छात्र-छात्राओं को मैनेज करना लेख पढ़ें.

स्ट्रीम आइटम

स्ट्रीम आइटम, पोस्ट किए गए कॉन्टेंट के वे हिस्से होते हैं जिन्हें कोर्स के सदस्यों के साथ शेयर किया जाता है. डेवलपर और शिक्षक, तीन तरह के स्ट्रीम आइटम बना सकते हैं: Announcement, CourseWork, और CourseWorkMaterial.

शिक्षक, Classroom के यूज़र इंटरफ़ेस (यूआई) में स्ट्रीम पेज पर सबसे ऊपर Announcements बनाते हैं. शिक्षक, क्लासवर्क टैब में मौजूद बनाएं बटन पर क्लिक करके CourseWork और CourseWorkMaterials बनाते हैं. डेवलपर, Classroom API की मदद से सभी स्ट्रीम आइटम टाइप को प्रोग्राम के हिसाब से बना सकते हैं.

स्ट्रीम आइटम के बारे में ये बातें सही हैं:

• स्ट्रीम के सभी आइटम में, पूरक संसाधन शामिल किए जा सकते हैं. जैसे, Google Drive की फ़ाइलें, YouTube वीडियो, Google Forms, यूआरएल हाइपरलिंक, और Classroom ऐड-ऑन के अटैचमेंट.
• स्ट्रीम में मौजूद सभी आइटम, कोर्स में शामिल कुछ छात्र-छात्राओं को असाइन किए जा सकते हैं.
• CourseWork को ग्रेड किया जा सकता है या नहीं भी किया जा सकता. शिक्षक, CourseWork असाइनमेंट के ग्रेडिंग स्टेटस को कभी भी बदल सकते हैं.
• किसी स्ट्रीम आइटम में एक से ज़्यादा अटैचमेंट हो सकते हैं.
• स्ट्रीम आइटम में अलग-अलग तरह के अटैचमेंट हो सकते हैं. उदाहरण के लिए, एक CourseWork असाइनमेंट में Google Drive की फ़ाइलें, YouTube वीडियो, और Classroom ऐड-ऑन के अटैचमेंट एक साथ हो सकते हैं.
• किसी स्ट्रीम आइटम में, एक से ज़्यादा डेवलपर के ऐड-ऑन अटैचमेंट हो सकते हैं.
• डेवलपर, स्ट्रीम में शेयर किए गए किसी भी आइटम की जानकारी पा सकते हैं और उसमें बदलाव कर सकते हैं. हालांकि, ऐसा सिर्फ़ तब किया जा सकता है, जब उस आइटम में उनके ऐड-ऑन अटैच किए गए हों.
• डेवलपर, छात्र-छात्राओं के सबमिशन को सबमिट कर सकते हैं, वापस पा सकते हैं या उन्हें वापस भेज सकते हैं. ऐसा CourseWork असाइनमेंट के लिए किया जा सकता है, जिसमें उनके ऐड-ऑन अटैचमेंट में से कोई एक शामिल हो.
• डेवलपर, सिर्फ़ उन असाइनमेंट के लिए छात्र-छात्राओं के सबमिशन के ग्रेड तय कर सकते हैं जिन्हें उन्होंने बनाया है.

कॉपी किए गए स्ट्रीम आइटम

शिक्षक, स्ट्रीम आइटम को कॉपी कर सकते हैं. इसके लिए, वे किसी कोर्स को कॉपी कर सकते हैं, किसी असाइनमेंट का फिर से इस्तेमाल कर सकते हैं या किसी स्ट्रीम आइटम को एक से ज़्यादा कोर्स में पब्लिश कर सकते हैं. नई कॉपी के आइडेंटिफ़ायर अलग-अलग होंगे. अगर Classroom ऐड-ऑन बनाया जा रहा है, तो यह एक अहम पहलू हो सकता है. कॉपी किए गए कॉन्टेंट के बारे में हमारी गाइड पढ़ें. इससे आपको यह समझने में मदद मिलेगी कि ऐड-ऑन इन स्थितियों को कैसे हैंडल कर सकता है.

CourseWork और StudentSubmissions

CourseWork आइटम, किसी कोर्स में छात्र-छात्राओं के ग्रुप के लिए असाइनमेंट को दिखाता है. यह स्ट्रीम आइटम का ऐसा टाइप है जिसमें छात्र-छात्राएं सबमिट की गई फ़ाइलें देख सकते हैं. CourseWork रिसोर्स में, ब्यौरा, सबमिट करने की तारीख, ज़्यादा से ज़्यादा ग्रेड, और मेटाडेटा जैसी जानकारी होती है. जैसे, बनाने का समय.

हर CourseWork संसाधन, इनमें से किसी एक तरह के टास्क के बारे में बताता है:

• ऐसा असाइनमेंट जिसे छात्र-छात्राएं, वर्कशीट या अन्य अटैचमेंट सबमिट करके पूरा करते हैं.
• छोटे जवाब वाला सवाल या जवाब के कई विकल्पों वाला सवाल.

CourseWork आइटम के लिए छात्र-छात्राओं के काम को StudentSubmission से दिखाया जाता है. इसमें एक रिस्पॉन्स और अतिरिक्त मेटाडेटा शामिल होता है. जैसे, स्थिति और असाइन किया गया ग्रेड.

StudentSubmission का कॉन्टेंट, उससे जुड़े CourseWork आइटम के टाइप पर निर्भर करता है. इसमें ये शामिल हो सकते हैं:

• किसी असाइनमेंट के लिए सबमिट की गई वर्कशीट और अटैचमेंट. इनमें उनके टाइटल, थंबनेल, और यूआरएल शामिल हैं. साथ ही, ऐसे आइडेंटिफ़ायर भी शामिल हैं जिनका इस्तेमाल Drive या YouTube जैसे सही एपीआई के साथ किया जा सकता है.
• छोटे जवाब वाले सवाल या जवाब के कई विकल्पों वाले सवाल का जवाब.

कोर्सवर्क और छात्र-छात्राओं के सबमिट किए गए असाइनमेंट मैनेज करने के बारे में ज़्यादा जानने के लिए, कोर्सवर्क मैनेज करना लेख पढ़ें.

CourseWorkMaterials और सूचनाएं

CourseWork की तरह ही, CourseWorkMaterials भी किसी कोर्स में छात्र-छात्राओं के ग्रुप को असाइन किए गए कॉन्टेंट को दिखाता है. हर संसाधन में, टाइटल और ब्यौरे जैसी जानकारी के साथ-साथ अन्य संसाधन भी होते हैं. हालांकि, CourseWork के उलट, CourseWorkMaterials में छात्र-छात्राओं को कोई भी आर्टफ़ैक्ट सबमिट करने की ज़रूरत नहीं होती. इसलिए, CourseWorkMaterials के लिए कोई समयसीमा नहीं है और StudentSubmissions मौजूद नहीं हैं. शिक्षक, CourseWorkMaterials का इस्तेमाल करके, पढ़ने के लिए सुझाए गए लेख, पाठ्यक्रम या क्लास के नियम पोस्ट कर सकते हैं.

Announcements से, छात्र-छात्राओं के ग्रुप के साथ शेयर किए गए कॉन्टेंट को भी दिखाया जाता है. हालांकि, इनमें टाइटल जैसी जानकारी नहीं होती है. साथ ही, इन्हें Topics के हिसाब से व्यवस्थित नहीं किया जा सकता. जैसे, CourseWork या CourseWorkMaterials. शिक्षकों के पास, क्लास में रिमाइंडर या सूचनाएं देने के लिए इनका इस्तेमाल करने का विकल्प होता है.

विषय

Topics का इस्तेमाल, क्लास में CourseWork और CourseWorkMaterials को विज़ुअली व्यवस्थित करने के लिए किया जाता है. इनका इस्तेमाल, असाइनमेंट को "ज़रूरी नहीं" और "ज़रूरी" या "यूनिट 1" और "यूनिट 2" जैसे ग्रुप में बांटने के लिए किया जा सकता है.

Classroom ऐड-ऑन

ऐड-ऑन, डेवलपर की ओर से उपलब्ध कराया गया यूज़र इंटरफ़ेस (यूआई) और बैकएंड होता है. यह आम तौर पर iframe में दिखता है. ऐड-ऑन, स्ट्रीम आइटम पर अटैचमेंट के तौर पर दिखते हैं. स्ट्रीम आइटम, कोई भी Announcements, CourseWork या CourseWorkMaterials हो सकता है. ऐड-ऑन अटैचमेंट को AddOnAttachment से दिखाया जाता है.

ऐड-ऑन अटैचमेंट, गतिविधि या कॉन्टेंट हो सकता है.

• गतिविधि के अटैचमेंट के लिए, छात्र-छात्राओं को अलग-अलग सबमिशन पूरे करके सबमिट करने होते हैं. उदाहरण के लिए, क्विज़, ड्रॉइंग या गेम. गतिविधि के सबमिशन को ग्रेड दिया जा सकता है. हालांकि, ऐसा करना ज़रूरी नहीं है.
• कॉन्टेंट अटैचमेंट के लिए, छात्र-छात्राओं के सबमिशन की ज़रूरत नहीं होती. छात्र-छात्राओं को अटैचमेंट सबमिट करने की ज़रूरत नहीं होती. साथ ही, उन्हें इसके लिए ग्रेड नहीं दिया जाता. उदाहरण के लिए, फ़ोटो, लेख, और वीडियो.

ज़्यादा जानकारी के लिए, ऐड-ऑन डेवलपमेंट गाइड देखें.

पंजीकरण

ऐप्लिकेशन, Google Classroom में कुछ डेटा में बदलाव होने पर सूचनाएं पाने के लिए सदस्यता ले सकते हैं. उदाहरण के लिए, जब किसी कोर्स की रोस्टर अपडेट की जाती है. Registrations आपके ऐप्लिकेशन को ये सूचनाएं भेजने के निर्देश देते हैं.

ज़्यादा जानने के लिए, पुश नोटिफ़िकेशन की गाइड देखें.