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

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

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

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

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

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

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

Google Workspace का इस्तेमाल ज़्यादा से ज़्यादा लोगों के लिए करें, न कि उसे दोहराएं

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

दायरा छोटा रखें

अपने स्कोप साफ़ तौर पर तय करते समय, हमेशा स्कोप का ऐसा सेट चुनें जिसमें कम से कम अनुमतियां हों. उदाहरण के लिए, अगर आपके ऐड-ऑन को सिर्फ़ पढ़ने का ऐक्सेस चाहिए, तो उसे https://www.googleapis.com/auth/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 Users.messages.list तरीके का इस्तेमाल करके मैसेज की सूची बनाएं या Apps Script की Gmail सेवा का इस्तेमाल करें.

Calendar पर कॉन्फ़्रेंस करने के सबसे सही तरीके

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

onCreateFunction लाइट चालू रखें

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

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

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

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

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