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

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

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

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

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

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

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

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

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

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