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

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