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

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

इकाई Classroom में कैसे दिखेगा
कोर्स कोई क्लास, जैसे कि "एम. स्मिथ का चौथा पीरियड मैथ".
उपनाम किसी कोर्स का वैकल्पिक आईडी.
न्योते क्लास में उपयोगकर्ताओं को जोड़ने का तरीका.
छात्र-छात्राएं किसी क्लास में छात्र-छात्रा.
शिक्षक क्लास में मौजूद शिक्षक.
उपयोगकर्ता प्रोफ़ाइलें छात्र या शिक्षक के बजाय, सामान्य तौर पर उपयोगकर्ता.
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 की कोई तारीख नहीं होती और StudentSubmissions मौजूद नहीं होता. शिक्षक, सुझाई गई किताबें, पाठ्यक्रम या कक्षा के नियम पोस्ट करने के लिए CourseWorkMaterials का इस्तेमाल कर सकते हैं.

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

विषय

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

Classroom के ऐड-ऑन

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

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

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

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

पंजीकरण

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

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