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