खास जानकारी

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

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

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

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

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

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

Perspective API की खास जानकारी

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

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

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

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

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

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

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

कोर्स की नामावली और उपयोगकर्ता

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

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

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

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

शिक्षक

टीचर के संसाधन की मदद से, किसी उपयोगकर्ता को कोई कोर्स पढ़ाया जाता है.

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

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

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

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

कोर्सवर्क और छात्र-छात्राओं के सबमिट किए गए असाइनमेंट

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

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

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

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

छात्र-छात्राओं के लिए सबमिशन का कॉन्टेंट इस पर निर्भर करता है कि कोर्स आइटम किस तरह का है:

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

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

Classroom ऐड-ऑन

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

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

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

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

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

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

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

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

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

एपीआई के रेफ़रंस को भी एक्सप्लोर किया जा सकता है.