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

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

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

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

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

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

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

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

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

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

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

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