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

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