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

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

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

हमारी सलाह है कि आप अपने बनाए हुए सभी ऐड-ऑन के लिए सबसे सही तरीकों का पालन करें.

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

ऐड-ऑन, 'Apps स्क्रिप्ट' प्रोजेक्ट के हिसाब से तय किए जाते हैं, जिनका मालिकाना हक किसी खास खाते के पास या किसी शेयर की गई ड्राइव में होना चाहिए. किसी ऐड-ऑन को कोड करने से पहले, यह तय करें कि प्रोजेक्ट पर किस खाते का मालिकाना हक होना चाहिए और कौनसा खाता उसके पब्लिशर के तौर पर काम करेगा. साथ ही, यह तय करें कि सहयोगियों के तौर पर किन खातों का काम किया जाए. साथ ही, पक्का करें कि उन खातों के पास स्क्रिप्ट प्रोजेक्ट और उससे जुड़े 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 के उपयोगकर्ता.messages.list तरीके का इस्तेमाल करें या Apps Script की Gmail सेवा का इस्तेमाल करें.

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

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

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

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

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

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

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

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