Google Editor इंटरफ़ेस बनाना

Google Workspace ऐड-ऑन की मदद से, एडिटर के अंदर पसंद के मुताबिक इंटरफ़ेस उपलब्ध कराए जा सकते हैं, जिसमें Google Docs, Sheets, और Slides शामिल हैं. इससे आप उपयोगकर्ता को यह जानकारी दे सकते हैं: काम की जानकारी, टास्क को ऑटोमेट करने, और तीसरे पक्ष के सिस्टम को एडिटर.

ऐड-ऑन यूज़र इंटरफ़ेस (यूआई) ऐक्सेस करना

Google Workspace ऐड-ऑन को एडिटर में जाकर खोला जा सकता है अगर इसका आइकॉन Google Workspace Docs, Sheets, और Slides का इस्तेमाल करने वाले व्यक्ति की दाईं ओर मौजूद साइड पैनल को ऐक्सेस करने की अनुमति दें इंटरफ़ेस.

Google Workspace ऐड-ऑन में ये इंटरफ़ेस हो सकते हैं:

• होम पेज इंटरफ़ेस: अगर ऐड-ऑन का मेनिफ़ेस्ट है, तो इसमें ट्रिगर EDITOR_NAME.homepageTrigger जिस एडिटर में उपयोगकर्ता ऐड-ऑन खोलता है उसके लिए, ऐड-ऑन बनाता है और खास तौर पर, होम पेज कार्ड उस एडिटर को. अगर ऐड-ऑन के मेनिफ़ेस्ट में उपयोगकर्ता के खोले गए एडिटर के लिए EDITOR_NAME.homepageTrigger तो उसके बजाय एक सामान्य होम पेज कार्ड दिखाया जाता है.

• REST API इंटरफ़ेस: अगर ऐड-ऑन, REST का इस्तेमाल करता है, तो एपीआई की मदद से, उन ट्रिगर को शामिल किया जा सकता है जो किसी दस्तावेज़ की हर फ़ाइल का ऐक्सेस मांगते हैं drive.file दायरे का इस्तेमाल करके. एक बार दिए जाने के बाद, EDITOR_NAME.onFileScopeGrantedTrigger लागू करता है और इस फ़ाइल के लिए एक खास इंटरफ़ेस दिखाता है.

• लिंक की झलक दिखाने वाले इंटरफ़ेस: अगर आपका ऐड-ऑन तीसरे पक्ष की सेवा के साथ इंटिग्रेट किया जाता है, तो आपके पास ऐसे कार्ड बनाने का विकल्प होता है जिनकी झलक देखी जा सकती है आपकी सेवा के यूआरएल से लिया गया कॉन्टेंट.

एडिटर ऐड-ऑन के लिए इंटरफ़ेस बनाना

यह तरीका अपनाकर, एडिटर के लिए एडिटर ऐड-ऑन इंटरफ़ेस बनाएं:

1. उचित को जोड़ें addOns.common addOns.docs, addOns.sheets, और addOns.slides फ़ील्ड को ऐड-ऑन स्क्रिप्ट प्रोजेक्ट मेनिफ़ेस्ट में जोड़ना होगा.
2. इसमें सभी ज़रूरी एडिटर के दायरे जोड़ें आपका स्क्रिप्ट प्रोजेक्ट मेनिफ़ेस्ट होगा.
3. अगर एडिटर के लिए खास होम पेज दिया जा रहा है, तो लागू करें EDITOR_NAME.homepageTrigger का इस्तेमाल करें. अगर ऐसा नहीं है, तो common.homepageTrigger इंटरफ़ेस की मदद से, आपके होस्ट ऐप्लिकेशन के लिए एक सामान्य होम पेज बनाया जा सकता है.
4. अगर REST API का इस्तेमाल किया जाता है, तो drive.file के स्कोप का ऑथराइज़ेशन फ़्लो लागू करें और EDITOR_NAME.onFileScopeGrantedTrigger ट्रिगर फ़ंक्शन का इस्तेमाल करके, खुली हुई फ़ाइल के लिए खास इंटरफ़ेस दिखाया जा सकता है. ज़्यादा के लिए REST API इंटरफ़ेस देखें.
5. अगर तीसरे पक्ष की किसी सेवा की मदद से लिंक की झलक कॉन्फ़िगर की जा रही हैं, तो https://www.googleapis.com/auth/workspace.linkpreview स्कोप का ऑथराइज़ेशन फ़्लो और linkPreviewTriggers फ़ंक्शन का इस्तेमाल करना होगा. ज़्यादा जानकारी के लिए, यह देखें लिंक की झलक दिखाने वाले इंटरफ़ेस.
6. उपयोगकर्ता की क्वेरी का जवाब देने के लिए, संबंधित कॉलबैक फ़ंक्शन लागू करें यूज़र इंटरफ़ेस (यूआई) के इंटरैक्शन, जैसे कि बटन पर होने वाले क्लिक.

एडिटर के होम पेज

आपको अपने ऐड-ऑन के स्क्रिप्ट प्रोजेक्ट में होम पेज ट्रिगर फ़ंक्शन देना होगा जो सिंगल Card बनाता और रिटर्न करता है या Card ऑब्जेक्ट का कलेक्शन, जो ऐड-ऑन के होम पेज को बनाता है.

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

कोई ऐसा होम पेज या होम पेज भी दिखाया जा सकता है जो खास तौर पर एडिटर के लिए हो जब उपयोगकर्ता आपका ऐड-ऑन खोलता है.

सामान्य होम पेज दिखाना

एडिटर में अपने ऐड-ऑन के सामान्य होम पेज को दिखाने के लिए, सही जानकारी शामिल करें एडिटर फ़ील्ड, जैसे कि addOns.docs, addOns.sheets, या addOns.slides, के मेनिफ़ेस्ट में मौजूद हैं.

यहां दिए गए उदाहरण में, Google Workspace ऐड-ऑन का addons वाला हिस्सा दिखाया गया है मेनिफ़ेस्ट. ऐड-ऑन Docs, Sheets, और Slides का इस्तेमाल करता है. साथ ही, होम पेज पर एक नज़र डालें.

 "addOns": {
    "common": {
      "name": "Translate",
      "logoUrl": "https://www.gstatic.com/images/branding/product/1x/translate_24dp.png",
      "layoutProperties": {
        "primaryColor": "#2772ed"
      },
      "homepageTrigger": {
        "runFunction": "onHomepage"
      }
    },
    "docs": {},
    "sheets": {},
    "slides": {}
  }
}

एडिटर के हिसाब से होम पेज दिखाना

किसी एडिटर टूल का होम पेज दिखाने के लिए, ऐड-ऑन में EDITOR_NAME.homepageTrigger जोड़ें मेनिफ़ेस्ट.

इस उदाहरण में, Google Workspace ऐड-ऑन मेनिफ़ेस्ट का addons वाला हिस्सा दिखाया गया है. यह ऐड-ऑन Docs, Sheets, और Slides के लिए चालू है. यह सामान्य जानकारी होम पेज, Docs और Slides में होता है. साथ ही, Sheets में एक यूनीक होम पेज होता है. कॉलबैक onSheetsHomepage फ़ंक्शन, Sheets के लिए खास होम पेज कार्ड बनाता है.

 "addOns": {
    "common": {
      "name": "Translate",
      "logoUrl": "https://www.gstatic.com/images/branding/product/1x/translate_24dp.png",
      "layoutProperties": {
        "primaryColor": "#2772ed"
      },
      "homepageTrigger": {
        "runFunction": "onHomepage"
      }
    },
    "docs": {},
    "slides": {},
    "sheets": {
     "homepageTrigger": {
       "runFunction": "onSheetsHomepage"
     },
  }
}

REST API इंटरफ़ेस

अगर आपका ऐड-ऑन, Google Sheets API जैसे REST API का इस्तेमाल करता है, तो आप नया इंटरफ़ेस दिखाने के लिए onFileScopeGrantedTrigger फ़ंक्शन का इस्तेमाल कर सकते हैं खास तौर पर, Editor होस्ट ऐप्लिकेशन में खुली हुई फ़ाइल के लिए.

आपको drive.file स्कोप अनुमति देने का फ़्लो शामिल करना होगा, ताकि onFileScopeGrantedTrigger फ़ंक्शन. drive.file से अनुरोध करने का तरीका जानने के लिए के हिसाब से, मौजूदा दस्तावेज़ के लिए फ़ाइल का ऐक्सेस पाने का अनुरोध करें देखें.

जब कोई उपयोगकर्ता drive.file स्कोप की अनुमति देता है, तो EDITOR_NAME.onFileScopeGrantedTrigger.runFunction आग लग रही है. ट्रिगर के सक्रिय होने पर, यह प्रासंगिक ट्रिगर फ़ंक्शन को चालू करता है इस फ़ील्ड में EDITOR_NAME.onFileScopeGrantedTrigger.runFunction फ़ील्ड से तय ऐड-ऑन मेनिफ़ेस्ट.

किसी संपादक के लिए REST API इंटरफ़ेस बनाने के लिए, नीचे दिया गया तरीका अपनाएं. EDITOR_NAME की जगह Editor होस्ट वाला वह ऐप्लिकेशन इस्तेमाल करें जिसे आपने चुना है उदाहरण के लिए, sheets.onFileScopeGrantedTrigger का इस्तेमाल करें.

1. EDITOR_NAME.onFileScopeGrantedTrigger शामिल करें का इस्तेमाल करें. उदाहरण के लिए, अगर Google शीट में यह इंटरफ़ेस बनाना चाहते हैं, तो ट्रिगर को इसमें जोड़ें "sheets" सेक्शन में.
2. EDITOR_NAME.onFileScopeGrantedTrigger में दिया गया फ़ंक्शन लागू करें सेक्शन में जाएं. यह फ़ंक्शन इवेंट ऑब्जेक्ट को आर्ग्युमेंट के तौर पर स्वीकार करता है. इसलिए, इसमें से Card ऑब्जेक्ट या Card ऑब्जेक्ट का कलेक्शन.
3. किसी भी अन्य कार्ड की तरह, आपको इन चीज़ों के लिए इस्तेमाल किए जाने वाले कॉलबैक फ़ंक्शन को लागू करना होगा इंटरफ़ेस के लिए विजेट की इंटरैक्टिविटी. उदाहरण के लिए, यदि आप इंटरफ़ेस में, इसमें अटैच की गई Action और एक लागू कॉलबैक फ़ंक्शन होना चाहिए, जो बटन के क्लिक किया जाता है.

इस उदाहरण में, Google Workspace ऐड-ऑन मेनिफ़ेस्ट का addons वाला हिस्सा दिखाया गया है. ऐड-ऑन, REST API का इस्तेमाल करता है, इसलिए onFileScopeGrantedTrigger को Google Sheets. जब कोई उपयोगकर्ता drive.file स्कोप की अनुमति देता है, तो कॉलबैक फ़ंक्शन onFileScopeGrantedSheets, फ़ाइल के लिए खास इंटरफ़ेस बनाता है.

"addOns": {
   "common": {
     "name": "Productivity add-on",
     "logoUrl": "https://www.gstatic.com/images/icons/material/system_gm/1x/work_outline_black_18dp.png",
     "layoutProperties": {
       "primaryColor": "#669df6",
       "secondaryColor": "#ee675c"
     }
   },
   "sheets": {
     "homepageTrigger": {
       "runFunction": "onEditorsHomepage"
     },
     "onFileScopeGrantedTrigger": {
       "runFunction": "onFileScopeGrantedSheets"
     }
   }

तीसरे पक्ष की सेवाओं के लिए, लिंक की झलक दिखाने वाले इंटरफ़ेस

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

लिंक की झलक देखने की सुविधा चालू करने का तरीका जानने के लिए, यहां जाएं स्मार्ट चिप की मदद से लिंक की झलक देखना.

इवेंट ऑब्जेक्ट

एक इवेंट ऑब्जेक्ट बनाया जाता है और फ़ंक्शन को ट्रिगर करने के लिए पास किया जाता है, जैसे कि EDITOR_NAME.homepageTrigger या EDITOR_NAME.onFileScopeGrantedTrigger. ट्रिगर फ़ंक्शन इवेंट ऑब्जेक्ट का इस्तेमाल करके, ऐड-ऑन कार्ड बनाने का तरीका तय करते हैं या ऐड-ऑन व्यवहार.

इवेंट ऑब्जेक्ट के पूरे स्ट्रक्चर के बारे में इवेंट ऑब्जेक्ट में बताया गया है.

जब एडिटर, ऐड-ऑन का होस्ट ऐप्लिकेशन होता है, तो इवेंट ऑब्जेक्ट में ये शामिल होते हैं Docs, Sheets या Slides इवेंट ऑब्जेक्ट फ़ील्ड, जिनमें क्लाइंट की जानकारी होती है.

अगर ऐड-ऑन के पास मौजूदा उपयोगकर्ता के लिए, drive.file दायरे की अनुमति नहीं है या दस्तावेज़ है, तो इवेंट ऑब्जेक्ट में केवल docs.addonHasFileScopePermission, sheets.addonHasFileScopePermission या slides.addonHasFileScopePermission फ़ील्ड. अगर ऐड-ऑन में अनुमति देते हैं, तो इवेंट ऑब्जेक्ट में सभी Editor इवेंट ऑब्जेक्ट फ़ील्ड शामिल होते हैं.

नीचे दिए गए उदाहरण में, एक Editor इवेंट ऑब्जेक्ट दिखाया गया है जिसे sheets.onFileScopeGrantedTrigger फ़ंक्शन का इस्तेमाल करना होगा. यहाँ, ऐड-ऑन में मौजूदा दस्तावेज़ के लिए drive.file दायरे की अनुमति:

`        {
          "commonEventObject": { ... },
          "sheets": {
            "addonHasFileScopePermission": true,
            "id":"A_24Q3CDA23112312ED52",
            "title":"How to get started with Sheets"
          },
          ...
        }