सबसे सही तरीके

ऐड-ऑन डिज़ाइन से जुड़ी इन गाइड का पालन करके, अपने उपयोगकर्ताओं के अनुभव को बेहतर बनाएं.

सबसे सही तरीके

हमारा सुझाव है कि अपने डेवलप किए गए सभी ऐड-ऑन के लिए, नीचे दिए गए सबसे सही तरीके अपनाएं.

शुरू करने से पहले, ऐड-ऑन का मालिकाना हक तय करें

ऐड-ऑन, Apps Script प्रोजेक्ट से तय किए जाते हैं. ये प्रोजेक्ट किसी खास खाते के होने चाहिए या शेयर की गई ड्राइव में सेव किए गए होने चाहिए. किसी ऐड-ऑन को कोडिंग करने से पहले, यह तय करें कि प्रोजेक्ट के लिए कौनसा खाता होना चाहिए और कौनसा खाता पब्लिशर के तौर पर काम करता है. साथ ही, यह भी तय करें कि किन खातों को सहयोगियों के तौर पर काम करना है. साथ ही, पक्का करें कि उन खातों के पास स्क्रिप्ट प्रोजेक्ट और उससे जुड़े Cloud Platform प्रोजेक्ट का ऐक्सेस हो.

ध्यान दें: ऐड-ऑन के मालिकाना हक के लिए प्लान बनाना ज़रूरी है. अगर ऐड-ऑन का मालिक आपका संगठन छोड़ देता है, तो आपको यह पक्का करना होगा कि मालिकाना हक ट्रांसफ़र कर दिया गया है. ऐसा न करने पर, आपके पास ऐड-ऑन को अपडेट करने और मैनेज करने की सुविधा नहीं रहेगी. इस वजह से, खास तौर पर अपने संगठन के ऐड-ऑन का मालिकाना हक पाने और उन्हें पब्लिश करने के लिए, एक संगठन खाता बनाना सबसे सही तरीका हो सकता है. स्क्रिप्ट प्रोजेक्ट के मालिक के तौर पर भी काम करने के लिए शेयर की गई ड्राइव का इस्तेमाल किया जा सकता है, लेकिन ऐड-ऑन पब्लिशर के तौर पर किसी खास खाते को काम करना होगा.

Google Workspace का विस्तार करें, उसे नकल न करें

ऐड-ऑन, Google Workspace के उन ऐप्लिकेशन को नई सुविधाएं उपलब्ध कराते हैं जिनका इन्हें इस्तेमाल किया जाता है या जिनके ज़रिए मुश्किल टास्क अपने-आप हो जाते हैं. ऐसे ऐड-ऑन जो ऐप्लिकेशन में पहले से मौजूद फ़ंक्शन की नकल करते हैं या जो किसी वर्कफ़्लो में ज़रूरी सुधार नहीं करते हैं उनकी पब्लिकेशन के लिए ऐड-ऑन समीक्षा में पास होने की संभावना नहीं होती.

दायरे को सीमित रखना

खास तौर पर अपने दायरों के बारे में बताते समय, हमेशा स्कोप के कम से कम अनुमति वाले सेट को चुनें. उदाहरण के लिए, अगर आपके ऐड-ऑन को सिर्फ़ पढ़ने का ऐक्सेस चाहिए, तो उसे https://www.googleapis.com/auth/calendar स्कोप के साथ उपयोगकर्ता के Calendar का पूरा ऐक्सेस न दें. रीड ओनली ऐक्सेस के लिए, https://www.googleapis.com/auth/calendar.readonly दायरे का इस्तेमाल करें.

लाइब्रेरी पर बहुत ज़्यादा भरोसा करने से बचना

Apps Script लाइब्रेरी का इस्तेमाल करने से, आपका ऐड-ऑन एक ही स्क्रिप्ट प्रोजेक्ट में सभी Apps Script प्रोजेक्ट में शामिल होने पर, ज़्यादा धीरे चलता है. हालांकि Apps Script लाइब्रेरी ऐड-ऑन में काम करती हैं, लेकिन अगर आप इनका इस्तेमाल करते हैं, तो परफ़ॉर्मेंस में कमी आ सकती है. अपने प्रोजेक्ट में ग़ैर-ज़रूरी लाइब्रेरी शामिल करने से बचें और ऐसे तरीके ढूंढें जिनसे ऐड-ऑन उन पर निर्भर रहें.

ऊपर बताई गई देरी सिर्फ़ उन Apps Script प्रोजेक्ट पर लागू होती है जिनका इस्तेमाल सर्वर साइड लाइब्रेरी के तौर पर किया जा रहा है. आप इस इंतज़ार के समय का सामना किए बिना, आसानी से jQuery जैसी क्लाइंट-साइड JavaScript लाइब्रेरी का इस्तेमाल कर सकते हैं.

Google Workspace ऐड-ऑन इस्तेमाल करने के सबसे सही तरीके

यहां दिए गए सबसे सही तरीके, सिर्फ़ Google Workspace ऐड-ऑन और कार्ड सेवा के इस्तेमाल पर लागू होते हैं.

सिर्फ़ कुछ कार्ड का इस्तेमाल करना

अगर ऐड-ऑन बहुत ज़्यादा कार्ड का इस्तेमाल करता है, तो नेविगेशन कॉन्फ़िगरेशन जटिल और मैनेज करना मुश्किल हो जाता है.

ज़रूरत से ज़्यादा कार्ड बनाने की कोशिश करने से बचें.

विजेट बनाने वाले फ़ंक्शन का इस्तेमाल करना

Card या दूसरे जटिल यूज़र इंटरफ़ेस (यूआई) ऑब्जेक्ट बनाने वाला कोड लिखते समय, उस कोड को उसके फ़ंक्शन में ही रखें. इस क्रिएशन फ़ंक्शन को सिर्फ़ ऑब्जेक्ट बनाना और उसे रिटर्न करना चाहिए. इससे जब भी यूज़र इंटरफ़ेस (यूआई) को रीफ़्रेश किया जाना ज़रूरी हो, तब उस ऑब्जेक्ट को तुरंत फिर से जनरेट किया जा सकता है. कार्ड सेवा में बिल्डर क्लास का इस्तेमाल करने के बाद, build() को कॉल करना न भूलें.

कार्ड को आसान रखें

अगर किसी कार्ड में बहुत ज़्यादा विजेट हैं, तो हो सकता है कि वह बहुत ज़्यादा स्क्रीन भर जाए और कम काम का हो. बड़े कार्ड सेक्शन, छोटे किए जा सकने वाले यूज़र इंटरफ़ेस (यूआई) एलिमेंट के रूप में रेंडर होते हैं. हालांकि, इससे उपयोगकर्ता को जानकारी नहीं दिखती. इसका मकसद अपने ऐड-ऑन को बेहतर बनाना है, ताकि उपयोगकर्ताओं को उनकी ज़रूरत के मुताबिक जानकारी उपलब्ध कराई जा सके.

गड़बड़ी वाले कार्ड का इस्तेमाल करना

गड़बड़ी की स्थितियों के लिए कार्ड बनाएं. अगर आपका ऐड-ऑन कोई गड़बड़ी दिखाता है, तो उसमें गड़बड़ी की जानकारी वाला कार्ड होना चाहिए. साथ ही, उसे ठीक करने के निर्देश दिए जाने चाहिए. उदाहरण के लिए, अगर अनुमति न मिलने की वजह से आपका ऐड-ऑन Google की किसी सेवा से कनेक्ट नहीं हो पाया, तो इस बारे में जानकारी देने वाला एक कार्ड दिखाएं. साथ ही, उपयोगकर्ता से कहें कि वह इस्तेमाल किए जा रहे खाते की जानकारी की पुष्टि करे.

जांच और जांच के लिए मैसेज लिखना

आपको अपने बनाए गए सभी ऐड-ऑन की अच्छी तरह से जांच करनी चाहिए. टेस्ट फ़ंक्शन बनाएं, जो टेस्ट डेटा का इस्तेमाल करके कार्ड और विजेट बनाते हैं. इसके बाद, पुष्टि करें कि ऑब्जेक्ट सही तरीके से बनाए गए हैं.

ऐक्शन कॉलबैक फ़ंक्शन का इस्तेमाल करते समय, आम तौर पर आपको एक रिस्पॉन्स ऑब्जेक्ट बनाना होता है. जवाबों को सही तरीके से बनाया जा रहा है, इसकी पुष्टि करने के लिए यहां दिए गए स्टेटमेंट का इस्तेमाल करें:

    Logger.log(response.printJson());

चलाएं मेन्यू का इस्तेमाल करके, सीधे Apps Script एडिटर से बनाए गए टेस्ट फ़ंक्शन चलाएं. जब आपके पास कोई काम करने वाला ऐड-ऑन काम कर रहा हो, तो अनपब्लिश किए गए वर्शन को इंस्टॉल ज़रूर करें, ताकि आप उसकी जांच कर सकें.

ऐड-ऑन के ज़रिए मिले हर होस्ट ऐप्लिकेशन के लिए, टेस्ट डेटा का इस्तेमाल करें. उदाहरण के लिए, अगर ऐड-ऑन Gmail को बढ़ाता है, तो शायद आपको कुछ टेस्ट ईमेल और उनके मैसेज आईडी की ज़रूरत होगी. इससे यह पक्का किया जा सकता है कि अलग-अलग मैसेज कॉन्टेंट देने पर ऐड-ऑन उम्मीद के मुताबिक काम करता है. Gmail API User.messages.list तरीके का इस्तेमाल करके मैसेज की सूची बनाकर या Apps Script की Gmail सेवा का इस्तेमाल करके, किसी मैसेज का मैसेज आईडी पाया जा सकता है.

कैलेंडर कॉन्फ़्रेंसिंग के सबसे सही तरीके

अगर आपका ऐड-ऑन, Google Calendar में तीसरे पक्ष के कैलेंडर कॉन्फ़्रेंसिंग विकल्पों को इंटिग्रेट करता है, तो इन सबसे सही तरीकों को अपनाएं:

अपने onCreateFunction की लाइट बनाए रखें

मेनिफ़ेस्ट में बताए गए हर onCreateFunction को सिंक्रोनस रूप से तब कहा जाता है, जब कोई उपयोगकर्ता उस तरह का कॉन्फ़्रेंस समाधान बनाने की कोशिश करता है. पक्का करें कि ये फ़ंक्शन कॉन्फ़्रेंस बनाने के लिए सिर्फ़ ज़रूरी काम करते हों. इन फ़ंक्शन में बहुत ज़्यादा काम करने से, आपके ऐड-ऑन के साथ उपयोगकर्ता का अनुभव धीमा हो सकता है.

कॉन्फ़्रेंस डेटा के लिए सही ConferenceData फ़ील्ड का इस्तेमाल करें

ConferenceData ऑब्जेक्ट बनाने पर, उन्हें कॉन्फ़्रेंस की जानकारी (ऐक्सेस कोड, फ़ोन नंबर, पिन, यूआरआई वगैरह) अपने-आप भर दिया जा सकता है. इस जानकारी के लिए, इससे जुड़े EntryPoint फ़ील्ड का इस्तेमाल करना न भूलें. इस जानकारी को ConferenceData नोट फ़ील्ड में न डालें.

Google Calendar इवेंट में कॉन्फ़्रेंसिंग की जानकारी न जोड़ें

आपके ऐड-ऑन को Google Calendar इवेंट की जानकारी में, तीसरे पक्ष की बनाई गई कॉन्फ़्रेंस की जानकारी जोड़ने की ज़रूरत नहीं होती. ज़रूरत पड़ने पर Google Calendar अपने-आप यह काम कर लेता है.