Google Workspace ऐड-ऑन क्विकस्टार्ट बनाना

Node.js रनटाइम का इस्तेमाल करके, Cloud Functions में Google Workspace ऐड-ऑन बनाएं.

मकसद

  • अपना एनवायरमेंट सेट अप करें.
  • Cloud फ़ंक्शन बनाना और डिप्लॉय करना.
  • ऐड-ऑन बनाएं और डिप्लॉय करें.
  • ऐड-ऑन इंस्टॉल करें.

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

अपना एनवायरमेंट सेट अप करें

Google Cloud कंसोल में अपना Cloud प्रोजेक्ट खोलना

  1. Google Cloud Console में, प्रोजेक्ट चुनें पेज पर जाएं.

    कोई क्लाउड प्रोजेक्ट चुनें

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

उस स्क्रीन को कॉन्फ़िगर करना जहां OAuth के लिए सहमति दी जाती है

Google Workspace ऐड-ऑन के लिए, ऐसी स्क्रीन कॉन्फ़िगर करना ज़रूरी है जिसके लिए सहमति दी गई हो. अपने ऐड-ऑन की OAuth सहमति वाली स्क्रीन को कॉन्फ़िगर करने से यह तय होता है कि Google उपयोगकर्ताओं को क्या दिखाएगा.

  1. Google Cloud Console में, मेन्यू > एपीआई और सेवाएं > OAuth की सहमति वाली स्क्रीन पर जाएं.

    ऐसी स्क्रीन पर जाएं जहां OAuth के लिए सहमति दी जाती है

  2. अपने ऐप्लिकेशन के लिए, उपयोगकर्ता का टाइप चुनें. इसके बाद, बनाएं पर क्लिक करें.
  3. ऐप्लिकेशन रजिस्ट्रेशन फ़ॉर्म भरें. इसके बाद, सेव करें और जारी रखें पर क्लिक करें.

  4. फ़िलहाल, दायरे को न जोड़कर, सेव करें और जारी रखें पर क्लिक करें. आने वाले समय में, जब आपको अपने संगठन के Google Workspace से बाहर इस्तेमाल करने के लिए कोई ऐप्लिकेशन बनाना होगा, तो आपको अपने ऐप्लिकेशन के लिए ज़रूरी अनुमति वाले स्कोप जोड़ने होंगे और उनकी पुष्टि करनी होगी.

  5. अगर आपने उपयोगकर्ता टाइप के लिए बाहरी उपयोगकर्ता को चुना है, तो टेस्ट उपयोगकर्ता जोड़ें:
    1. टेस्ट उपयोगकर्ता में जाकर, उपयोगकर्ता जोड़ें पर क्लिक करें.
    2. अपना ईमेल पता और जांच के लिए अनुमति पा चुके किसी अन्य उपयोगकर्ता का नाम डालें. इसके बाद, सेव करें और जारी रखें पर क्लिक करें.
  6. अपने ऐप्लिकेशन रजिस्ट्रेशन की खास जानकारी की समीक्षा करें. बदलाव करने के लिए, बदलाव करें पर क्लिक करें. अगर ऐप्लिकेशन रजिस्ट्रेशन ठीक लगता है, तो डैशबोर्ड पर वापस पर क्लिक करें.

Cloud फ़ंक्शन बनाना और डिप्लॉय करना

  1. लोकल टर्मिनल में, Cloud Functions, Cloud Build, और Google Workspace ऐड-ऑन एपीआई को चालू करें:

    gcloud services enable cloudfunctions cloudbuild.googleapis.com gsuiteaddons.googleapis.com

  2. किसी खाली डायरेक्ट्री में, इस सैंपल कोड के साथ function.js फ़ाइल बनाएं:

    /**
 * Cloud Function that loads the homepage for a
 * Google Workspace Add-on.
 *
 * @param {Object} req Request sent from Google
 * @param {Object} res Response to send back
 */
exports.loadHomePage = function addonsHomePage (req, res) {
  res.send(createAction());
};

/** Creates a card with two widgets. */
function createAction() {
  return {
    "action": {
      "navigations": [
        {
          "pushCard": {
            "header": {
              "title": "Cats!"
            },
            "sections": [
              {
                "widgets": [
                  {
                    "textParagraph": {
                      "text": "Your random cat:"
                    }
                  },
                  {
                    "image": {
                      "imageUrl": "https://cataas.com/cat"
                     }
                  }
                ]
              }
            ]
          }
        }
      ]
    }
  };
}

  3. फ़ंक्शन को डिप्लॉय करें:

    gcloud functions deploy loadHomePage --runtime nodejs12 --trigger-http

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

ऐड-ऑन डिप्लॉयमेंट बनाना

  1. ऐड-ऑन के लिए सेवा खाते का ईमेल ढूंढें:

    gcloud workspace-add-ons get-authorization

  2. सेवा खाते को cloudfunctions.invoker की भूमिका दें:

    gcloud functions add-iam-policy-binding loadHomePage \
    --role roles/cloudfunctions.invoker \
    --member serviceAccount:SERVICE_ACCOUNT_EMAIL

  3. लागू किए गए फ़ंक्शन का यूआरएल पाएं. यूआरएल पाने के लिए, नीचे दिया गया कमांड चलाएं और httpsTrigger सेक्शन में url फ़ील्ड खोजें:

    gcloud functions describe loadHomePage

  4. नीचे दिए गए सैंपल कोड की मदद से, deployment.json फ़ाइल बनाएं. URL को पिछले चरण के लागू किए गए फ़ंक्शन के यूआरएल से बदलें.

    {
  "oauthScopes": ["https://www.googleapis.com/auth/gmail.addons.execute"],
  "addOns": {
    "common": {
      "name": "My HTTP Add-on",
      "logoUrl": "https://raw.githubusercontent.com/webdog/octicons-png/main/black/beaker.png",
      "homepageTrigger": {
        "runFunction": "URL"
      }
    },
    "gmail": {},
    "drive": {},
    "calendar": {},
    "docs": {},
    "sheets": {},
    "slides": {}
  }
}

  5. डिप्लॉयमेंट बनाएं:

    gcloud workspace-add-ons deployments create quickstart \
    --deployment-file=deployment.json

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

  1. डेवलपमेंट मोड में डिप्लॉयमेंट इंस्टॉल करें:

    gcloud workspace-add-ons deployments install quickstart

  2. ऐड-ऑन देखने के लिए, Gmail खोलें या फिर से लोड करें. दाईं ओर मौजूद टूलबार में, बीकर आइकॉन खोजें.

  3. ऐड-ऑन खोलने के लिए, आइकॉन पर क्लिक करें. अगर कहा जाए, तो ऐड-ऑन को अनुमति दें.

ज़रूरी नहीं: जगह खाली करें

अपने खाते पर शुल्क लगाने से बचने के लिए, उन संसाधनों को मिटा दें जिन्हें आपने बनाया है:

  1. अपने Google खाते से ऐड-ऑन अनइंस्टॉल करने के लिए:

    gcloud workspace-add-ons deployments uninstall quickstart

  2. इस क्विकस्टार्ट में इस्तेमाल किए गए संसाधनों के लिए शुल्क देने से बचने के लिए, यह क्लाउड प्रोजेक्ट मिटाएं:

    gcloud projects delete PROJECT_ID

    PROJECT_ID को उस क्लाउड प्रोजेक्ट के आईडी से बदलें जो आपने क्विकस्टार्ट के लिए इस्तेमाल किया था. आपको डैशबोर्ड पेज पर Google Cloud Console में Cloud प्रोजेक्ट आईडी मिल सकता है.

अगले चरण

अपने Google Workspace ऐड-ऑन में ज़्यादा सुविधाएं जोड़ने के लिए, यहां दी गई गाइड देखें: