Google Workspace ऐड-ऑन को डिज़ाइन, बिल्ड, और पब्लिश करने का तरीका जानें:
- तय करें कि आपको Google Workspace के किन ऐप्लिकेशन में, अपने ऐड-ऑन को उपयोगकर्ताओं के लिए उपलब्ध कराना है.
- अपने ऐड-ऑन के प्रोजेक्ट सेट अप करें. साथ ही, मालिक और सहयोगी चुनें.
- अपने ऐड-ऑन के दिखने के तरीके और उसके व्यवहार को डिज़ाइन और कॉन्फ़िगर करें.
- ऐड-ऑन बनाएं.
- अपने ऐड-ऑन के OAuth स्कोप की पुष्टि करें.
- एक या उससे ज़्यादा Google Workspace ऐप्लिकेशन में ऐड-ऑन की टेस्टिंग करें.
- ऐड-ऑन पब्लिश करें.
Apps Script या एचटीटीपी का इस्तेमाल करके ऐड-ऑन बनाएं. इन दोनों की तुलना करने के लिए, "Apps Script बनाम एचटीटीपी एंडपॉइंट: आपको कौनसा चुनना चाहिए?" वीडियो देखें 🤔".
Google Workspace के होस्ट ऐप्लिकेशन चुनना
Google Workspace के ऐड-ऑन को, Google Workspace के इन होस्ट ऐप्लिकेशन में दिखने के लिए कॉन्फ़िगर किया जा सकता है:
- Gmail
- Google Calendar
- Google Chat
- Google Docs
- Google Drive
- Google Meet
- Google Sheets
- Google Slides
Google Workspace ऐप्लिकेशन के लिए ऐड-ऑन बनाने के बारे में जानने के लिए, Google Workspace के यूज़र इंटरफ़ेस (यूआई) को एक्सटेंड करना लेख पढ़ें.
अपने ऐड-ऑन के प्रोजेक्ट सेट अप करना और मालिक और सहयोगी चुनना
Apps Script में ऐड-ऑन बनाने पर, Apps Script प्रोजेक्ट और Google Cloud प्रोजेक्ट, दोनों बनाए जाते हैं. अगर आपने Apps Script के अलावा किसी दूसरी भाषा में ऐड-ऑन बनाया है, तो आपको सिर्फ़ Google Cloud प्रोजेक्ट बनाना होगा.
ऐड-ऑन बनाने के लिए, आपको स्क्रिप्ट प्रोजेक्ट और क्लाउड प्रोजेक्ट, दोनों को कॉन्फ़िगर करना होगा.
ऐड-ऑन डेवलप करने से पहले, किसी एक उपयोगकर्ता खाते को प्रोजेक्ट का मालिक बनाएं. साथ ही, यह तय करें कि किन अन्य खातों को सहयोगी के तौर पर जोड़ा जाएगा. प्रोजेक्ट का मालिक, प्रोजेक्ट फ़ाइलें और उनसे जुड़ी सेटिंग बनाता है और उन्हें मैनेज करता है. वहीं, इस प्रोजेक्ट पर आपके साथ काम करने वाले लोग, कोडिंग और टेस्टिंग में आपकी मदद कर सकते हैं.
Apps Script प्रोजेक्ट
ऐड-ऑन बनाने से पहले, Apps Script के कोटे और सीमाएं देखें. इससे आपको अपने प्रोजेक्ट के डिज़ाइन को इन दिशा-निर्देशों के मुताबिक बनाने में मदद मिलेगी. Apps Script का इस्तेमाल इन कामों के लिए सबसे अच्छा है: निजी या इंटरनल ऐड-ऑन को आसानी से डेवलप करने के लिए कम उपयोगकर्ताओं के ग्रुप के लिए. अगर आपके ऐड-ऑन को कई उपयोगकर्ताओं के लिए सहायता, कम समय में जवाब देने या अपने इन्फ़्रास्ट्रक्चर पर पूरा कंट्रोल रखने की ज़रूरत है, तो कोई दूसरा रनटाइम इस्तेमाल करें.
अपने ऐड-ऑन के Apps Script प्रोजेक्ट की फ़ाइलों को शेयर की गई ड्राइव में बनाएं, ताकि किसी एक खाते के पास उनका मालिकाना हक न रहे. ऐड-ऑन की स्क्रिप्ट फ़ाइल को शेयर की गई ड्राइव में रखने से, यह पक्का किया जा सकता है कि मिलकर काम करने वाले सभी लोगों के पास स्क्रिप्ट प्रोजेक्ट का ऐक्सेस हो.
किसी ऐड-ऑन को पब्लिश करने पर, एक ही उपयोगकर्ता खाता पब्लिशर होता है. पब्लिश करने वाले खाते के पास स्क्रिप्ट प्रोजेक्ट में बदलाव करने का ऐक्सेस होना चाहिए. हालांकि, यह ज़रूरी नहीं है कि उसके पास मालिकाना हक हो.
Apps Script प्रोजेक्ट बनाने के लिए, स्क्रिप्ट प्रोजेक्ट लेख पढ़ें.
Google Cloud प्रोजेक्ट
ऐड-ऑन के क्लाउड प्रोजेक्ट में सहयोगियों को जोड़ें. इससे यह पक्का होता है कि आपकी टीम, ऐड-ऑन की क्लाउड सेटिंग को हमेशा ऐक्सेस कर सकती है.
Google Cloud प्रोजेक्ट बनाने के लिए, Google Cloud प्रोजेक्ट बनाना लेख पढ़ें.
अपने ऐड-ऑन के दिखने के तरीके और उसके काम करने के तरीके को डिज़ाइन और कॉन्फ़िगर करना
ऐड-ऑन बनाने से पहले, यह तय करें कि वह कैसा दिखेगा और कैसे काम करेगा. देखें कि ऐड-ऑन, इस्तेमाल के किन उदाहरणों को हल करता है. सबसे पहले, बुनियादी डिज़ाइन से शुरुआत करें और फिर उसमें बदलाव करें.
ऐड-ऑन के उपयोगकर्ता अनुभव को डिज़ाइन करने के बारे में दिशा-निर्देश पाने के लिए, Google Workspace ऐड-ऑन की स्टाइल गाइड देखें.
ऐड-ऑन मेनिफ़ेस्ट कॉन्फ़िगर करना
ऐड-ऑन मेनिफ़ेस्ट में डिज़ाइन लागू करें. मेनिफ़ेस्ट फ़ाइल में, ऐड-ऑन के दिखने के तरीके और उसके काम करने के तरीके को कॉन्फ़िगर करें. इसमें Google Workspace के उन होस्ट किए गए ऐप्लिकेशन के बारे में भी जानकारी शामिल करें जिनके साथ ऐड-ऑन काम करता है.
ज़्यादा जानकारी के लिए, Google Workspace ऐड-ऑन के लिए मेनिफ़ेस्ट लेख पढ़ें.
कोड और सुविधाएं जोड़ते समय, मेनिफ़ेस्ट को अपनी ज़रूरत के हिसाब से अपडेट करें. इससे, ऐड-ऑन के दिखने और काम करने के तरीके को तय किया जा सकेगा.
Google Chat ऐप्लिकेशन के लुक और व्यवहार को कॉन्फ़िगर करना
अगर आपको Google Chat के लिए कोई ऐड-ऑन डिज़ाइन करना है, तो Chat ऐप्लिकेशन के दिखने के तरीके और उसके काम करने के तरीके को कॉन्फ़िगर करने के लिए, Google Chat API का इस्तेमाल करें. तरीका जानने के लिए, Google Chat API का इस्तेमाल करना लेख पढ़ें.
ऐड-ऑन बनाना
ऐड-ऑन के लिए कार्ड पर आधारित इंटरफ़ेस लागू करें. कार्ड सेवा का इस्तेमाल करें. अगर आपको किसी दूसरी कोड भाषा का इस्तेमाल करना है, तो इंटरफ़ेस को कार्ड के तौर पर रेंडर करने के लिए, फ़ॉर्मैट किए गए JSON को वापस लाएं.
ऐड-ऑन मेनिफ़ेस्ट में बताए गए किसी भी ट्रिगर फ़ंक्शन को लागू करें. अगर आपका ऐड-ऑन, OAuth का इस्तेमाल करके किसी तीसरे पक्ष की सेवा से कनेक्ट होता है, तो उस सेवा के लिए OAuth कॉन्फ़िगर करें.
कार्ड बनाना
Card ऑब्जेक्ट बनाकर और विजेट जोड़कर, ऐड-ऑन का यूज़र इंटरफ़ेस तय करें. आपके मेनिफ़ेस्ट में बताए गए ट्रिगर फ़ंक्शन को, एक Card ऑब्जेक्ट या Card ऑब्जेक्ट का एक ऐसा कलेक्शन दिखाना होगा जो ऐड-ऑन इंटरफ़ेस के अलग-अलग 'पेज' दिखाता हो. ऐड-ऑन, उपयोगकर्ता की कार्रवाइयों के जवाब में नए कार्ड भी बना सकता है और उन्हें दिखा सकता है.
Apps Script में, CardBuilder क्लास का इस्तेमाल करके कार्ड बनाएं. हर कार्ड के लिए, एक CardHeader और एक या उससे ज़्यादा CardSections की ज़रूरत होती है. हर कार्ड सेक्शन में उन विजेट को पॉप्युलेट करें जो इंटरफ़ेस बनाते हैं.
इंटरैक्शन
विजेट आम तौर पर कार्रवाइयों से लिंक होते हैं, ताकि उनके इंटरैक्शन के तरीके को तय किया जा सके.
कार्ड में सभी सेक्शन और विजेट जोड़ने के बाद, CardBuilder के ज़रिए CardBuilder.build को कॉल करें, ताकि उससे जुड़ा Card ऑब्जेक्ट बनाया जा सके.
ऐड-ऑन कार्ड में जानकारी दिखाने के लिए, Apps Script की पहले से मौजूद सेवाओं](/apps-script/guides/services/) का इस्तेमाल करें. जैसे, CalendarApp. Google से बाहर की सेवाओं से मिले डेटा का इस्तेमाल करना.
अगर आपके ऐड-ऑन को Google APIs के अलावा अन्य कंपनियों के ऐसे एपीआई का ऐक्सेस चाहिए जिनके लिए OAuth ज़रूरी है, तो उस सेवा को कॉन्फ़िगर करें और उससे कनेक्ट करें. इसके लिए, Google के अलावा अन्य कंपनियों की सेवाओं से कनेक्ट करने के बारे में जानकारी देने वाला लेख पढ़ें.
कंस्ट्रक्शन ऑर्डर
कार्ड बनाते समय, सबसे ऊपर से शुरू करें. इस क्रम में बनाएं:
- विजेट बनाना.
- विजेट को कार्ड सेक्शन में जोड़ें.
- इसे तब तक दोहराएं, जब तक कार्ड सेक्शन में सभी विजेट न आ जाएं.
- कार्ड में कार्ड सेक्शन जोड़ें.
ऐसा इसलिए होता है, क्योंकि किसी कार्ड या कार्ड सेक्शन में कोई विजेट जोड़ने का मतलब है कि आपने उस विजेट की कॉपी जोड़ी है. विजेट ऑब्जेक्ट को जोड़ने के बाद, उसमें किए गए किसी भी बदलाव का असर फ़ाइनल कार्ड पर नहीं पड़ता.
यूनिवर्सल ऐक्शन
कॉन्टेक्स्ट से जुड़ी जानकारी के बिना काम करने वाली सुविधा देने के लिए, यूनिवर्सल ऐक्शन का इस्तेमाल करें. यूनिवर्सल ऐक्शन, मेन्यू आइटम होते हैं. ये कार्ड के बावजूद, ऐड-ऑन के यूज़र इंटरफ़ेस (यूआई) में उपलब्ध होते हैं. तय की गई सभी यूनिवर्सल कार्रवाइयां, ऐड-ऑन के कार्ड मेन्यू में दिखती हैं.
ज़्यादा जानकारी के लिए, यूनिवर्सल ऐक्शन देखें.
ऐड-ऑन के OAuth स्कोप की पुष्टि करना
स्कोप से यह तय होता है कि ऐड-ऑन, उपयोगकर्ता की ओर से कौनसी कार्रवाइयां कर सकता है. ऐड-ऑन के पास सिर्फ़ वे स्कोप होने चाहिए जिनकी उन्हें काम करने के लिए ज़रूरत है.
ऐड-ऑन प्रोजेक्ट में, ऐड-ऑन के स्कोप सेट करें, ताकि यह पक्का किया जा सके कि ऐड-ऑन, स्कोप के सबसे कम अनुमति वाले सेट का इस्तेमाल करता है. ऐड-ऑन के मेनिफ़ेस्ट में स्कोप तय करें.
ज़्यादा जानकारी के लिए, स्कोप देखें.
ऐड-ऑन को आज़माना
पब्लिश नहीं किए गए ऐड-ऑन की जांच करने के लिए, पहले पब्लिश नहीं किए गए ऐड-ऑन को इंस्टॉल करें. इंस्टॉल और अनुमति देने के बाद, अपने खाते में ऐड-ऑन का इस्तेमाल करें. इससे, यह जांच की जा सकती है कि ऐड-ऑन, होस्ट किए गए ऐप्लिकेशन में कैसा दिखता है और कैसा काम करता है. पुष्टि करें कि ऐड-ऑन, कॉन्टेक्स्ट और उपयोगकर्ता की कार्रवाइयों के लिए उम्मीद के मुताबिक काम करता है.
ऐड-ऑन की टेस्टिंग शुरू करने के लिए, ये गाइड देखें:
- Apps Script की मदद से बनाए गए Google Workspace ऐड-ऑन को टेस्ट करना और उनमें मौजूद गड़बड़ियों को ठीक करना
- Google Workspace के एचटीटीपी ऐड-ऑन की जांच करना और उन्हें डीबग करना
- Google Chat ऐप्लिकेशन के लिए इंटरैक्टिव सुविधाओं को टेस्ट करना
ऐड-ऑन पब्लिश करना
पब्लिश करने पर, आपका ऐड-ऑन अन्य लोगों के लिए उपलब्ध हो जाता है. पब्लिश करने से पहले, पब्लिश करने की खास जानकारी देखें. पब्लिश करना एक मुश्किल प्रोसेस है. इसके लिए, तैयारी करनी पड़ती है.
Google Workspace ऐड-ऑन, Google Workspace Marketplace पर पब्लिश किए जाते हैं. सार्वजनिक तौर पर उपलब्ध ऐड-ऑन को पब्लिश करने से पहले, ऐप्लिकेशन की समीक्षा करानी होती है.
ज़्यादा जानकारी के लिए, Google Workspace ऐड-ऑन पब्लिश करना लेख पढ़ें.