एपीआई का स्ट्रक्चर

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

इकाई	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 में, माता-पिता और अभिभावकों के पास छात्र-छात्राओं के कुछ असाइनमेंट जैसी जानकारी का ऐक्सेस होता है.

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

कोर्सवर्क और छात्र-छात्राओं के सबमिशन

CourseWork आइटम, किसी कोर्स में छात्र-छात्राओं के ग्रुप को असाइन किए गए एक टास्क को दिखाता है. इसमें वीडियो का ब्यौरा, उसे सबमिट करने की तारीख, और सामग्री जैसी जानकारी शामिल होती है. साथ ही, मेटाडेटा में, बनाए जाने का समय भी शामिल होता है. कॉन्टेंट में टाइटल, थंबनेल, और यूआरएल के साथ-साथ, एक आइडेंटिफ़ायर भी होता है. इसका इस्तेमाल सही एपीआई (जैसे, Drive, YouTube) के साथ किया जा सकता है.

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

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

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

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

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

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

कोर्सवर्क के लिए उपलब्ध कॉन्टेंट और सूचनाएं

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

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

विषय

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

Classroom ऐड-ऑन

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

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

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

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

पंजीकरण

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

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