Classroom ऐड-ऑन बनाएं

Classroom के ऐड-ऑन के बारे में जानकारी देने वाली वॉकथ्रू सीरीज़ का यह पहला वॉकथ्रू है.

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

इस वॉकथ्रू में, आपको ये काम करने होंगे:

• अपने ऐड-ऑन के लिए नया Google Cloud प्रोजेक्ट बनाएं.
• प्लेसहोल्डर साइन-इन बटन वाला स्केलेटन वेब ऐप्लिकेशन बनाएं.
• अपने ऐड-ऑन के लिए, Google Workspace Marketplace की स्टोर पेज लिस्टिंग पब्लिश करें.

इसके बाद, अपना ऐड-ऑन इंस्टॉल करें और उसे Classroom के ऐड-ऑन iframe में लोड करें.

ज़रूरी शर्तें

ज़रूरी शर्तें देखने के लिए कोई भाषा चुनें:

python -m ensurepip --upgrade

python3 -m venv .classroom-addon-env
source .classroom-addon-env/bin/activate

cd flask/01-basic-app
pip install -r requirements.txt

npm install

java --version
./mvnw --version

java -version
mvnw.cmd --version

Google Cloud प्रोजेक्ट सेट अप करना

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

प्रोजेक्ट बनाएं

नया प्रोजेक्ट बनाने वाले पेज पर जाकर, नया Google Cloud प्रोजेक्ट बनाएं. आपके पास नए प्रोजेक्ट को कोई भी नाम देने का विकल्प होता है. बनाएं पर क्लिक करें.

नया प्रोजेक्ट पूरी तरह से बनने में कुछ समय लगता है. इसके बाद, प्रोजेक्ट चुनना न भूलें. इसे स्क्रीन पर सबसे ऊपर मौजूद, प्रोजेक्ट चुनने वाले ड्रॉप-डाउन मेन्यू में जाकर चुना जा सकता है. इसके अलावा, सबसे ऊपर दाईं ओर मौजूद सूचनाओं वाले मेन्यू में जाकर, प्रोजेक्ट चुनें पर क्लिक करें.

Google Workspace Marketplace SDK को Google Cloud प्रोजेक्ट से अटैच करना

एपीआई लाइब्रेरी ब्राउज़र पर जाएं. Google Workspace Marketplace SDK खोजें. आपको नतीजों की सूची में SDK टूल दिखेगा.

Google Workspace Marketplace SDK टूल कार्ड चुनें. इसके बाद, चालू करें पर क्लिक करें.

Google Workspace Marketplace SDK टूल को कॉन्फ़िगर करना

Google Workspace Marketplace, लिस्टिंग उपलब्ध कराता है. इसकी मदद से, उपयोगकर्ता और एडमिन आपका ऐड-ऑन इंस्टॉल करते हैं. आगे बढ़ने के लिए, Marketplace SDK के ऐप्लिकेशन कॉन्फ़िगरेशन और स्टोर पेज के साथ-साथ OAuth की सहमति वाली स्क्रीन को कॉन्फ़िगर करें.

ऐप्लिकेशन का कॉन्फ़िगरेशन

Marketplace SDK टूल के ऐप्लिकेशन कॉन्फ़िगरेशन पेज पर जाएं. यह जानकारी दें:

• ऐप्लिकेशन किसको दिखे को Public या Private पर सेट करें.

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

• अगर आपको डोमेन एडमिन के लिए ही इंस्टॉलेशन की अनुमति देनी है, तो इंस्टॉलेशन सेटिंग को Admin Only install पर सेट करें.

• ऐप्लिकेशन इंटिग्रेशन में जाकर, Classroom ऐड-ऑन चुनें. आपको सुरक्षित अटैचमेंट सेटअप यूआरआई के लिए प्रॉम्प्ट किया जाता है. यह वह यूआरएल है जिसकी उम्मीद किसी उपयोगकर्ता के आपका ऐड-ऑन खोलने पर होती है. इस वॉकथ्रू के लिए, यह https://<your domain>/addon-discovery पर सेट होना चाहिए.

• अटैचमेंट के लिए अनुमति वाले यूआरआई के प्रीफ़िक्स का इस्तेमाल, courses.*.addOnAttachments.create और courses.*.addOnAttachments.patch तरीकों का इस्तेमाल करके, AddOnAttachment में सेट किए गए यूआरआई की पुष्टि करने के लिए किया जाता है. पुष्टि करने की प्रोसेस, स्ट्रिंग प्रीफ़िक्स लिटरल होती है. साथ ही, इस समय वाइल्ड कार्ड का इस्तेमाल नहीं किया जा सकता है. अपने कॉन्टेंट सर्वर का कम से कम रूट डोमेन जोड़ें, जैसे कि https://localhost:5000/ या https://cdn.myedtech.com/.

• वही OAuth के दायरे जोड़ें जो पिछले चरण में OAuth के लिए सहमति वाली स्क्रीन पर दिए गए थे.

• डेवलपर लिंक में जाकर, अपने संगठन के हिसाब से फ़ील्ड भरें.

स्टोर सूची

Marketplace SDK टूल के स्टोर पेज पर जाएं. यह जानकारी दें:

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

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

OAuth की सहमति वाली स्क्रीन

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

OAuth सहमति स्क्रीन बनाने वाले पेज पर जाएं. यह जानकारी दें:

• उपयोगकर्ता टाइप को बाहरी पर सेट करें. बनाएं पर क्लिक करें.
• अगले पेज पर, ऐप्लिकेशन की ज़रूरी जानकारी और संपर्क जानकारी भरें. अनुमति वाले डोमेन में, अपने ऐप्लिकेशन को होस्ट करने वाले सभी डोमेन डालें. सेव करें और जारी रखें पर क्लिक करें.

• अपने वेब ऐप्लिकेशन के लिए ज़रूरी, OAuth का दायरा जोड़ें. स्कोप और उनके मकसद के बारे में ज़्यादा जानने के लिए, OAuth कॉन्फ़िगरेशन गाइड देखें.

  Google, login_hint क्वेरी पैरामीटर भेज सके, इसके लिए आपको इनमें से कम से कम एक स्कोप का अनुरोध करना होगा. इस व्यवहार के बारे में ज़्यादा जानकारी, OAuth कॉन्फ़िगरेशन गाइड में उपलब्ध है:

  • https://www.googleapis.com/auth/userinfo.email (पहले से शामिल है)
  • https://www.googleapis.com/auth/userinfo.profile (पहले से शामिल है)

  ये स्कोप खास तौर पर Classroom के ऐड-ऑन के लिए हैं:

  • https://www.googleapis.com/auth/classroom.addons.teacher
  • https://www.googleapis.com/auth/classroom.addons.student

  ऐसे अन्य Google API स्कोप भी शामिल करें जिनकी ज़रूरत आपके ऐप्लिकेशन को, एंड-उपयोगकर्ताओं से होती है.

  सहेजें और जारी रखें पर क्लिक करें.

• टेस्ट उपयोगकर्ता पेज पर, टेस्टिंग खातों के ईमेल पते डालें. सेव करें और जारी रखें पर क्लिक करें.

पुष्टि करें कि आपकी सेटिंग सही हैं. इसके बाद, डैशबोर्ड पर वापस जाएं.

ऐड-ऑन इंस्टॉल करने का तरीका

अब आपके पास Marketplace SDK टूल के स्टोर पेज पर सबसे ऊपर मौजूद लिंक का इस्तेमाल करके, अपना ऐड-ऑन इंस्टॉल करने का विकल्प है. लिस्टिंग देखने के लिए, पेज में सबसे ऊपर मौजूद ऐप्लिकेशन के यूआरएल पर क्लिक करें. इसके बाद, इंस्टॉल करें को चुनें.

कोई बुनियादी वेब ऐप्लिकेशन बनाना

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

इन दो एंडपॉइंट को लागू करें:

• /: यह वेलकम मैसेज दिखाता है. साथ ही, मौजूदा टैब और ऐड-ऑन iframe, दोनों को बंद करने के लिए एक बटन दिखाता है.
• /addon-discovery: वेलकम मैसेज और दो बटन दिखाता है: पहला, ऐड-ऑन का iframe बंद करने के लिए और दूसरा, किसी वेबसाइट को नए टैब में खोलने के लिए.

ध्यान दें कि हम विंडो या iframe बनाने और बंद करने के लिए बटन जोड़ रहे हैं. इनमें, अगले वॉकथ्रू में अनुमति देने के लिए, उपयोगकर्ता को सुरक्षित तरीके से नए टैब में पॉप करने का तरीका बताया गया है.

यूटिलिटी स्क्रिप्ट बनाना

static/scripts डायरेक्ट्री बनाएं. एक नई फ़ाइल addon-utils.js बनाएं. यहां दिए गए दो फ़ंक्शन जोड़ें.

/**
 *   Opens a given destination route in a new window. This function uses
 *   window.open() so as to force window.opener to retain a reference to the
 *   iframe from which it was called.
 *   @param {string} destinationURL The endpoint to open, or "/" if none is
 *   provided.
 */
function openWebsiteInNewTab(destinationURL = '/') {
  window.open(destinationURL, '_blank');
}

/**
 *   Close the iframe by calling postMessage() in the host Classroom page. This
 *   function can be called directly when in a Classroom add-on iframe.
 *
 *   Alternatively, it can be used to close an add-on iframe in another window.
 *   For example, if an add-on iframe in Window 1 opens a link in a new Window 2
 *   using the openWebsiteInNewTab function, you can call
 *   window.opener.closeAddonIframe() from Window 2 to close the iframe in Window
 *   1.
 */
function closeAddonIframe() {
  window.parent.postMessage({
    type: 'Classroom',
    action: 'closeIframe',
  }, '*');
};

रास्ते बनाना

/addon-discovery और / एंडपॉइंट लागू करें.

from flask import Flask
import config

app = Flask(__name__)
app.config.from_object(config.Config)

# Load other module script files. This import statement refers to the
# 'routes.py' file described below.
from webapp import routes

from webapp import app
import flask

@app.route("/")
def index():
    return flask.render_template("index.html",
                                message="You've reached the index page.")

@app.route("/classroom-addon")
def classroom_addon():
    return flask.render_template(
        "addon-discovery.html",
        message="You've reached the addon discovery page.")

import os

class Config(object):
    # Note: A secret key is included in the sample so that it works.
    # If you use this code in your application, replace this with a truly secret
    # key. See https://flask.palletsprojects.com/quickstart/#sessions.
    SECRET_KEY = os.environ.get(
        'SECRET_KEY') or "REPLACE ME - this value is here as a placeholder."

from webapp import app

if __name__ == "__main__":
    # Run the application over HTTPs with a locally stored certificate and key.
    # Defaults to https://localhost:5000.
    app.run(
        host="localhost",
        ssl_context=("localhost.pem", "localhost-key.pem"),
        debug=True)

const websiteRouter = require('./routes/index');
const addonRouter = require('./routes/classroom-addon');

app.use('/', websiteRouter);
app.use('/addon-discovery', addonRouter);

router.get('/', function (req, res, next) {
  res.render('index', {
    title: 'Education Technology',
    message: 'Welcome to our website!'
  });
});

router.get('/', function (req, res, next) {
  res.render('discovery', {
    layout: 'addon.hbs',
    title: 'Education Technology Classroom add-on',
    message: `Welcome.`
  });
});

import org.springframework.web.bind.annotation.GetMapping;

@org.springframework.stereotype.Controller
public class Controller {

/** Returns the index page that will be displayed when the add-on opens in a
*   new tab.
*   @param model the Model interface to pass error information that's
*   displayed on the error page.
*   @return the index page template if successful, or the onError method to
*   handle and display the error message.
*/
@GetMapping(value = {"/"})
public String index(Model model) {
  try {
    return "index";
  } catch (Exception e) {
    return onError(e.getMessage(), model);
  }
}

/** Returns the add-on discovery page that will be displayed when the iframe
*   is first opened in Classroom.
*   @param model the Model interface to pass error information that's
*   displayed on the error page.
*   @return the addon-discovery page.
*/
@GetMapping(value = {"/addon-discovery"})
public String addon_discovery(Model model) {
  try {
    return "addon-discovery";
  } catch (Exception e) {
    return onError(e.getMessage(), model);
  }
}

/** Handles application errors.
*   @param errorMessage message to be displayed on the error page.
*   @param model the Model interface to pass error information to display on
*   the error page.
*   @return the error page.
*/
@GetMapping(value = {"/error"})
public String onError(String errorMessage, Model model) {
  model.addAttribute("error", errorMessage);
  return "error";
}

ऐड-ऑन का परीक्षण करें

अपना सर्वर लॉन्च करें. इसके बाद, Google Classroom में अपने शिक्षक के तौर पर साइन इन करें. क्लासवर्क टैब पर जाएं और नया असाइनमेंट बनाएं. ऐड-ऑन पिकर से अपना ऐड-ऑन चुनें. iframe खुल जाता है और ऐड-ऑन, अटैचमेंट सेटअप यूआरआई को लोड करता है. यह यूआरआई, आपने Marketplace SDK टूल के ऐप्लिकेशन कॉन्फ़िगरेशन पेज पर डाला था.

बधाई हो! अब आप अगले चरण पर जा सकते हैं: Google एसएसओ (SSO) की मदद से उपयोगकर्ताओं को साइन इन कराना.