एचटीएमएल सेवा: सर्वर के फ़ंक्शन के साथ संपर्क करना

google.script.run एक एसिंक्रोनस क्लाइंट-साइड JavaScript API है. इसकी मदद से, एचटीएमएल सेवा वाले पेजों को सर्वर साइड Apps Script फ़ंक्शन को कॉल किया जा सकता है. यहां दिए गए उदाहरण में, google.script.run के सबसे बुनियादी फ़ंक्शन के बारे में बताया गया है. क्लाइंट-साइड JavaScript से, सर्वर पर किसी फ़ंक्शन को कॉल किया जा सकता है.

Code.gs

function doGet() {
  return HtmlService.createHtmlOutputFromFile('Index');
}

function doSomething() {
  Logger.log('I was called!');
}

Index.html

<!DOCTYPE html>
<html>
  <head>
    <base target="_top">
    <script>
      google.script.run.doSomething();
    </script>
  </head>
</html>

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

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

google.script.run API, सर्वर फ़ंक्शन को एक साथ 10 कॉल करने की अनुमति देता है. अगर 10 के चालू रहने के दौरान ही आप 11वां कॉल करते हैं, तो सर्वर का फ़ंक्शन तब तक देरी से चलेगा, जब तक 10 में से कोई एक स्पॉट खाली नहीं हो जाता. व्यावहारिक तौर पर, आपको इस पाबंदी के बारे में बहुत कम विचार करना चाहिए, खास तौर पर क्योंकि ज़्यादातर ब्राउज़र पहले ही एक ही सर्वर पर एक साथ किए जाने वाले अनुरोधों की संख्या को 10 से कम पर सीमित कर देते हैं. उदाहरण के लिए, Firefox में सीमा 6 है. इसी तरह, ज़्यादातर ब्राउज़र सर्वर अनुरोधों की संख्या बढ़ाने में तब तक देरी करते हैं, जब तक कि कोई मौजूदा अनुरोध पूरा नहीं हो जाता.

पैरामीटर और रिटर्न वैल्यू

क्लाइंट के पैरामीटर के साथ सर्वर फ़ंक्शन को कॉल किया जा सकता है. इसी तरह, सर्वर फ़ंक्शन क्लाइंट को सक्सेस हैंडलर को पास किए गए पैरामीटर के तौर पर कोई वैल्यू दिखा सकता है.

कानूनी पैरामीटर और रिटर्न वैल्यू, JavaScript से जुड़े प्रिमिटिव होते हैं, जैसे कि Number, Boolean, String या null. साथ ही, JavaScript ऑब्जेक्ट और अरे, जो प्रिमिटिव, ऑब्जेक्ट, और अरे से बने होते हैं. पेज में मौजूद form एलिमेंट एक पैरामीटर के तौर पर भी कानूनी होता है, लेकिन यह फ़ंक्शन का इकलौता पैरामीटर होना चाहिए. यह रिटर्न वैल्यू के तौर पर कानूनी नहीं है. अगर form के अलावा, Date, Function, DOM एलिमेंट या अन्य पाबंदी वाले टाइप को पास करने की कोशिश की जाती है, तो अनुरोध काम नहीं करते. इनमें ऑब्जेक्ट या अरे के साथ पाबंदी वाले टाइप भी शामिल हैं. सर्कुलर रेफ़रंस बनाने वाले ऑब्जेक्ट भी काम नहीं करेंगे. साथ ही, अरे में तय नहीं किए गए फ़ील्ड null बन जाएंगे.

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

सफलता हैंडलर

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

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

Code.gs

function doGet() {
  return HtmlService.createHtmlOutputFromFile('Index');
}

function getUnreadEmails() {
  return GmailApp.getInboxUnreadCount();
}

Index.html

<!DOCTYPE html>
<html>
  <head>
    <base target="_top">
    <script>
      function onSuccess(numUnread) {
        var div = document.getElementById('output');
        div.innerHTML = 'You have ' + numUnread
            + ' unread messages in your Gmail inbox.';
      }

      google.script.run.withSuccessHandler(onSuccess)
          .getUnreadEmails();
    </script>
  </head>
  <body>
    <div id="output"></div>
  </body>
</html>

असफलता हैंडलर

अगर सर्वर जवाब नहीं दे पाता है या कोई गड़बड़ी दिखाता है, तो withFailureHandler(function) आपको सक्सेस हैंडलर के बजाय फ़ेलियर हैंडलर को तय करने की अनुमति देता है. Error ऑब्जेक्ट (अगर कोई है) को आर्ग्युमेंट के तौर पर पास किया जाता है.

डिफ़ॉल्ट रूप से, अगर आप फ़ेलियर हैंडलर की जानकारी नहीं देते हैं, तो असफलताओं को JavaScript कंसोल में लॉग किया जाता है. इसे बदलने के लिए, withFailureHandler(null) को कॉल करें या ऐसा फ़ेल हैंडलर दें जो कुछ नहीं करता.

फ़ेलियर हैंडलर का सिंटैक्स करीब-करीब सक्सेस हैंडलर के जैसा ही है, जैसा कि इस उदाहरण में दिखाया गया है.

Code.gs

function doGet() {
  return HtmlService.createHtmlOutputFromFile('Index');
}

function getUnreadEmails() {
  // 'got' instead of 'get' will throw an error.
  return GmailApp.gotInboxUnreadCount();
}

Index.html

<!DOCTYPE html>
<html>
  <head>
    <base target="_top">
    <script>
      function onFailure(error) {
        var div = document.getElementById('output');
        div.innerHTML = "ERROR: " + error.message;
      }

      google.script.run.withFailureHandler(onFailure)
          .getUnreadEmails();
    </script>
  </head>
  <body>
    <div id="output"></div>
  </body>
</html>

उपयोगकर्ता ऑब्जेक्ट

आप withUserObject(object) को कॉल करके, सर्वर को किए जाने वाले कई कॉल के लिए एक ही सफलता या फ़ेल होने वाले हैंडलर का फिर से इस्तेमाल कर सकते हैं. इससे, हैंडलर को दूसरे पैरामीटर के तौर पर पास किए जाने वाले ऑब्जेक्ट की जानकारी दी जा सकेगी. इस “उपयोगकर्ता ऑब्जेक्ट” को — User क्लास से अलग होना चाहिए. इससे आपको उस कॉन्टेक्स्ट का जवाब देने में मदद मिलती है जिसमें क्लाइंट ने सर्वर से संपर्क किया था. उपयोगकर्ता ऑब्जेक्ट, सर्वर को नहीं भेजे जाते हैं, इसलिए वे पैरामीटर पर पाबंदी लगाए बिना और सर्वर कॉल के लिए वैल्यू दिखाए बिना, फ़ंक्शन, डीओएम एलिमेंट वगैरह समेत करीब-करीब कुछ भी हो सकते हैं. हालांकि, उपयोगकर्ता ऑब्जेक्ट new ऑपरेटर की मदद से बनाए गए ऑब्जेक्ट नहीं हो सकते.

इस उदाहरण में, दोनों में से किसी भी बटन पर क्लिक करने से, उस बटन को सर्वर के वैल्यू के साथ अपडेट कर दिया जाएगा और दूसरे बटन में कोई बदलाव नहीं किया जाएगा. भले ही, वे एक सक्सेस हैंडलर शेयर करते हों. onclick हैंडलर में कीवर्ड this का मतलब button है.

Code.gs

function doGet() {
  return HtmlService.createHtmlOutputFromFile('Index');
}

function getEmail() {
  return Session.getActiveUser().getEmail();
}

Index.html

<!DOCTYPE html>
<html>
  <head>
    <base target="_top">
    <script>
      function updateButton(email, button) {
        button.value = 'Clicked by ' + email;
      }
    </script>
  </head>
  <body>
    <input type="button" value="Not Clicked"
      onclick="google.script.run
          .withSuccessHandler(updateButton)
          .withUserObject(this)
          .getEmail()" />
    <input type="button" value="Not Clicked"
      onclick="google.script.run
          .withSuccessHandler(updateButton)
          .withUserObject(this)
          .getEmail()" />
  </body>
</html>

फ़ॉर्म

अगर form एलिमेंट वाले सर्वर फ़ंक्शन को पैरामीटर के तौर पर कॉल किया जाता है, तो फ़ॉर्म एक ही ऑब्जेक्ट बन जाता है. इसमें फ़ील्ड के नाम, कुंजियों के तौर पर और फ़ील्ड वैल्यू, वैल्यू के तौर पर शामिल होते हैं. वैल्यू को स्ट्रिंग में बदल दिया जाता है. हालांकि, फ़ाइल-इनपुट फ़ील्ड के कॉन्टेंट को Blob ऑब्जेक्ट नहीं बनाया जाता.

इस उदाहरण में पेज को फिर से लोड किए बिना, फ़ाइल इनपुट फ़ील्ड के साथ एक फ़ॉर्म प्रोसेस किया जाता है; यह फ़ाइल को Google Drive पर अपलोड करता है और फिर क्लाइंट-साइड पेज में फ़ाइल का यूआरएल प्रिंट करता है. onsubmit हैंडलर में कीवर्ड this उसी फ़ॉर्म का हिस्सा है. ध्यान दें कि पेज में सभी फ़ॉर्म लोड होने पर, सबमिट करने की डिफ़ॉल्ट कार्रवाई preventFormSubmit ने बंद कर दी है. इससे, अपवाद की स्थिति में पेज को गलत यूआरएल पर रीडायरेक्ट करने से रोका जाता है.

Code.gs

function doGet() {
  return HtmlService.createHtmlOutputFromFile('Index');
}

function processForm(formObject) {
  var formBlob = formObject.myFile;
  var driveFile = DriveApp.createFile(formBlob);
  return driveFile.getUrl();
}

Index.html

<!DOCTYPE html>
<html>
  <head>
    <base target="_top">
    <script>
      // Prevent forms from submitting.
      function preventFormSubmit() {
        var forms = document.querySelectorAll('form');
        for (var i = 0; i < forms.length; i++) {
          forms[i].addEventListener('submit', function(event) {
            event.preventDefault();
          });
        }
      }
      window.addEventListener('load', preventFormSubmit);

      function handleFormSubmit(formObject) {
        google.script.run.withSuccessHandler(updateUrl).processForm(formObject);
      }
      function updateUrl(url) {
        var div = document.getElementById('output');
        div.innerHTML = '<a href="' + url + '">Got it!</a>';
      }
    </script>
  </head>
  <body>
    <form id="myForm" onsubmit="handleFormSubmit(this)">
      <input name="myFile" type="file" />
      <input type="submit" value="Submit" />
    </form>
    <div id="output"></div>
 </body>
</html>

स्क्रिप्ट रनर

google.script.run को “स्क्रिप्ट रनर” के बिल्डर के तौर पर देखा जा सकता है. अगर आपने स्क्रिप्ट रनर में कोई सक्सेस हैंडलर, फ़ेलियर हैंडलर या उपयोगकर्ता ऑब्जेक्ट जोड़ा है, तो मौजूदा रनर को नहीं बदला जा रहा है. इसके बजाय, आपको नए तरीके से स्क्रिप्ट रनर को बदलने की ज़रूरत पड़ेगी.

withSuccessHandler(), withFailureHandler(), और withUserObject() के किसी भी कॉम्बिनेशन और किसी भी क्रम का इस्तेमाल किया जा सकता है. आप उस स्क्रिप्ट रनर पर भी किसी भी बदलाव करने वाले फ़ंक्शन को कॉल कर सकते हैं जिसमें पहले से ही कोई वैल्यू सेट है. नई वैल्यू बस पिछली वैल्यू को बदल देती है.

इस उदाहरण में, तीनों सर्वर कॉल के लिए एक सामान्य फ़ेलियर हैंडलर सेट किया गया है, लेकिन दो अलग-अलग सक्सेस हैंडलर सेट किए गए हैं:

var myRunner = google.script.run.withFailureHandler(onFailure);
var myRunner1 = myRunner.withSuccessHandler(onSuccess);
var myRunner2 = myRunner.withSuccessHandler(onDifferentSuccess);

myRunner1.doSomething();
myRunner1.doSomethingElse();
myRunner2.doSomething();

निजी फ़ंक्शन

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

इस उदाहरण में, getBankBalance() फ़ंक्शन, क्लाइंट कोड में उपलब्ध है. आपके सोर्स कोड की जांच करने वाला उपयोगकर्ता, इसका नाम खोज सकता है, भले ही आपने उसे कॉल न किया हो. हालांकि, क्लाइंट को deepSecret_() और obj.objectMethod() फ़ंक्शन पूरी तरह नहीं दिखते.

Code.gs

function doGet() {
  return HtmlService.createHtmlOutputFromFile('Index');
}

function getBankBalance() {
  var email = Session.getActiveUser().getEmail()
  return deepSecret_(email);
}

function deepSecret_(email) {
 // Do some secret calculations
 return email + ' has $1,000,000 in the bank.';
}

var obj = {
  objectMethod: function() {
    // More secret calculations
  }
};

Index.html

<!DOCTYPE html>
<html>
  <head>
    <base target="_top">
    <script>
      function onSuccess(balance) {
        var div = document.getElementById('output');
        div.innerHTML = balance;
      }

      google.script.run.withSuccessHandler(onSuccess)
          .getBankBalance();
    </script>
  </head>
  <body>
    <div id="output">No result yet...</div>
  </body>
</html>

ऐप्लिकेशन में डायलॉग Google Workspace का साइज़ बदला जा रहा है

Google Docs, Sheets या फ़ॉर्म में कस्टम डायलॉग बॉक्स का साइज़ बदला जा सकता है. इसके लिए, क्लाइंट-साइड कोड में google.script.host तरीकों setWidth(width) या setHeight(height) को कॉल करें. (डायलॉग का शुरुआती साइज़ सेट करने के लिए, HtmlOutput तरीका setWidth(width) और setHeight(height) का इस्तेमाल करें.) ध्यान दें कि साइज़ बदलने पर, डायलॉग पैरंट विंडो में फिर से केंद्रित नहीं होते हैं. साथ ही, साइडबार का साइज़ नहीं बदला जा सकता.

Google Workspaceमें डायलॉग और साइडबार बंद किए जा रहे हैं

अगर Google Docs, Sheets या Forms में डायलॉग बॉक्स या साइडबार दिखाने के लिए एचटीएमएल सेवा का इस्तेमाल किया जाता है, तो window.close() पर कॉल करके इंटरफ़ेस को बंद नहीं किया जा सकता. इसके बजाय, आपको google.script.host.close() को कॉल करना होगा. उदाहरण के लिए, एचटीएमएल को Google Workspace यूज़र इंटरफ़ेस के तौर पर दिखाना सेक्शन देखें.

ब्राउज़र फ़ोकस को Google Workspaceमें ले जाया जा रहा है

उपयोगकर्ता के ब्राउज़र पर, डायलॉग या साइडबार से Google Docs, Sheets या Forms एडिटर पर वापस जाने के लिए, इस तरीके को कॉल करें google.script.host.editor.focus(). यह तरीका खास तौर पर, दस्तावेज़ की सेवा वाले तरीकों Document.setCursor(position) और Document.setSelection(range) के साथ मिलकर काम करता है.