होम पेज

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

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

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

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

इनमें से कोई एक शर्त पूरी होने पर, आपका ऐड-ऑन होम पेज दिखता है:

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

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

होम पेज कॉन्फ़िगरेशन

Google Workspace ऐड-ऑन, addOns.common.homepageTrigger फ़ील्ड का इस्तेमाल करके, ऐड-ऑन मेनिफ़ेस्ट में सभी होस्ट ऐप्लिकेशन के लिए डिफ़ॉल्ट होम पेज (बिना संदर्भ के) को कॉन्फ़िगर करता है:

    {
      // ...
      "addOns": {
        // ...
        "common": {
          // ...
          "homepageTrigger": {
            "runFunction": "myFunction",
            "enabled": true
          }
        }
      }
    }
  • runFunction: ऐसे Apps Script फ़ंक्शन का नाम जिसे Google Workspace ऐड-ऑन के फ़्रेमवर्क, होम पेज ऐड-ऑन कार्ड को रेंडर करने के लिए शुरू करते हैं. यह फ़ंक्शन होम पेज ट्रिगर फ़ंक्शन होता है. इस फ़ंक्शन को होम पेज से बनने वाले Card ऑब्जेक्ट की कैटगरी बनानी और देनी चाहिए. अगर एक से ज़्यादा कार्ड दिखाए जाते हैं, तो होस्ट ऐप्लिकेशन उन कार्ड के हेडर को एक सूची में दिखाता है जिनमें से उपयोगकर्ता चुन सकता है (एक से ज़्यादा कार्ड दिखाना देखें).

  • enabled: इस दायरे के लिए होम पेज कार्ड चालू होने चाहिए या नहीं. यह फ़ील्ड ज़रूरी नहीं है. डिफ़ॉल्ट तौर पर, true. इसे false पर सेट करने से होम पेज सभी होस्ट के लिए बंद हो जाता है (बशर्ते उस होस्ट को बदला न गया हो; नीचे देखें).

सामान्य कॉन्फ़िगरेशन के अलावा, हर होस्ट ऐप्लिकेशन में अलग-अलग स्ट्रक्चर्ड होस्ट होस्ट ओवरराइड उपलब्ध होते हैं.addOns.gmail.homepageTrigger, addOns.calendar.homepageTrigger, वगैरह में:

    {
      ...
      "addOns": {
        ...
        "common": {
          // By default, call 'buildHomePage' to render homepage content
          // in all hosts. Since calendar.homepageTrigger below overrides
          // this in Calendar and Drive and the homepageTrigger is disabled
          // for Gmail, this homepage function never executes.
          "homepageTrigger": { "runFunction": "buildHomePage" }
        },
        "calendar": {
          // Show customized homepage content for Calendar only.
          "homepageTrigger": { "runFunction": "buildCalendarHomepage" }
        },
        "drive": {
          // Show customized homepage content for Drive only.
          "homepageTrigger": { "runFunction": "buildDriveHomepage" }
        }
        "gmail": {
          // Disable homepage add-on content in Gmail.
          "homepageTrigger": { "enabled": false }
        },
        ...
      }
    }

ध्यान दें कि यह नीचे दिए गए मेनिफ़ेस्ट के जैसा है:

    {
      ...
      "addOns": {
        ...
        "common": { /* ... */ }, // Omitted a default homepageTrigger specification.
        "calendar": {
          // Show customized homepage content for Calendar only.
          "homepageTrigger": { "runFunction": "myCalendarFunction" }
        },
        "drive": {
          // Show customized homepage content for Drive only.
          "homepageTrigger": { "runFunction": "myDriveFunction" }
        }
        "gmail": { /* ... */ },
        ...
      }
    }

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

होम पेज फ़्लो

होम पेज इवेंट ऑब्जेक्ट

कॉल किए जाने पर, ऊपर बताए गए होम पेज ट्रिगर फ़ंक्शन (runFunction) को इवेंट ऑब्जेक्ट दिया गया है, जिसमें शुरू करने के संदर्भ का डेटा शामिल है.

होम पेज के इवेंट ऑब्जेक्ट में विजेट या काम की जानकारी शामिल नहीं होती है; पास दी गई जानकारी नीचे दिए गए सामान्य इवेंट ऑब्जेक्ट फ़ील्ड तक सीमित होती है:

ज़्यादा जानकारी के लिए, इवेंट ऑब्जेक्ट देखें.

अन्य गैर-संबंधित कार्ड

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

गैर-संदर्भ वाले कार्ड किसी भी दूसरे कार्ड की तरह बनाए जाते हैं; अंतर बस कार्ड को जनरेट करने और दिखाने वाले फ़ंक्शन से होता है. कार्ड के बीच ट्रांज़िशन बनाने के तरीके के बारे में जानने के लिए, नेविगेशन तरीके देखें.