সর্বজনীন কর্ম

ইউনিভার্সাল অ্যাকশন হল মেনু আইটেম উপাদান যা ব্যবহারকারীকে একটি নতুন ওয়েব পৃষ্ঠা খুলতে, নতুন UI কার্ড প্রদর্শন করতে, অথবা নির্বাচিত হলে একটি নির্দিষ্ট অ্যাপস স্ক্রিপ্ট ফাংশন চালানোর অনুমতি দেয়। কার্যক্ষমতার দিক থেকে এগুলি কার্ড অ্যাকশনের মতোই, তবে বর্তমান অ্যাড-অন প্রেক্ষাপট নির্বিশেষে আপনার অ্যাড-অনের প্রতিটি কার্ডে সর্বদা সর্বজনীন অ্যাকশন স্থাপন করা হয়।

ইউনিভার্সাল অ্যাকশন ব্যবহার করে, আপনি নিশ্চিত করতে পারেন যে ব্যবহারকারীর সর্বদা নির্দিষ্ট কার্যকারিতা অ্যাক্সেস থাকে, আপনার অ্যাড-অনের কোন অংশের সাথে তারা ইন্টারঅ্যাক্ট করে তা নির্বিশেষে। ইউনিভার্সাল অ্যাকশনের জন্য কিছু উদাহরণ ব্যবহারের উদাহরণ এখানে দেওয়া হল:

  • একটি সেটিংস ওয়েব পৃষ্ঠা খুলুন (অথবা একটি সেটিংস কার্ড প্রদর্শন করুন)।
  • ব্যবহারকারীকে সাহায্যের তথ্য দেখান।
  • 'নতুন গ্রাহক যোগ করুন' এর মতো একটি নতুন কর্মপ্রবাহ শুরু করুন।
  • একটি কার্ড প্রদর্শন করুন যা ব্যবহারকারীকে অ্যাড-অন সম্পর্কে প্রতিক্রিয়া পাঠাতে দেয়।

যখনই আপনার এমন কোনও ক্রিয়া থাকে যা বর্তমান প্রেক্ষাপটের উপর নির্ভর করে না, তখন আপনার এটিকে একটি সর্বজনীন ক্রিয়া হিসেবে বিবেচনা করা উচিত।

সর্বজনীন ক্রিয়া ব্যবহার করে

আপনার অ্যাড-অনের প্রজেক্ট ম্যানিফেস্টে ইউনিভার্সাল অ্যাকশনগুলি কনফিগার করা থাকে। একবার আপনি একটি ইউনিভার্সাল অ্যাকশন কনফিগার করার পরে, এটি সর্বদা আপনার অ্যাড-অনের ব্যবহারকারীদের জন্য উপলব্ধ থাকে। যদি ব্যবহারকারী একটি কার্ড দেখছেন, তাহলে আপনার দ্বারা সংজ্ঞায়িত সার্বজনীন অ্যাকশনগুলির সেটটি সর্বদা কার্ড মেনুতে প্রদর্শিত হবে, সেই কার্ডের জন্য আপনার দ্বারা সংজ্ঞায়িত যেকোনো কার্ড অ্যাকশনের পরে। অ্যাড-অনের ম্যানিফেস্টে যে ক্রমে সংজ্ঞায়িত করা হয়েছে সেই ক্রমে কার্ড মেনুতে ইউনিভার্সাল অ্যাকশনগুলি প্রদর্শিত হবে।

সর্বজনীন ক্রিয়াগুলি কনফিগার করা

আপনি আপনার অ্যাড-অনের ম্যানিফেস্টে সর্বজনীন ক্রিয়াগুলি কনফিগার করেন; আরও বিস্তারিত জানার জন্য ম্যানিফেস্ট দেখুন।

প্রতিটি ক্রিয়ার জন্য, আপনি সেই ক্রিয়ার মেনুতে প্রদর্শিত টেক্সটটি নির্দিষ্ট করেন। এরপর আপনি একটি openLink ক্ষেত্র নির্দিষ্ট করতে পারেন যা নির্দেশ করে যে ক্রিয়াটি সরাসরি একটি নতুন ট্যাবে একটি ওয়েব পৃষ্ঠা খুলবে। বিকল্পভাবে, আপনি একটি runFunction ক্ষেত্র নির্দিষ্ট করতে পারেন যা সর্বজনীন ক্রিয়া নির্বাচন করা হলে কার্যকর করার জন্য একটি Apps Script কলব্যাক ফাংশন নির্দিষ্ট করে।

যখন runFunction ব্যবহার করা হয়, তখন নির্দিষ্ট কলব্যাক ফাংশনটি সাধারণত নিম্নলিখিতগুলির মধ্যে একটি করে:

  • একটি বিল্ট UniversalActionResponse অবজেক্ট ফেরত দিয়ে তাৎক্ষণিকভাবে প্রদর্শনের জন্য UI কার্ড তৈরি করে।
  • একটি URL খোলে, সম্ভবত অন্যান্য কাজ করার পরে, একটি বিল্ট UniversalActionResponse অবজেক্ট ফেরত দিয়ে।
  • ব্যাকগ্রাউন্ডের কাজগুলি পরিচালনা করে যা কোনও নতুন কার্ডে স্যুইচ করে না বা কোনও URL খোলে না। এই ক্ষেত্রে কলব্যাক ফাংশন কিছুই ফেরত দেয় না।

কল করা হলে, কলব্যাক ফাংশনটি একটি ইভেন্ট অবজেক্ট পাস করে যাতে ওপেন কার্ড এবং অ্যাড-অন প্রসঙ্গ সম্পর্কে তথ্য থাকে।

উদাহরণ

নিম্নলিখিত কোড স্নিপেটটি একটি 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 অবজেক্ট প্রদান করে। ফাংশনটি এই অবজেক্টটি তৈরি করা শেষ করার পরে, UI কার্ডগুলির তালিকা প্রদর্শন করে ( একাধিক কার্ড ফেরত দেওয়া দেখুন)।
  • Run background sync অ্যাড-অন স্ক্রিপ্ট প্রজেক্টে সংজ্ঞায়িত runBackgroundSync() ফাংশনটি চালায়। এই ফাংশনটি কার্ড তৈরি করে না; পরিবর্তে এটি এমন কিছু অন্যান্য ব্যাকগ্রাউন্ড কাজ সম্পাদন করে যা UI পরিবর্তন করে না। যেহেতু ফাংশনটি UniversalActionResponse ফেরত দেয় না, তাই ফাংশনটি শেষ হওয়ার পরে UI একটি নতুন কার্ড প্রদর্শন করে না। পরিবর্তে ফাংশনটি চলাকালীন UI একটি লোডিং ইন্ডিকেটর স্পিনার প্রদর্শন করে।

এখানে 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.
}