खास जानकारी

Classroom API, आपके लिए एक RESTous इंटरफ़ेस वाला इंटरफ़ेस उपलब्ध कराता है. इससे Google Classroom में कोर्स और नामावली मैनेज की जा सकती हैं. इसके अलावा, Classroom शेयर करें बटन की मदद से, डेवलपर और कॉन्टेंट के मालिक, Classroom में अपना कॉन्टेंट शेयर कर सकते हैं.

इस एपीआई का इस्तेमाल कौन कर सकता है?

Google Workspace for Education के डोमेन एडमिन, शिक्षकों की ओर से प्रोग्राम के हिसाब से कोर्स का प्रावधान करने, छात्र-छात्राओं की जानकारी देने वाले सिस्टम को Classroom से सिंक करने, और अपने डोमेन में पढ़ाई जा रही क्लास की बुनियादी जानकारी पाने के लिए, इस एपीआई का इस्तेमाल कर सकते हैं.

ऐप्लिकेशन डेवलपर अपने ऐप्लिकेशन को Classroom के साथ इंटिग्रेट करने के लिए, Classroom API का इस्तेमाल कर सकते हैं. शिक्षकों से क्लास और नामावली देखने की अनुमति मांगने के लिए, इन ऐप्लिकेशन को OAuth 2.0 का इस्तेमाल करना होगा. एडमिन यह पाबंदी लगा सकते हैं कि क्या शिक्षक और उनके डोमेन के छात्र-छात्राएं, ऐप्लिकेशन को Google Classroom का डेटा ऐक्सेस करने की अनुमति दे सकते हैं या नहीं.

वेबसाइट के मालिक और कॉन्टेंट डेवलपर Classroom शेयर करें बटन का इस्तेमाल कर सकते हैं, ताकि छात्र-छात्राएं और शिक्षक, Classroom में कॉन्टेंट शेयर कर सकें.

सभी एपीआई और Classroom शेयर बटन इंटिग्रेशन को Classroom के ब्रैंड से जुड़े दिशा-निर्देशों का पालन करना चाहिए.

एपीआई की खास जानकारी

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

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

कोर्स का मेटाडेटा और उपनाम

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

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

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

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

कोर्स की नामावली और उसे इस्तेमाल करने वाले लोग

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

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

छात्र-छात्रा संसाधन ऐसे उपयोगकर्ता का प्रतिनिधित्व करता है जिसने छात्र/छात्रा के रूप में रजिस्टर किया है

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

शिक्षक

Teacher संसाधन से पता चलता है कि कोई उपयोगकर्ता किसी खास कोर्स को पढ़ाता है या नहीं.

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

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

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

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

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

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

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

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

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

StudentSubmission का कॉन्टेंट इस बात पर निर्भर करता है कि CourseWork आइटम किस तरह का है:

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

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

Classroom ऐड-ऑन

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

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

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

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

क्विकस्टार्ट

अपना एनवायरमेंट सेट अप करने और एपीआई का इस्तेमाल तुरंत शुरू करने के लिए, इनमें से कोई एक क्विकस्टार्ट आज़माएं:

Google API एक्सप्लोरर के साथ प्रयोग करना

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

तरीकों को कॉल करने का एक तरीका यह है कि courses.list() तरीके को कॉल करें. इस तरीके के लिए किसी अनुरोध पैरामीटर की ज़रूरत नहीं होती. साथ ही, आपके पास कोर्स की दिखाई गई सूची से id को वापस पाने का विकल्प होता है, ताकि उसे अन्य एपीआई कॉल के लिए अनुरोध पैरामीटर के तौर पर इस्तेमाल किया जा सके. अगर आपके पास कोई कोर्स नहीं है, तो courses.create() तरीके का इस्तेमाल करके कोर्स बनाया जा सकता है.

एपीआई के रेफ़रंस को भी देखा जा सकता है.