इस पेज पर, Google Workspace ऐड-ऑन को डिज़ाइन करने, बनाने, और पब्लिश करने का तरीका बताया गया है. इस खास जानकारी में, इन चरणों के बारे में बताया गया है:
- उन Google Workspace ऐप्लिकेशन को चुनें जिनमें आपको उपयोगकर्ताओं के लिए ऐड-ऑन उपलब्ध कराना है.
- अपने ऐड-ऑन के प्रोजेक्ट सेट अप करें और मालिक और साथ मिलकर काम करने वाले लोगों को चुनें.
- अपने ऐड-ऑन का डिज़ाइन और काम करने का तरीका तय करें.
- ऐड-ऑन के प्रोजेक्ट मेनिफ़ेस्ट या डिप्लॉयमेंट रिसॉर्स को कॉन्फ़िगर करें.
- ऐड-ऑन के दिखने के तरीके और काम करने के तरीके के बारे में बताने के लिए कोड लिखें.
- अपने ऐड-ऑन के OAuth स्कोप की पुष्टि करें.
- Google Workspace के एक या उससे ज़्यादा ऐप्लिकेशन में ऐड-ऑन की जांच करें.
- ऐड-ऑन पब्लिश करें.
Google Workspace के होस्ट ऐप्लिकेशन चुनना
Google Workspace के इन होस्ट ऐप्लिकेशन में दिखने के लिए, Google Workspace ऐड-ऑन को कॉन्फ़िगर किया जा सकता है:
- Gmail
- Google Calendar
- Google Docs
- Google Drive
- Google Sheets
- Google Slides
Google Workspace के ऐप्लिकेशन के लिए, ऐप्लिकेशन बनाने का तरीका जानने के लिए, Google Workspace के यूज़र इंटरफ़ेस (यूआई) को एक्सटेंड करना लेख पढ़ें.
अपने ऐड-ऑन के प्रोजेक्ट सेट अप करना और मालिक और सहयोगियों को चुनना
अगर आपने 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 के अलावा किसी ऐसे एपीआई का ऐक्सेस चाहिए जिसके लिए OAuth की ज़रूरत होती है, तो आपको उस सेवा को कॉन्फ़िगर करके उससे कनेक्ट करना होगा. ज़्यादा जानकारी के लिए, Google के अलावा किसी अन्य सेवा से कनेक्ट करने के बारे में गाइड देखें.
कंस्ट्रक्शन ऑर्डर
कार्ड बनाते समय, आपको टॉप अप से बनाना होगा. इसका मतलब है कि आपको इस कंस्ट्रक्शन ऑर्डर का इस्तेमाल करना होगा:
- विजेट बनाएं.
- विजेट को कार्ड सेक्शन में जोड़ें.
- यह तब तक दोहराएं, जब तक कार्ड सेक्शन में सभी विजेट उपलब्ध न हो जाएं.
- कार्ड में कार्ड सेक्शन जोड़ें.
ऐसा करना ज़रूरी है, क्योंकि जब किसी कार्ड या कार्ड सेक्शन में विजेट जोड़ा जाता है, तो असल में उस विजेट की कॉपी जोड़ी जाती है. विजेट ऑब्जेक्ट को जोड़ने के बाद, उसमें किया गया कोई भी बदलाव फ़ाइनल कार्ड में नहीं दिखता.
यूनिवर्सल ऐक्शन
संदर्भ के हिसाब से काम करने वाली सुविधाएं देने के लिए, यूनिवर्सल ऐक्शन का इस्तेमाल किया जा सकता है. यूनिवर्सल ऐक्शन, ऐड-ऑन के यूज़र इंटरफ़ेस (यूआई) में मौजूद मेन्यू आइटम होते हैं. भले ही, कोई भी कार्ड दिख रहा हो. तय की गई सभी यूनिवर्सल कार्रवाइयां, ऐड-ऑन के कार्ड मेन्यू में हमेशा दिखती हैं.
ज़्यादा जानकारी के लिए, यूनिवर्सल ऐक्शन देखें.
ऐड-ऑन के OAuth स्कोप की पुष्टि करना
स्कोप से यह तय होता है कि ऐड-ऑन को उपयोगकर्ता की ओर से कौनसी कार्रवाइयां करने की अनुमति है. ऐड-ऑन के लिए सबसे सही तरीका यह है कि उनमें सिर्फ़ उन कार्रवाइयों के लिए स्कोप हों जिनके लिए उन्हें काम करना ज़रूरी है.
ऐड-ऑन प्रोजेक्ट में, ऐड-ऑन के स्कोप को साफ़ तौर पर सेट करें, ताकि यह पक्का किया जा सके कि ऐड-ऑन, स्कोप के कम से कम अनुमति वाले सेट का इस्तेमाल करता है. यह आपको तय करना होता है कि आपके ऐड-ऑन के manifest में किन स्कोप का इस्तेमाल किया जाएगा.
ज़्यादा जानकारी के लिए, दायरे देखें.
ऐड-ऑन का परीक्षण करें
पब्लिश नहीं किए गए ऐड-ऑन को पहले, पब्लिश नहीं किए गए ऐड-ऑन को इंस्टॉल करके, टेस्ट किया जा सकता है. इंस्टॉल और अनुमति मिलने के बाद, अपने खाते में ऐड-ऑन का इस्तेमाल किया जा सकता है. साथ ही, उन होस्ट ऐप्लिकेशन में इसके दिखने और काम करने के तरीके की जांच की जा सकती है जिनमें इसे जोड़ा गया है. आपको यह पुष्टि करनी चाहिए कि कॉन्टेक्स्ट और उपयोगकर्ता की कार्रवाइयों के लिए, ऐड-ऑन ठीक से काम कर रहा है या नहीं.
ज़्यादा जानकारी के लिए, Google Workspace ऐड-ऑन की जांच करना लेख पढ़ें.
ऐड-ऑन पब्लिश करना
ऐड-ऑन पब्लिश करने पर, वह दूसरों के लिए उपलब्ध हो जाता है. इसे सार्वजनिक तौर पर या सिर्फ़ आपके डोमेन के उपयोगकर्ताओं के लिए उपलब्ध कराया जा सकता है. पब्लिश करने की प्रोसेस शुरू करने से पहले, पब्लिकेशन की खास जानकारी ज़रूर देखें. पब्लिकेशन एक जटिल प्रक्रिया है. इसे पूरा करने के लिए, तैयारी और समय की ज़रूरत होती है.
Google Workspace ऐड-ऑन, Google Workspace Marketplace पर पब्लिश किए गए हैं. सार्वजनिक तौर पर उपलब्ध ऐड-ऑन को पब्लिश करने से पहले, ऐप्लिकेशन की समीक्षा पूरी करनी होगी.
ज़्यादा जानकारी के लिए, Google Workspace ऐड-ऑन पब्लिश करना लेख पढ़ें.