होम पेज

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

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

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

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

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

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

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

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

Google Workspace ऐड-ऑन, addOns.common.homepageTrigger फ़ील्ड को डिफ़ॉल्ट रूप से, ऐड-ऑन में सभी होस्ट ऐप्लिकेशन मेनिफ़ेस्ट:

    {
      // ...
      "addOns": {
        // ...
        "common": {
          // ...
          "homepageTrigger": {
            "runFunction": "myFunction",
            "enabled": true
          }
        }
      }
    }

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

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

सामान्य कॉन्फ़िगरेशन के अलावा, हर होस्ट ऐप्लिकेशन में एक जैसे स्ट्रक्चर वाले हर होस्ट को बदलने वाले विकल्प, हर होस्ट ऐप्लिकेशन में उपलब्ध होते हैं कॉन्फ़िगरेशन, 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) है ने इवेंट ऑब्जेक्ट पास किया जिसमें शुरू करने के कॉन्टेक्स्ट का डेटा शामिल हो.

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

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

ऐसे कार्ड जो काम के नहीं हैं

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

जो कार्ड काम के नहीं हैं उन्हें किसी भी अन्य कार्ड की तरह बनाया जाता है; बस अंतर यह है कौनसी कार्रवाई या इवेंट जनरेट करता है और कार्ड दिखाता है. यहां जाएं: नेविगेशन के तरीके देखें.