Google Classroom ऐड-ऑन अब आम तौर पर डेवलपर के लिए उपलब्ध हैं! ज़्यादा जानकारी के लिए, कृपया ऐड-ऑन दस्तावेज़ देखें.

इस पेज का अनुवाद Cloud Translation API से किया गया है.

लिंक अटैचमेंट को Classroom ऐड-ऑन अटैचमेंट में अपग्रेड करना

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

खास जानकारी

अगर आपने इस सुविधा के साथ ऐड-ऑन कॉन्फ़िगर किया है, तो शिक्षकों को ऐड-ऑन अटैचमेंट के लिंक को अपग्रेड करने के लिए कहा जाता है. ऐसा तब होता है, जब वे असाइनमेंट बनाने वाले पेज पर लिंक अटैचमेंट चिपकाते हैं. शिक्षकों को ऐसा करने के लिए सिर्फ़ तब कहा जाता है, जब उन्होंने पहले से ही ऐड-ऑन इंस्टॉल किया हो.

जब शिक्षक, लिंक को ऐड-ऑन अटैचमेंट में अपग्रेड करने के लिए सहमत हो जाता है, तब Link Upgrade iframe इन क्वेरी पैरामीटर के साथ लॉन्च होता है:

courseId
itemId
itemType
addOnToken
urlToUpgrade
login_hint (सिर्फ़ तब, जब उपयोगकर्ता ने आपके ऐप्लिकेशन को पहले ही अनुमति दी हो)

पहले चार क्वेरी पैरामीटर, अटैचमेंट डिस्कवरी iframe पर लॉन्च किए गए क्वेरी पैरामीटर के जैसे ही होते हैं. urlToUpgrade क्वेरी पैरामीटर नया है. इससे आपको यह आकलन करने में मदद मिल सकती है कि ऐड-ऑन अटैचमेंट कैसे बनाया जाना चाहिए. इसके बाद, अन्य क्वेरी पैरामीटर का इस्तेमाल करके यह देखा जा सकता है कि उपयोगकर्ता ने साइन इन किया है या नहीं. साथ ही, itemType वैल्यू के आधार पर CreateAddOnAttachment, courseWork या courseWorkMaterials के announcements तरीके को कॉल किया जा सकता है. आईफ़्रेम में, शिक्षक को यह बताने के लिए कि ऐड-ऑन अटैचमेंट बनाया जा रहा है, लोडिंग स्क्रीन दिखाई जा सकती है.

ऐड-ऑन अटैचमेंट बन जाने के बाद, iframe बंद हो जाता है. इसके बाद, शिक्षक असाइनमेंट में अटैचमेंट को सामान्य तरीके से देख सकता है.

लागू करने से जुड़ी तकनीकी जानकारी

इस सेक्शन में, सुविधा से जुड़ी कुछ अहम तकनीकी जानकारी दी गई है.

`urlToUpgrade` क्वेरी पैरामीटर को पढ़ना

urlToUpgrade क्वेरी पैरामीटर को यूआरआई के तौर पर तब कोड में बदला जाता है, जब इसे लिंक अपग्रेड iframe पर पास किया जाता है. यूआरएल को उसके मूल फ़ॉर्म में पाने के लिए, आपको उसे डिकोड करना होगा. अगर JavaScript का इस्तेमाल किया जा रहा है, तो ऐसा करने के लिए decodeURIComponent() फ़ंक्शन का इस्तेमाल किया जा सकता है.

लिंक अपग्रेड करने वाला iframe बंद करें

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

कॉन्फ़िगरेशन की जानकारी

इस सुविधा को अपने ऐड-ऑन में इंटिग्रेट करने के लिए, ये कॉन्फ़िगरेशन ज़रूरी हैं:

लिंक अपग्रेड करने वाले iframe का यूआरएल: यह वह यूआरएल है जो शिक्षक के अपग्रेड करने के लिए सहमत होने पर iframe में खुलता है.
ऐसे यूआरएल पैटर्न जिन्हें Classroom को पहचानना चाहिए और अपग्रेड करने की कोशिश करनी चाहिए: यूआरएल पैटर्न में एक होस्ट और कई पाथ प्रीफ़िक्स शामिल हो सकते हैं.
- एक से ज़्यादा यूआरएल पैटर्न दिए जा सकते हैं.
- अगर आपने कोई पाथ प्रीफ़िक्स नहीं दिया है, तो होस्ट से मेल खाने वाले किसी भी यूआरएल को अपग्रेड किया जा सकता है.
- सिर्फ़ https स्कीम वाले यूआरएल को अपग्रेड किया जा सकता है.
- यूआरएल पैटर्न में localhost शामिल नहीं होना चाहिए.
- पाथ प्रीफ़िक्स में क्वेरी पैरामीटर या यूआरएल फ़्रैगमेंट शामिल नहीं होने चाहिए.
- फ़िलहाल, पाथ प्रीफ़िक्स में वाइल्डकार्ड इस्तेमाल किए जा सकते हैं, लेकिन होस्ट में नहीं:
  - example.com एक मान्य होस्ट है. साथ ही, /foo और /bar/*/baz मान्य पाथ प्रीफ़िक्स हैं.
  - example.*.host.com एक मान्य होस्ट नहीं है.
- पाथ प्रीफ़िक्स कॉम्पोनेंट के बीच मौजूद वाइल्डकार्ड, सिर्फ़ एक कॉम्पोनेंट से मैच करता है. यह स्लैश से अलग किए गए कई कॉम्पोनेंट से मैच नहीं करता. होस्ट example.com और पाथ प्रीफ़िक्स /bar/*/baz वाले यूआरएल पैटर्न पर विचार करें:
  - https://example.com/bar/123/baz, यूआरएल पैटर्न से मेल खाने वाला मान्य यूआरएल है.
  - https://example.com/bar/123/baz/456/789, यूआरएल पैटर्न से मेल खाने वाला मान्य यूआरएल है.
  - https://example.com/bar/123/456/baz, यूआरएल पैटर्न से मेल नहीं खाता, क्योंकि पाथ प्रीफ़िक्स में मौजूद वाइल्डकार्ड, /123/456/ से मेल नहीं खाता.

डेवलपमेंट प्रोसेस

जांच या प्रोडक्शन के लिए, लिंक अपग्रेड करने वाले ऐड-ऑन का iframe यूआरएल और यूआरएल पैटर्न भेजें. इसके लिए, classroom-link-upgrade-external@google.com पर ईमेल भेजें.

Classroom ऐड-ऑन के तौर पर काम करने वाले किसी भी Google Cloud प्रोजेक्ट के लिए कॉन्फ़िगरेशन दिए जा सकते हैं. हमारा सुझाव है कि आप सबसे पहले, निजता सेटिंग के साथ ऐड-ऑन के लिए कॉन्फ़िगरेशन दें. इससे, लाइव उपयोगकर्ताओं पर असर डाले बिना, डेमो डोमेन में ऐड-ऑन को डेवलप और टेस्ट किया जा सकता है.

कॉन्फ़िगरेशन चालू होने के बाद, आपको अपने ईमेल का जवाब मिलेगा. ध्यान दें कि localhost का इस्तेमाल करने वाले यूआरएल पैटर्न, इस सुविधा के साथ काम नहीं करते.

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

ईमेल को इस तरह से फ़ॉर्मैट करें कि इसमें यह जानकारी शामिल हो:

Google Cloud Project number: GCP_PROJECT_NUMBER

Link Upgrade iframe URL: LINK_UPGRADE_IFRAME_URL

URL Patterns:
-   Host:HOST_1
-   Path prefixes:
  -   PATH_PREFIX_1
  -   PATH_PREFIX_2

-   Host:HOST_2
-   Path prefixes:
  -   PATH_PREFIX_3
  -   PATH_PREFIX_4

// add more hosts and path prefixes as needed

इनकी जगह ये डालें:

GCP_PROJECT_NUMBER: यह Google Cloud प्रोजेक्ट का वह नंबर है जिससे ऐड-ऑन जुड़ा है.
LINK_UPGRADE_IFRAME_URL: वह यूआरएल जो लिंक अपग्रेड करने वाले iframe में खुलना चाहिए.
HOST_1: ऐसा होस्ट जिसे Classroom को पहचानना चाहिए. सिर्फ़ https स्कीम का इस्तेमाल किया जा सकता है.
PATH_PREFIX_1 और PATH_PREFIX_2: HOST_1 से जुड़े पाथ प्रीफ़िक्स, जिन्हें Classroom को ढूंढना चाहिए और अपग्रेड करने की कोशिश करनी चाहिए.
HOST_2: ऐसा होस्ट जिसे Classroom को पहचानना चाहिए. सिर्फ़ https स्कीम का इस्तेमाल किया जा सकता है.
PATH_PREFIX_3 और PATH_PREFIX_4: HOST_2 से जुड़े पाथ प्रीफ़िक्स, जिन्हें Classroom को ढूंढना चाहिए और अपग्रेड करने की कोशिश करनी चाहिए.

उपयोगकर्ताओं को बेहतर अनुभव देने के लिए सुझाव

इस सुविधा को लागू करते समय, इन सुझावों पर ध्यान दें.

शिक्षकों के लिए अतिरिक्त काम से बचना

हमारा सुझाव है कि साइन इन करने की सुविधा देने के लिए, iframe का इस्तेमाल करें. अगर ज़रूरत हो, तो लोडिंग इंडिकेटर दिखाएं. उपयोगकर्ता को बेहतर अनुभव देने के लिए, शिक्षक को चिपकाए गए लिंक को ऐड-ऑन अटैचमेंट में अपग्रेड करने की सहमति देने के बाद, कोई अतिरिक्त जानकारी देने के लिए नहीं कहा जाना चाहिए. हालांकि, अगर आपके ऐड-ऑन के लिए ऐसा करना मुमकिन नहीं है, तो लिंक अपग्रेड करने वाले iframe का इस्तेमाल करके, ज़रूरी अतिरिक्त जानकारी इकट्ठा की जा सकती है. अगर लिंक को अपग्रेड नहीं किया जा सकता या कोई गड़बड़ी हुई है, तो शिक्षक को इसकी सूचना देने के लिए भी iframe का इस्तेमाल किया जा सकता है.

ऐक्सेस से जुड़ी गड़बड़ी के ऐसे मैसेज शामिल करें जिन्हें उपयोगकर्ता आसानी से समझ सकें

अगर शिक्षक ऐसे लिंक को चिपकाकर अपग्रेड करते हैं जिसका ऐक्सेस उनके पास नहीं है, तो iframe में गड़बड़ी का ऐसा मैसेज दिखाएं जिसे आसानी से समझा जा सके. इससे शिक्षकों को समस्या के बारे में पता चलेगा. आईफ़्रेम का इस्तेमाल, शिक्षक को कॉन्टेंट ऐक्सेस करने की ज़रूरी अनुमतियां देने के लिए भी किया जा सकता है.