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

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

खास जानकारी

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

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

• courseId
• itemId (postId से नाम बदला गया)
• itemType (नया!)
• addOnToken
• login_hint या hd
• urlToUpgrade (नया!)

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

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

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

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

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

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