यूनिवर्सल कार्रवाइयां

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

यूनिवर्सल ऐक्शन का इस्तेमाल करके, आपको यह पक्का करने में मदद मिलती है कि उपयोगकर्ता को कुछ सुविधाओं का हमेशा ऐक्सेस मिले. भले ही, वह ऐड-ऑन के किसी भी हिस्से से इंटरैक्ट करता हो. यहां यूनिवर्सल कार्रवाइयों के इस्तेमाल के कुछ उदाहरण दिए गए हैं:

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

अगर आपकी कोई ऐसी कार्रवाई है जो मौजूदा कॉन्टेक्स्ट पर निर्भर न करती हो, तो आपको उसे एक यूनिवर्सल कार्रवाई बनाने के बारे में सोचना चाहिए.

यूनिवर्सल कार्रवाइयों का इस्तेमाल करना

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

यूनिवर्सल कार्रवाइयों को कॉन्फ़िगर करना

आपने अपने ऐड-ऑन के मेनिफ़ेस्ट में यूनिवर्सल कार्रवाइयों को कॉन्फ़िगर किया है; ज़्यादा जानकारी के लिए मेनिफ़ेस्ट देखें.

हर कार्रवाई के लिए, आपको मेन्यू में उस कार्रवाई के लिए टेक्स्ट दिखाना होता है. इसके बाद, openLink फ़ील्ड तय करके यह बताया जा सकता है कि इस कार्रवाई से, वेब पेज को सीधे नए टैब में खोला जा सकता है. इसके अलावा, आपके पास runFunction फ़ील्ड तय करने का विकल्प होता है, जो यूनिवर्सल ऐक्शन के चुने जाने पर एक्ज़ीक्यूट करने के लिए, Apps Script कॉलबैक फ़ंक्शन के बारे में बताता हो.

जब runFunction का इस्तेमाल किया जाता है, तो बताया गया कॉलबैक फ़ंक्शन आम तौर पर इनमें से कोई एक काम करता है:

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

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

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

उदाहरण

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

  "oauthScopes": [
    "https://www.googleapis.com/auth/gmail.addons.current.message.metadata"
  ],
  "addOns": {
    "common": {
      "name": "Universal Actions Only Addon",
      "logoUrl": "https://www.example.com/hosted/images/2x/my-icon.png",
      "openLinkUrlPrefixes": [
        "https://www.google.com",
        "https://www.example.com/urlbase"
      ],
      "universalActions": [{
          "label": "Open google.com",
          "openLink": "https://www.google.com"
        }, {
          "label": "Open contact URL",
          "runFunction": "openContactURL"
        }, {
          "label": "Open settings",
          "runFunction": "createSettingsResponse"
        }, {
          "label": "Run background sync",
          "runFunction": "runBackgroundSync"
      }],
      ...
    },
    "gmail": {
      "contextualTriggers": [
        {
          "unconditional": {},
          "onTriggerFunction": "getContextualAddOn"
        }
      ]
    },
    ...
  },
  ...

पिछले उदाहरण में बताई गई तीन सार्वभौमिक कार्रवाइयां नीचे दी गई हैं:

• google.com खोलने पर, एक नए टैब में https://www.google.com खुलता है.
• ओपन संपर्क यूआरएल एक फ़ंक्शन चलाता है, जिससे यह तय होता है कि कौनसा यूआरएल खोलना है. इसके बाद, यह OpenLink ऑब्जेक्ट का इस्तेमाल करके, इसे नए टैब में खोलता है. कोड, भेजने वाले के ईमेल पते का इस्तेमाल करके यूआरएल बनाता है.
• सेटिंग खोलें फ़ंक्शन, ऐड-ऑन स्क्रिप्ट प्रोजेक्ट में बताए गए createSettingsCards() फ़ंक्शन को चलाता है. यह फ़ंक्शन एक मान्य UniversalActionResponse ऑब्जेक्ट दिखाता है, जिसमें ऐड-ऑन सेटिंग और अन्य जानकारी वाले कार्ड का सेट होता है. फ़ंक्शन के इस ऑब्जेक्ट को बनाने के बाद, यूज़र इंटरफ़ेस (यूआई) कार्ड की सूची दिखाता है (एक से ज़्यादा कार्ड लौटाना देखें).
• बैकग्राउंड सिंक चलाने की सुविधा, ऐड-ऑन स्क्रिप्ट प्रोजेक्ट में बताए गए runBackgroundSync() फ़ंक्शन को चलाती है. यह फ़ंक्शन कार्ड नहीं बनाता है; इसके बजाय, यह कुछ ऐसे बैकग्राउंड टास्क करता है जिनसे यूज़र इंटरफ़ेस (यूआई) नहीं बदलता. फ़ंक्शन, UniversalActionResponse नहीं दिखाता, इसलिए फ़ंक्शन पूरा होने पर यूज़र इंटरफ़ेस (यूआई) नया कार्ड नहीं दिखाता. इसके बजाय, फ़ंक्शन के चलने के दौरान यूज़र इंटरफ़ेस (यूआई) लोडिंग इंडिकेटर स्पिनर दिखाता है.

यहां दिए गए उदाहरण से पता चलता है कि openContactURL(), createSettingsResponse(), और runBackgroundSync() फ़ंक्शन कैसे बनाए जा सकते हैं:

/**
 * Open a contact URL.
 * @param {Object} e an event object
 * @return {UniversalActionResponse}
 */
function openContactURL(e) {
  // Activate temporary Gmail scopes, in this case so that the
  // open message metadata can be read.
  var accessToken = e.gmail.accessToken;
  GmailApp.setCurrentMessageAccessToken(accessToken);

  // Build URL to open based on a base URL and the sender's email.
  // This URL must be included in the openLinkUrlPrefixes whitelist.
  var messageId = e.gmail.messageId;
  var message = GmailApp.getMessageById(messageId);
  var sender = message.getFrom();
  var url = "https://www.example.com/urlbase/" + sender;
  return CardService.newUniversalActionResponseBuilder()
      .setOpenLink(CardService.newOpenLink()
          .setUrl(url))
      .build();
}

/**
 * Create a collection of cards to control the add-on settings and
 * present other information. These cards are displayed in a list when
 * the user selects the associated "Open settings" universal action.
 *
 * @param {Object} e an event object
 * @return {UniversalActionResponse}
 */
function createSettingsResponse(e) {
  return CardService.newUniversalActionResponseBuilder()
      .displayAddOnCards(
          [createSettingCard(), createAboutCard()])
      .build();
}

/**
 * Create and return a built settings card.
 * @return {Card}
 */
function createSettingCard() {
  return CardService.newCardBuilder()
      .setHeader(CardService.newCardHeader().setTitle('Settings'))
      .addSection(CardService.newCardSection()
          .addWidget(CardService.newSelectionInput()
              .setType(CardService.SelectionInputType.CHECK_BOX)
              .addItem("Ask before deleting contact", "contact", false)
              .addItem("Ask before deleting cache", "cache", false)
              .addItem("Preserve contact ID after deletion", "contactId", false))
          // ... continue adding widgets or other sections here ...
      ).build();   // Don't forget to build the card!
}

/**
 * Create and return a built 'About' informational card.
 * @return {Card}
 */
function createAboutCard() {
  return CardService.newCardBuilder()
      .setHeader(CardService.newCardHeader().setTitle('About'))
      .addSection(CardService.newCardSection()
          .addWidget(CardService.newTextParagraph()
              .setText('This add-on manages contact information. For more '
                  + 'details see the <a href="https://www.example.com/help">'
                  + 'help page</a>.'))
      // ... add other information widgets or sections here ...
      ).build();  // Don't forget to build the card!
}

/**
 * Run background tasks, none of which should alter the UI.
 * Also records the time of sync in the script properties.
 *
 * @param {Object} e an event object
 */
function runBackgroundSync(e) {
  var props = PropertiesService.getUserProperties();
  props.setProperty("syncTime", new Date().toString());

  syncWithContacts();  // Not shown.
  updateCache();       // Not shown.
  validate();          // Not shown.

  // no return value tells the UI to keep showing the current card.
}