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

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

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

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

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

यूनिवर्सल ऐक्शन का इस्तेमाल करना

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

यूनिवर्सल ऐक्शन कॉन्फ़िगर करना

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

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

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

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

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

उदाहरण

नीचे दिया गया कोड स्निपेट, 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.
}