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

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

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

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

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

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

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 प्रोजेक्ट पर लागू होती है. क्लाइंट-साइड JavaScript लाइब्रेरी, जैसे कि jQuery का इस्तेमाल बिना किसी लेटेन्सी के किया जा सकता है.

Google Workspace ऐड-ऑन के सबसे सही तरीके

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

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

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

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

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

Card या अन्य मुश्किल यूज़र इंटरफ़ेस (यूआई) ऑब्जेक्ट बनाने वाला कोड लिखते समय, उस कोड को किसी फ़ंक्शन में रखने पर विचार करें. इस फ़ंक्शन को सिर्फ़ ऑब्जेक्ट बनाना और उसे वापस करना चाहिए. इससे, यूज़र इंटरफ़ेस (यूआई) को रीफ़्रेश करने की ज़रूरत पड़ने पर, उस ऑब्जेक्ट को तुरंत फिर से जनरेट किया जा सकता है. 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 के नोट फ़ील्ड में न डालें.

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

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