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