Google Workspace का नया ऐड-ऑन बनाने के लिए, यह सामान्य तरीका अपनाएं:
- अपने ऐड-ऑन के प्रोजेक्ट सेट अप करें और मालिक और साथ मिलकर काम करने वाले लोगों को चुनें.
- यह तय करें कि आपका ऐड-ऑन कैसा दिखे और कैसे काम करे.
- ऐड-ऑन के प्रोजेक्ट मेनिफ़ेस्ट या डिप्लॉयमेंट रिसॉर्स को कॉन्फ़िगर करें.
- ऐड-ऑन कैसा दिखेगा, यह तय करने के लिए कोड लिखें और व्यवहार.
- अपने ऐड-ऑन के OAuth स्कोप की पुष्टि करें.
- ऐड-ऑन को होस्ट ऐप्लिकेशन तो वह फैला भी देती है.
- ऐड-ऑन पब्लिश करें.
अपने ऐड-ऑन के प्रोजेक्ट सेट अप करना और मालिक और सहयोगियों को चुनना
अगर आपने Apps Script में ऐड-ऑन बनाया है, आपको Apps Script प्रोजेक्ट और Google Cloud प्रोजेक्ट, दोनों बनाने होंगे. अगर आपने अपना ऐड-ऑन, Apps Script के अलावा किसी दूसरी भाषा में बनाया है, तो आपको सिर्फ़ Google Cloud प्रोजेक्ट बनाना होगा.
ऐड-ऑन डेवलपमेंट शुरू करने से पहले, प्रोजेक्ट का मालिकाना हक रखने के लिए, एक उपयोगकर्ता वाला खाता चुनें. साथ ही, यह तय करें कि कौनसे अन्य खाते, साथ मिलकर काम करने वाले उपयोगकर्ता हैं. प्रोजेक्ट का मालिक, प्रोजेक्ट फ़ाइलें और उनसे जुड़ी सेटिंग बनाता और मैनेज करता है. वहीं, सहयोगी कोडिंग और टेस्टिंग में मदद कर सकते हैं.
Apps Script प्रोजेक्ट
अपने ऐड-ऑन के Apps Script प्रोजेक्ट की फ़ाइलों को शेयर की गई ड्राइव में बनाया जा सकता है, ताकि किसी एक खाते के पास मालिकाना हक न हो. अपने ऐड-ऑन की स्क्रिप्ट फ़ाइल को शेयर की गई ड्राइव में सेव करने से, यह पक्का होता है कि स्क्रिप्ट प्रोजेक्ट का ऐक्सेस, कई लोगों के पास हो.
ऐड-ऑन पब्लिश करने पर, एक उपयोगकर्ता खाता पब्लिशर के तौर पर काम करता है. पब्लिश करने वाले खाते के पास स्क्रिप्ट प्रोजेक्ट में बदलाव करने का ऐक्सेस होना चाहिए. हालांकि, यह ज़रूरी नहीं है कि वह खाता, प्रोजेक्ट का मालिक हो.
Apps Script प्रोजेक्ट बनाने के लिए, स्क्रिप्ट प्रोजेक्ट लेख पढ़ें.
Google Cloud प्रोजेक्ट
हमारा सुझाव है कि आप ऐड-ऑन के Cloud प्रोजेक्ट में, साथ मिलकर काम करने वाले लोगों को जोड़ें. इससे यह पक्का करने में मदद मिलती है कि आपकी टीम का कोई व्यक्ति क्लाउड सेटिंग पर जाएं.
Google Cloud प्रोजेक्ट बनाने के लिए, Google Cloud प्रोजेक्ट बनाना लेख पढ़ें.
अपने ऐड-ऑन की डिज़ाइन और उसके काम करने का तरीका तय करना
तय करें कि आपको ऐड-ऑन कैसा और कैसा दिखना चाहिए उसे बनाने से पहले उसे सही तरह से काम करना चाहिए. यह तय करें कि ऐड-ऑन किन इस्तेमाल के उदाहरणों के लिए समाधान उपलब्ध कराएगा. सबसे पहले, काम करने के लिए किसी आसान डिज़ाइन से शुरू करें. इसके बाद, उसमें और सुधार करें.
Google Workspace ऐड-ऑन की स्टाइल गाइड देखें ऐड-ऑन उपयोगकर्ता को डिज़ाइन करने के दिशा-निर्देश देखें अनुभव.
ऐड-ऑन प्रोजेक्ट मेनिफ़ेस्ट कॉन्फ़िगर करें
Apps Script प्रोजेक्ट में, प्रोजेक्ट मेनिफ़ेस्ट एक खास JSON फ़ाइल होती है. यह प्रोजेक्ट के बारे में कई तरह की जानकारी देता है, जैसे कि इसकी लाइब्रेरी निर्भरता. Google Workspace ऐड-ऑन के लिए, मेनिफ़ेस्ट में बुनियादी वह जानकारी जो होस्ट ऐप्लिकेशन को दिखाने की ज़रूरत होती है ऐड-ऑन सही तरीके से सेट अप किया.
अपनी रिपोर्ट कॉन्फ़िगर करने का तरीका जानने के लिए, मेनिफ़ेस्ट देखें का मेनिफ़ेस्ट फ़ाइल खोलें.
ऐड-ऑन में कोड और सुविधाएं जोड़ने के बाद, ज़रूरी ऐड-ऑन बनाने के लिए मेनिफ़ेस्ट और व्यवहार.
ऐड-ऑन को कोड करें
आपको इसके लिए एक कार्ड-आधारित इंटरफ़ेस लागू करना होगा ऐड-ऑन. Apps Script की कार्ड सेवा या अगर आपको किसी दूसरी कोड भाषा में लिखना है, तो वापस करें जेएसओ को सही तरीके से फ़ॉर्मैट किया गया हो, ताकि इंटरफ़ेस को कार्ड के तौर पर रेंडर किया जा सके.
अगर आपको किसी ट्रिगर को फ़ंक्शन में बताया गया है में से एक है. अगर आपका ऐड-ऑन, OAuth का इस्तेमाल करके तीसरे पक्ष की किसी ऐसी सेवा से कनेक्ट होता है जो Google की नहीं है, तो आपको उस सेवा के लिए OAuth को कॉन्फ़िगर करना होगा.
कार्ड बनाना
ऐड-ऑन यूज़र इंटरफ़ेस बनाने के लिए
Card
ऑब्जेक्ट और उन्हें भरना
विजेट. आपके मेनिफ़ेस्ट में बताए गए ट्रिगर फ़ंक्शन, एक Card
ऑब्जेक्ट या Card
ऑब्जेक्ट का कलेक्शन दिखाते हैं. यह कलेक्शन, ऐड-ऑन इंटरफ़ेस के अलग-अलग 'पेजों' को दिखाता है. आपका ऐड-ऑन, उपयोगकर्ता की कार्रवाइयों के जवाब में भी नए कार्ड बना सकता है और उन्हें दिखा सकता है.
Apps Script में, CardBuilder
क्लास का इस्तेमाल करके कार्ड बनाए जाते हैं. हर
कार्ड के लिए CardHeader
की ज़रूरत है
और एक या उससे ज़्यादा
CardSections
. आपको ऐसा करना चाहिए
हर कार्ड सेक्शन को उन अलग-अलग विजेट से भरें जो
ऐड-ऑन इंटरफ़ेस. इंटरैक्शन
विजेट
आम तौर पर, कार्रवाइयों से जुड़ा होता है, ताकि
इंटरैक्शन के बारे में ज़्यादा जानकारी शामिल होती है.
इसके बाद,
CardBuilder
, आपको कॉल करना होगा
CardBuilder.build()
संबंधित Card
ऑब्जेक्ट बनाने के लिए.
Apps Script में पहले से मौजूद सेवाओं का इस्तेमाल करके, अपने बनाए गए ऐड-ऑन कार्ड में जानकारी दिखाएं. जैसे, CalendarApp
.
Google से बाहर की सेवाओं से फ़ेच किए गए डेटा का इस्तेमाल किया जा सकता है.
अगर आपके ऐड-ऑन को Google के अलावा किसी ऐसे एपीआई का ऐक्सेस चाहिए जिसके लिए OAuth की ज़रूरत होती है, तो आपको उस सेवा को कॉन्फ़िगर करके उससे कनेक्ट करना होगा. ज़्यादा जानकारी के लिए, Google से बाहर की सेवाओं से कनेक्ट करने के बारे में गाइड देखें.
कंस्ट्रक्शन ऑर्डर
कार्ड बनाते समय, आपको टॉप अप से बनाना होगा. इसका मतलब है कि आपको इस क्रम का इस्तेमाल करना होगा:
- विजेट बनाएं.
- विजेट को कार्ड सेक्शन में जोड़ें.
- यह प्रक्रिया तब तक दोहराएं, जब तक कार्ड सेक्शन में सभी विजेट न जुड़ जाएं.
- कार्ड में कार्ड सेक्शन जोड़ें.
ऐसा करना ज़रूरी है, क्योंकि किसी कार्ड या कार्ड सेक्शन में विजेट जोड़ने पर, असल में उस विजेट की कॉपी जोड़ी जाती है. विजेट में आपके किए गए कोई भी बदलाव ऑब्जेक्ट जोड़ने के बाद, वह फ़ाइनल कार्ड में नहीं दिखता.
यूनिवर्सल ऐक्शन
यूनिवर्सल ऐक्शन का इस्तेमाल किया जा सकता है का इस्तेमाल, कॉन्टेक्स्ट के हिसाब से अलग-अलग तरह से किया जा सकता है. यूनिवर्सल ऐक्शन, ऐड-ऑन के यूज़र इंटरफ़ेस (यूआई) में मौजूद मेन्यू आइटम होते हैं. भले ही, कोई भी कार्ड दिख रहा हो. सभी तय यूनिवर्सल कार्रवाइयां, हमेशा इसमें दिखती हैं ऐड-ऑन का कार्ड मेन्यू.
ज़्यादा जानकारी के लिए, Universal कार्रवाइयां देखें विवरण.
ऐड-ऑन के OAuth स्कोप की पुष्टि करना
स्कोप से पता चलता है कि उपयोगकर्ता अपनी ओर से ऐड-ऑन का इस्तेमाल कर सकता है. ऐड-ऑन के लिए सबसे सही तरीका यह है कि उनमें सिर्फ़ उन कार्रवाइयों के लिए स्कोप हों जिनके लिए उन्हें काम करना ज़रूरी है.
ऐड-ऑन प्रोजेक्ट में, ऐड-ऑन के स्कोप को साफ़ तौर पर सेट करें, ताकि यह पक्का किया जा सके कि ऐड-ऑन, स्कोप के कम से कम अनुमति वाले सेट का इस्तेमाल करता है. आपके पास यह तय करने का विकल्प होता है कि आपका ऐड-ऑन, ऐड-ऑन मेनिफ़ेस्ट में कौनसे स्कोप इस्तेमाल करता है.
ज़्यादा जानकारी के लिए, दायरे देखें.
ऐड-ऑन का परीक्षण करें
आप पहले इंस्टॉल किए गए ऐड-ऑन की जांच करके, अनपब्लिश किए गए ऐड-ऑन. ऐड-ऑन को इंस्टॉल करने और अनुमति देने के बाद, इसका इस्तेमाल किया जा सकता है और होस्ट ऐप्लिकेशन में इसके दिखने और व्यवहार की जांच करने के लिए किया जा सकता है. विस्तार. आपको पुष्टि करनी होगी कि ऐड-ऑन इस तरह काम करता है का इस्तेमाल, कॉन्टेक्स्ट और उपयोगकर्ता की कार्रवाइयों के लिए किया जा सकता है.
ज़्यादा जानकारी के लिए, Google Workspace ऐड-ऑन की जांच करना लेख पढ़ें.
ऐड-ऑन पब्लिश करें
ऐड-ऑन पब्लिश करने पर, वह दूसरों के लिए उपलब्ध हो जाता है. इसे सार्वजनिक तौर पर या सिर्फ़ आपके डोमेन के उपयोगकर्ताओं के लिए उपलब्ध कराया जा सकता है. पब्लिश करने से पहले प्रोसेस के लिए, पब्लिकेशन की खास जानकारी ज़रूर देखें. पब्लिकेशन एक जटिल प्रक्रिया है. इसके लिए, तैयारी और उसे पूरा करने में लगने वाला समय.
Google Workspace ऐड-ऑन, Google Workspace Marketplace पर पब्लिश किए गए हैं. सार्वजनिक तौर पर उपलब्ध ऐड-ऑन को पहले ऐप्लिकेशन की समीक्षा पूरी करनी होगी वे पब्लिश हो जाते हैं.
इनके लिए, Google Workspace ऐड-ऑन पब्लिश करना लेख पढ़ें देखें.