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

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

खास जानकारी

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

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

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

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

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

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

इस सेक्शन में, सुविधा की अहम तकनीकी जानकारी को हाइलाइट किया गया है.

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

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

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

इस सुविधा का इस्तेमाल करने वालों को बेहतर अनुभव देने के लिए, ऐड-ऑन अटैचमेंट बनने के बाद postMessage भेजें. इससे iframe बंद हो जाता है. ज़्यादा जानकारी के लिए, 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 यूआरएल और यूआरएल पैटर्न भेजें. इसके लिए, [e-mail] पर ईमेल करें.

सबसे पहले, अपने निजी ऐड-ऑन और अपने किसी भी टेस्ट या डेवलपमेंट एनवायरमेंट के लिए कॉन्फ़िगरेशन उपलब्ध कराए जा सकते हैं. आपके डेमो डोमेन में फ़्लो की जांच करने के लिए, Classroom की टीम आपके प्रोडक्शन कॉन्फ़िगरेशन को चालू करने से पहले, जांच के इन कॉन्फ़िगरेशन को चालू कर सकती है. कॉन्फ़िगरेशन चालू होने के बाद, आपको अपने ईमेल पर जवाब मिलेगा. ध्यान दें कि 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 में उपयोगकर्ता के लिए आसान गड़बड़ी का मैसेज दिखाएं, ताकि शिक्षकों को इस समस्या के बारे में पता चल सके. iframe का इस्तेमाल शिक्षक को कॉन्टेंट ऐक्सेस करने की सही अनुमतियां देने के लिए भी किया जा सकता है.