लिखने के लिए कार्रवाइयों वाले यूज़र इंटरफ़ेस (यूआई) को बढ़ाना

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

ऐड-ऑन के कॉम्पोज़ यूज़र इंटरफ़ेस (यूआई) को ऐक्सेस करना

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

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

'लिखें' सुविधा के लिए ऐड-ऑन बनाना

किसी ऐड-ऑन में 'लिखें' सुविधा जोड़ने के लिए, यह सामान्य तरीका अपनाएं:

  1. ऐड-ऑन स्क्रिप्ट प्रोजेक्ट के मेनिफ़ेस्ट में gmail.composeTrigger फ़ील्ड जोड़ें. साथ ही, मेनिफ़ेस्ट के स्कोप को अपडेट करें, ताकि कॉम्पोज़ ऐक्शन के लिए ज़रूरी स्कोप शामिल किए जा सकें.
  2. कॉम्पोज़ ट्रिगर फ़ंक्शन लागू करें, जो ट्रिगर होने पर कॉम्पोज़ यूज़र इंटरफ़ेस (यूआई) बनाता है. कॉम्पोज़ ट्रिगर फ़ंक्शन, एक Card ऑब्जेक्ट या Card ऑब्जेक्ट का ऐरे दिखाते हैं. इन ऑब्जेक्ट में, कॉम्पोज़ ऐक्शन के लिए कॉम्पोज़ यूज़र इंटरफ़ेस (यूआई) शामिल होता है.
  3. उपयोगकर्ता के यूज़र इंटरफ़ेस (यूआई) इंटरैक्शन पर प्रतिक्रिया देने के लिए, इससे जुड़े कॉलबैक फ़ंक्शन लागू करें. ये फ़ंक्शन, लिखने की कार्रवाई नहीं हैं. ये सिर्फ़ लिखने के यूज़र इंटरफ़ेस (यूआई) को दिखाते हैं. ये अलग-अलग फ़ंक्शन होते हैं, जो यह तय करते हैं कि लिखने के यूज़र इंटरफ़ेस के अलग-अलग एलिमेंट चुनने पर क्या होगा. उदाहरण के लिए, बटन वाले यूज़र इंटरफ़ेस (यूआई) कार्ड में आम तौर पर एक कॉलबैक फ़ंक्शन होता है. यह फ़ंक्शन तब काम करता है, जब कोई उपयोगकर्ता उस बटन पर क्लिक करता है. ड्राफ़्ट मैसेज के कॉन्टेंट को अपडेट करने वाले विजेट के कॉलबैक फ़ंक्शन से, UpdateDraftActionResponse ऑब्जेक्ट दिखना चाहिए.

ट्रिगर फ़ंक्शन बनाना

ऐड-ऑन का कॉम्पोज़ यूज़र इंटरफ़ेस (यूआई) उसी तरह बनाया जाता है जिस तरह ऐड-ऑन का मैसेज यूज़र इंटरफ़ेस (यूआई) बनाया जाता है. इसके लिए, कार्ड बनाने और उन्हें विजेट से भरने के लिए, Apps Script की कार्ड सेवा का इस्तेमाल किया जाता है.

आपको अपने मेनिफ़ेस्ट में बताए गए gmail.composeTrigger.selectActions[].runFunction को लागू करना होगा. कंपोज ट्रिगर फ़ंक्शन को एक Card ऑब्जेक्ट या Card ऑब्जेक्ट का एक कलेक्शन दिखाना चाहिए. इसमें उस ऐक्शन के लिए कंपोज यूज़र इंटरफ़ेस (यूआई) शामिल होना चाहिए. ये फ़ंक्शन, कॉन्टेक्स्ट के हिसाब से ट्रिगर करने वाले फ़ंक्शन से काफ़ी मिलते-जुलते हैं. साथ ही, इनसे कार्ड भी उसी तरह बनाए जाने चाहिए.

ट्रिगर इवेंट ऑब्जेक्ट बनाना

कॉम्पोज़ ऐक्शन चुनने पर, वह उससे जुड़ा कॉम्पोज़ ट्रिगर फ़ंक्शन चलाता है और फ़ंक्शन को पैरामीटर के तौर पर इवेंट ऑब्जेक्ट पास करता है. इवेंट ऑब्जेक्ट में, ऐड-ऑन के कॉन्टेक्स्ट और ट्रिगर फ़ंक्शन के लिए लिखे जा रहे ड्राफ़्ट के बारे में जानकारी हो सकती है.

इवेंट ऑब्जेक्ट में जानकारी को व्यवस्थित करने के तरीके के बारे में जानने के लिए, इवेंट ऑब्जेक्ट का स्ट्रक्चर देखें. इवेंट ऑब्जेक्ट में मौजूद जानकारी को कुछ हद तक, gmail.composeTrigger.draftAccess मेनिफ़ेस्ट फ़ील्ड की वैल्यू से कंट्रोल किया जाता है:

  • अगर gmail.composeTrigger.draftAccess मैनिफ़ेस्ट फ़ील्ड NONE है या शामिल नहीं है, तो इवेंट ऑब्जेक्ट में सिर्फ़ कम से कम जानकारी होती है.

  • अगर gmail.composeTrigger.draftAccess को METADATA पर सेट किया गया है, तो ईमेल लिखने के लिए ट्रिगर फ़ंक्शन में भेजे गए इवेंट ऑब्जेक्ट में, लिखे जा रहे ईमेल के पाने वालों की सूचियां अपने-आप भर जाती हैं.

चालू ड्राफ़्ट में कॉन्टेंट डालना

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

मौजूदा ड्राफ़्ट ईमेल को आसानी से अपडेट करने के लिए, कार्ड सेवा को इन क्लास के साथ जोड़ा गया है:

  • ContentType—यह एक वैल्यू है, जिससे यह तय होता है कि बदलाव किया जा सकने वाला एचटीएमएल, बदलाव न किया जा सकने वाला एचटीएमएल (जिसमें Gmail के उपयोगकर्ता बदलाव नहीं कर सकते) या सादा टेक्स्ट कॉन्टेंट जोड़ना है या नहीं.
  • UpdateDraftActionResponse—किसी ऐसी कार्रवाई के जवाब को दिखाता है जिससे ईमेल का मौजूदा ड्राफ़्ट अपडेट होता है.
  • UpdateDraftActionResponseBuilderUpdateDraftActionResponse ऑब्जेक्ट के लिए बिल्डर.
  • UpdateDraftBodyAction—यह ऐसी कार्रवाई को दिखाता है जिससे मौजूदा ड्राफ़्ट ईमेल का मुख्य हिस्सा अपडेट होता है.
  • UpdateDraftBodyType—यह एक एलिमेंट है, जिससे यह तय होता है कि बॉडी को कैसे बदला जाए.
  • UpdateDraftSubjectAction—इससे ऐसी कार्रवाई के बारे में पता चलता है जो मौजूदा ड्राफ़्ट ईमेल के विषय फ़ील्ड को अपडेट करती है.
  • UpdateDraftToRecipientsAction—इससे उस ऐक्शन के बारे में पता चलता है जो मौजूदा ड्राफ़्ट ईमेल के पाने वालों की सूची को अपडेट करता है.
  • UpdateDraftCcRecipientsAction—इसका मतलब है कि ईमेल के मौजूदा ड्राफ़्ट की कॉपी पाने वाले लोगों की जानकारी अपडेट की गई है.
  • UpdateDraftBccRecipientsAction—यह ऐसी कार्रवाई को दिखाता है जिससे मौजूदा ड्राफ़्ट ईमेल की गुप्त कॉपी पाने वालों की जानकारी अपडेट होती है.

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

उदाहरण 1

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

    /**
     * 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;
    }

उदाहरण 2

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

    /**
     * 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;
    }