কম্পোজ অ্যাকশন ব্যবহার করে কম্পোজ UI-কে আরও প্রসারিত করুন।

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

Google Workspace অ্যাড-অন কম্পোজ UI অ্যাক্সেস করুন

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

উভয় ক্ষেত্রেই অ্যাড-অনটি তার ম্যানিফেস্টে সংজ্ঞায়িত সংশ্লিষ্ট কম্পোজ ট্রিগার ফাংশনটি কার্যকর করে। এই কম্পোজ ট্রিগার ফাংশনটি সেই কম্পোজ অ্যাকশনের জন্য কম্পোজ UI তৈরি করে, যা Gmail পরবর্তীতে ব্যবহারকারীকে প্রদর্শন করে।

একটি কম্পোজ অ্যাড-অন তৈরি করুন

এই সাধারণ ধাপগুলো অনুসরণ করে আপনি একটি অ্যাড-অনে কম্পোজ কার্যকারিতা যোগ করতে পারেন:

  1. অ্যাড-অন স্ক্রিপ্ট প্রজেক্টের ম্যানিফেস্টে gmail.composeTrigger ফিল্ডটি যোগ করুন এবং কম্পোজ অ্যাকশনের জন্য প্রয়োজনীয় স্কোপগুলো অন্তর্ভুক্ত করতে ম্যানিফেস্ট স্কোপগুলো আপডেট করুন।
  2. একটি কম্পোজ ট্রিগার ফাংশন তৈরি করুন যা ট্রিগারটি সক্রিয় হলে একটি কম্পোজ UI তৈরি করে। কম্পোজ ট্রিগার ফাংশনগুলো একটি একক Card অবজেক্ট অথবা Card অবজেক্টের একটি অ্যারে রিটার্ন করে, যা কম্পোজ অ্যাকশনটির জন্য UI গঠন করে।
  3. ব্যবহারকারীর কম্পোজ UI ইন্টারঅ্যাকশনের প্রতিক্রিয়া জানাতে প্রয়োজনীয় সংশ্লিষ্ট কলব্যাক ফাংশনগুলো প্রয়োগ করুন। এই ফাংশনগুলো স্বয়ং কম্পোজ অ্যাকশন নয় (যা শুধুমাত্র কম্পোজ UI প্রদর্শন করে); বরং, এগুলো হলো সেইসব স্বতন্ত্র ফাংশন যা কম্পোজ UI-এর বিভিন্ন উপাদান নির্বাচিত হলে কী ঘটবে তা নিয়ন্ত্রণ করে। উদাহরণস্বরূপ, একটি বাটনযুক্ত UI কার্ডের সাধারণত একটি সংশ্লিষ্ট কলব্যাক ফাংশন থাকে যা ব্যবহারকারী সেই বাটনটি ক্লিক করলে কার্যকর হয়। যে উইজেটগুলো ড্রাফট মেসেজের বিষয়বস্তু আপডেট করে, তাদের কলব্যাক ফাংশনের একটি UpdateDraftActionResponse অবজেক্ট রিটার্ন করা উচিত।

কম্পোজ ট্রিগার ফাংশন

একটি অ্যাড-অনের কম্পোজ UI, সেটির মেসেজ UI-এর মতোই তৈরি করা হয়—অ্যাপস স্ক্রিপ্ট কার্ড সার্ভিস ব্যবহার করে কার্ড তৈরি করতে এবং সেগুলোকে উইজেট দিয়ে পূরণ করতে।

আপনাকে অবশ্যই আপনার ম্যানিফেস্টে সংজ্ঞায়িত gmail.composeTrigger.selectActions[].runFunction ইমপ্লিমেন্ট করতে হবে। কম্পোজ ট্রিগার ফাংশনটিকে অবশ্যই একটি একক Card অবজেক্ট অথবা Card অবজেক্টের একটি অ্যারে রিটার্ন করতে হবে, যা সেই অ্যাকশনের জন্য কম্পোজ UI তৈরি করে। এই ফাংশনগুলো কনটেক্সচুয়াল ট্রিগার ফাংশনের মতোই এবং একইভাবে কার্ড তৈরি করবে।

কম্পোজ ট্রিগার ইভেন্ট অবজেক্ট

যখন একটি কম্পোজ অ্যাকশন নির্বাচন করা হয়, তখন এটি সংশ্লিষ্ট কম্পোজ ট্রিগার ফাংশনটি কার্যকর করে এবং ফাংশনটিতে একটি ইভেন্ট অবজেক্টকে প্যারামিটার হিসেবে প্রেরণ করে। ইভেন্ট অবজেক্টটি ট্রিগার ফাংশনে অ্যাড-অন কনটেক্সট এবং যে ড্রাফটটি কম্পোজ করা হচ্ছে, সে সম্পর্কিত তথ্য বহন করতে পারে।

ইভেন্ট অবজেক্টে তথ্য কীভাবে সাজানো থাকে, সে সম্পর্কে বিস্তারিত জানতে ইভেন্ট অবজেক্টের গঠন দেখুন। ইভেন্ট অবজেক্টে থাকা তথ্য আংশিকভাবে gmail.composeTrigger.draftAccess ম্যানিফেস্ট ফিল্ডের মান দ্বারা নিয়ন্ত্রিত হয়:

  • যদি gmail.composeTrigger.draftAccess ম্যানিফেস্ট ফিল্ডটির মান NONE হয় অথবা এটি অন্তর্ভুক্ত না থাকে, তাহলে ইভেন্ট অবজেক্টটিতে শুধুমাত্র ন্যূনতম তথ্য থাকে।

  • যদি gmail.composeTrigger.draftAccess METADATA তে সেট করা থাকে, তাহলে কম্পোজ ট্রিগার ফাংশনে পাঠানো ইভেন্ট অবজেক্টটি, যে ইমেলটি কম্পোজ করা হচ্ছে তার প্রাপকদের তালিকা দিয়ে পূরণ করা হয়। METADATA ড্রাফট অ্যাক্সেস ব্যবহার করার জন্য অ্যাড-অন ম্যানিফেস্টে অবশ্যই https://www.googleapis.com/auth/gmail.addons.current.message.metadata Gmail স্কোপটি অন্তর্ভুক্ত থাকতে হবে।

সক্রিয় খসড়াগুলিতে বিষয়বস্তু যোগ করুন

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

বর্তমান খসড়া ইমেল আপডেট করা সহজ করার জন্য, কার্ড পরিষেবাটি নিম্নলিখিত ক্লাসগুলো দিয়ে সম্প্রসারিত করা হয়েছে:

  • ContentType — একটি enum যা নির্ধারণ করে যে পরিবর্তনযোগ্য HTML, অপরিবর্তনযোগ্য HTML (যা Gmail ব্যবহারকারীরা সম্পাদনা করতে পারেন না), নাকি সাধারণ টেক্সট কন্টেন্ট যোগ করা হবে।
  • UpdateDraftActionResponse —এটি এমন একটি অ্যাকশনের প্রতিক্রিয়া যা বর্তমান ড্রাফট ইমেলটিকে আপডেট করে।
  • UpdateDraftActionResponseBuilderUpdateDraftActionResponse অবজেক্ট তৈরির জন্য একটি বিল্ডার।
  • UpdateDraftBodyAction —এটি এমন একটি অ্যাকশন যা বর্তমান ড্রাফট ইমেইলের মূল অংশ আপডেট করে।
  • UpdateDraftBodyType — একটি enum যা নির্ধারণ করে বডি কীভাবে পরিবর্তিত হবে।
  • UpdateDraftSubjectAction —এটি এমন একটি অ্যাকশন যা বর্তমান ড্রাফট ইমেইলের সাবজেক্ট ফিল্ড আপডেট করে।
  • UpdateDraftToRecipientsAction —এটি এমন একটি পদক্ষেপ যা বর্তমান খসড়া ইমেইলের প্রাপকদের তালিকা হালনাগাদ করে।
  • UpdateDraftCcRecipientsAction —এটি এমন একটি পদক্ষেপ যা বর্তমান খসড়া ইমেইলের সিসি প্রাপকদের তালিকা হালনাগাদ করে।
  • UpdateDraftBccRecipientsAction —এটি এমন একটি পদক্ষেপ যা বর্তমান খসড়া ইমেইলের বিসিসি প্রাপকদের তথ্য হালনাগাদ করে।

সাধারণত একটি অ্যাড-অন কম্পোজ UI-তে একটি 'Save' বা 'Insert' উইজেট থাকে, যেখানে ব্যবহারকারী ক্লিক করে বোঝাতে পারেন যে UI-তে তাদের নির্বাচন করা শেষ এবং তারা যে ইমেলটি লিখছেন তাতে তাদের পছন্দগুলো যোগ করতে চান। এই ইন্টারঅ্যাক্টিভিটি যোগ করার জন্য, উইজেটটির সাথে একটি সংশ্লিষ্ট Action অবজেক্ট থাকা উচিত, যা উইজেটটি ক্লিক করা হলে একটি নির্দিষ্ট কলব্যাক ফাংশন চালানোর জন্য অ্যাড-অনকে নির্দেশ দেয়। আপনাকে অবশ্যই এই কলব্যাক ফাংশনগুলো ইমপ্লিমেন্ট করতে হবে। প্রতিটি কলব্যাক ফাংশনের একটি বিল্ট-ইন UpdateDraftActionResponse অবজেক্ট রিটার্ন করা উচিত, যা বর্তমান ড্রাফট ইমেলে কী কী পরিবর্তন করতে হবে তার বিস্তারিত বিবরণ দেবে।

উদাহরণ ১

নিম্নলিখিত কোড স্নিপেটটি দেখায় কিভাবে একটি কম্পোজ UI তৈরি করতে হয় যা বর্তমান ইমেল ড্রাফটের বিষয় এবং To, Cc, ও Bcc প্রাপকদের আপডেট করে।

/**
 * Compose trigger function that fires when the compose UI is
 * requested. Builds and returns a compose UI for inserting images.
 *
 * @param {event} e The compose trigger event object. Not used in
 *         this example.
 * @return {Card[]}
 */
function getComposeUI(e) {
  return [buildComposeCard()];
}

/**
 * Build a card to display interactive buttons to allow the user to
 * update the subject, and To, Cc, Bcc recipients.
 *
 * @return {Card}
 */
function buildComposeCard() {

  var card = CardService.newCardBuilder();
  var cardSection = CardService.newCardSection().setHeader('Update email');
  cardSection.addWidget(
      CardService.newTextButton()
          .setText('Update subject')
          .setOnClickAction(CardService.newAction()
              .setFunctionName('applyUpdateSubjectAction')));
  cardSection.addWidget(
      CardService.newTextButton()
          .setText('Update To recipients')
          .setOnClickAction(CardService.newAction()
              .setFunctionName('updateToRecipients')));
  cardSection.addWidget(
      CardService.newTextButton()
          .setText('Update Cc recipients')
          .setOnClickAction(CardService.newAction()
              .setFunctionName('updateCcRecipients')));
  cardSection.addWidget(
      CardService.newTextButton()
          .setText('Update Bcc recipients')
          .setOnClickAction(CardService.newAction()
              .setFunctionName('updateBccRecipients')));
  return card.addSection(cardSection).build();
}

/**
 * Updates the subject field of the current email when the user clicks
 * on "Update subject" in the compose UI.
 *
 * Note: This is not the compose action that builds a compose UI, but
 * rather an action taken when the user interacts with the compose UI.
 *
 * @return {UpdateDraftActionResponse}
 */
function applyUpdateSubjectAction() {
  // Get the new subject field of the email.
  // This function is not shown in this example.
  var subject = getSubject();
  var response = CardService.newUpdateDraftActionResponseBuilder()
      .setUpdateDraftSubjectAction(CardService.newUpdateDraftSubjectAction()
          .addUpdateSubject(subject))
      .build();
  return response;
}

/**
 * Updates the To recipients of the current email when the user clicks
 * on "Update To recipients" in the compose UI.
 *
 * Note: This is not the compose action that builds a compose UI, but
 * rather an action taken when the user interacts with the compose UI.
 *
 * @return {UpdateDraftActionResponse}
 */
function applyUpdateToRecipientsAction() {
  // Get the new To recipients of the email.
  // This function is not shown in this example.
  var toRecipients = getToRecipients();
  var response = CardService.newUpdateDraftActionResponseBuilder()
      .setUpdateDraftToRecipientsAction(CardService.newUpdateDraftToRecipientsAction()
          .addUpdateToRecipients(toRecipients))
      .build();
  return response;
}

/**
 * Updates the Cc recipients  of the current email when the user clicks
 * on "Update Cc recipients" in the compose UI.
 *
 * Note: This is not the compose action that builds a compose UI, but
 * rather an action taken when the user interacts with the compose UI.
 *
 * @return {UpdateDraftActionResponse}
 */
function applyUpdateCcRecipientsAction() {
  // Get the new Cc recipients of the email.
  // This function is not shown in this example.
  var ccRecipients = getCcRecipients();
  var response = CardService.newUpdateDraftActionResponseBuilder()
      .setUpdateDraftCcRecipientsAction(CardService.newUpdateDraftCcRecipientsAction()
          .addUpdateToRecipients(ccRecipients))
      .build();
  return response;
}

/**
 * Updates the Bcc recipients  of the current email when the user clicks
 * on "Update Bcc recipients" in the compose UI.
 *
 * Note: This is not the compose action that builds a compose UI, but
 * rather an action taken when the user interacts with the compose UI.
 *
 * @return {UpdateDraftActionResponse}
 */
function applyUpdateBccRecipientsAction() {
  // Get the new Bcc recipients of the email.
  // This function is not shown in this example.
  var bccRecipients = getBccRecipients();
  var response = CardService.newUpdateDraftActionResponseBuilder()
      .setUpdateDraftBccRecipientsAction(CardService.newUpdateDraftBccRecipientsAction()
          .addUpdateToRecipients(bccRecipients))
      .build();
  return response;
}

উদাহরণ ২

নিম্নলিখিত কোড স্নিপেটটি দেখায় কিভাবে একটি কম্পোজ UI তৈরি করতে হয় যা বর্তমান ড্রাফট ইমেইলে ছবি যুক্ত করে।

/**
 * Compose trigger function that fires when the compose UI is
 * requested. Builds and returns a compose UI for inserting images.
 *
 * @param {event} e The compose trigger event object. Not used in
 *         this example.
 * @return {Card[]}
 */
function getInsertImageComposeUI(e) {
  return [buildImageComposeCard()];
}

/**
 * Build a card to display images from a third-party source.
 *
 * @return {Card}
 */
function buildImageComposeCard() {
  // Get a short list of image URLs to display in the UI.
  // This function is not shown in this example.
  var imageUrls = getImageUrls();

  var card = CardService.newCardBuilder();
  var cardSection = CardService.newCardSection().setHeader('My Images');
  for (var i = 0; i < imageUrls.length; i++) {
    var imageUrl = imageUrls[i];
    cardSection.addWidget(
        CardService.newImage()
            .setImageUrl(imageUrl)
            .setOnClickAction(CardService.newAction()
                  .setFunctionName('applyInsertImageAction')
                  .setParameters({'url' : imageUrl})));
  }
  return card.addSection(cardSection).build();
}

/**
 * Adds an image to the current draft email when the image is clicked
 * in the compose UI. The image is inserted at the current cursor
 * location. If any content of the email draft is currently selected,
 * it is deleted and replaced with the image.
 *
 * Note: This is not the compose action that builds a compose UI, but
 * rather an action taken when the user interacts with the compose UI.
 *
 * @param {event} e The incoming event object.
 * @return {UpdateDraftActionResponse}
 */
function applyInsertImageAction(e) {
  var imageUrl = e.parameters.url;
  var imageHtmlContent = '<img style=\"display: block\" src=\"'
        + imageUrl + '\"/>';
  var response = CardService.newUpdateDraftActionResponseBuilder()
      .setUpdateDraftBodyAction(CardService.newUpdateDraftBodyAction()
          .addUpdateContent(
              imageHtmlContent,
              CardService.ContentType.MUTABLE_HTML)
          .setUpdateType(
              CardService.UpdateDraftBodyType.IN_PLACE_INSERT))
      .build();
  return response;
}