Google Workspace ऐड-ऑन बनाना

इस पेज पर, Google Workspace ऐड-ऑन को डिज़ाइन करने, बनाने, और पब्लिश करने के बारे में खास जानकारी दी गई है. इस खास जानकारी में, इन चरणों के बारे में बताया गया है:

  1. तय करें कि आपको Google Workspace के किन ऐप्लिकेशन में, उपयोगकर्ताओं के लिए अपना ऐड-ऑन उपलब्ध कराना है.
  2. अपने ऐड-ऑन के प्रोजेक्ट सेट अप करें. साथ ही, मालिक और सहयोगी चुनें.
  3. अपने ऐड-ऑन के दिखने के तरीके और उसके काम करने के तरीके को डिज़ाइन और कॉन्फ़िगर करें.
  4. ऐड-ऑन बनाएं.
  5. अपने ऐड-ऑन के OAuth स्कोप की पुष्टि करें.
  6. एक या उससे ज़्यादा Google Workspace ऐप्लिकेशन में ऐड-ऑन को टेस्ट करें.
  7. ऐड-ऑन पब्लिश करें.

Apps Script या एचटीटीपी की मदद से, ऐड-ऑन बनाया जा सकता है. तुलना करने के लिए, "Apps Script vs. HTTP endpoints: Which should you choose? 🤔".

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 प्रोजेक्ट

हमारा सुझाव है कि आप ऐड-ऑन के Cloud प्रोजेक्ट में सहयोगी जोड़ें. इससे यह पक्का करने में मदद मिलती है कि आपकी टीम का कोई सदस्य, ऐड-ऑन की क्लाउड सेटिंग को हमेशा ऐक्सेस कर सके.

Google Cloud प्रोजेक्ट बनाने के लिए, Google Cloud प्रोजेक्ट बनाना लेख पढ़ें.

अपने ऐड-ऑन के दिखने के तरीके और उसके काम करने के तरीके को डिज़ाइन और कॉन्फ़िगर करना

ऐड-ऑन बनाने से पहले, तय करें कि आपको उसे कैसा दिखाना है और वह कैसे काम करेगा. यह तय करें कि ऐड-ऑन को किन इस्तेमाल के उदाहरणों के लिए समाधान देने चाहिए. सबसे पहले, काम शुरू करने के लिए एक सामान्य डिज़ाइन बनाएं. इसके बाद, उसमें और सुधार करें.

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

ऐड-ऑन मेनिफ़ेस्ट कॉन्फ़िगर करना

ऐड-ऑन डिज़ाइन करने के बाद, ऐड-ऑन मेनिफ़ेस्ट में डिज़ाइन लागू किया जा सकता है. मेनिफ़ेस्ट में, ऐड-ऑन के दिखने और उसके काम करने के तरीके को कॉन्फ़िगर किया जाता है. इसमें Google Workspace के उन होस्ट ऐप्लिकेशन के बारे में भी बताया जाता है जिनके साथ ऐड-ऑन काम करता है.

ज़्यादा जानकारी के लिए, Google Workspace ऐड-ऑन के लिए मेनिफ़ेस्ट लेख पढ़ें.

अपने ऐड-ऑन में कोड और सुविधाएं जोड़ते समय, ज़रूरत के हिसाब से मेनिफ़ेस्ट में बदलाव करें. इससे ऐड-ऑन को सही तरीके से दिखाया जा सकेगा और वह सही तरीके से काम कर पाएगा.

Google Chat ऐप्लिकेशन के लुक और व्यवहार को कॉन्फ़िगर करना

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

ऐड-ऑन बनाना

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

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

कार्ड बनाना

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

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

कार्ड में सभी सेक्शन और विजेट जोड़ने के बाद, आपको CardBuilder के ज़रिए CardBuilder.build() को कॉल करना होगा, ताकि इससे जुड़ा Card ऑब्जेक्ट बनाया जा सके.

आपके पास Apps Script की अन्य सेवाओं का इस्तेमाल करने का विकल्प होता है. जैसे, CalendarApp. इससे, आपको ऐड-ऑन कार्ड में दिखाने के लिए जानकारी मिलती है. Google से बाहर की सेवाओं से फ़ेच किए गए डेटा का इस्तेमाल किया जा सकता है.

अगर आपके ऐड-ऑन को Google के अलावा अन्य कंपनियों के ऐसे एपीआई का ऐक्सेस चाहिए जिनके लिए OAuth ज़रूरी है, तो आपको उस सेवा को कॉन्फ़िगर करना होगा और उससे कनेक्ट करना होगा. ज़्यादा जानकारी के लिए, Google के अलावा अन्य कंपनियों की सेवाओं से कनेक्ट करने से जुड़ी गाइड देखें.

कंस्ट्रक्शन ऑर्डर

कार्ड बनाते समय, आपको सबसे ऊपर से शुरू करना होगा. इसका मतलब है कि आपको इस क्रम में स्ट्रक्चर बनाना होगा:

  1. विजेट बनाएं.
  2. विजेट को कार्ड सेक्शन में जोड़ें.
  3. कार्ड सेक्शन में सभी विजेट दिखने तक इस प्रोसेस को दोहराएं.
  4. कार्ड में कार्ड सेक्शन जोड़ें.

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

यूनिवर्सल ऐक्शन

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

ज़्यादा जानकारी के लिए, यूनिवर्सल ऐक्शन देखें.

ऐड-ऑन के OAuth स्कोप की पुष्टि करना

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

ऐड-ऑन प्रोजेक्ट में, ऐड-ऑन के स्कोप साफ़ तौर पर सेट करें, ताकि यह पक्का किया जा सके कि ऐड-ऑन, स्कोप के सबसे कम अनुमति वाले सेट का इस्तेमाल करे. ऐड-ऑन के मेनिफ़ेस्ट में, यह तय किया जाता है कि आपका ऐड-ऑन किन स्कोप का इस्तेमाल करता है.

ज़्यादा जानकारी के लिए, स्कोप देखें.

ऐड-ऑन की जांच करना

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

अपने ऐड-ऑन की जांच शुरू करने के लिए, यहां दी गई गाइड देखें:

ऐड-ऑन पब्लिश करना

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

Google Workspace ऐड-ऑन, Google Workspace Marketplace पर पब्लिश किए जाते हैं. सार्वजनिक तौर पर उपलब्ध ऐड-ऑन को पब्लिश करने से पहले, ऐप्लिकेशन की समीक्षा पूरी करनी होगी.

ज़्यादा जानकारी के लिए, Google Workspace ऐड-ऑन पब्लिश करना लेख पढ़ें.