इस पेज का अनुवाद Cloud Translation API से किया गया है.

Google Workspace दस्तावेज़ों में डायलॉग बॉक्स और साइडबार

Google Docs, Sheets या Forms से जुड़ी स्क्रिप्ट में कई तरह के यूज़र-इंटरफ़ेस एलिमेंट दिखाए जा सकते हैं — पहले से बनी चेतावनियां और प्रॉम्प्ट के साथ ही, ऐसे डायलॉग और साइडबार जिनमें कस्टम एचटीएमएल सेवा पेज होते हैं. आम तौर पर, ये एलिमेंट मेन्यू आइटम से खोले जाते हैं. (ध्यान दें कि Google Forms में, यूज़र इंटरफ़ेस एलिमेंट सिर्फ़ उस एडिटर को दिखते हैं जो फ़ॉर्म में बदलाव करने के लिए उसे खोलता है, न कि उसे जवाब देने के लिए जो फ़ॉर्म खोलता है.)

सूचना से जुड़े डायलॉग

सूचना, पहले से बना हुआ एक डायलॉग बॉक्स होता है. यह Google Docs, Sheets, Slides या Forms एडिटर में खुलता है. इसमें एक मैसेज और "ठीक है" बटन दिखता है. टाइटल और वैकल्पिक बटन ज़रूरी नहीं होते. यह किसी वेब ब्राउज़र में क्लाइंट-साइड JavaScript में window.alert() को कॉल करने जैसा है.

डायलॉग खुले होने पर सूचना, सर्वर साइड स्क्रिप्ट को निलंबित कर देती है. उपयोगकर्ता के डायलॉग बंद करने के बाद स्क्रिप्ट फिर से शुरू हो जाती है, लेकिन निलंबन के दौरान JDBC कनेक्शन नहीं बना रहता.

जैसा कि नीचे उदाहरण में दिखाया गया है, Google Docs, Forms, Slides, और Sheets में Ui.alert() तरीके का इस्तेमाल होता है. यह तीन वैरिएंट में उपलब्ध है. डिफ़ॉल्ट "OK" बटन को बदलने के लिए, Ui.ButtonSet enum से buttons आर्ग्युमेंट के तौर पर कोई वैल्यू पास करें. यह पता लगाने के लिए कि उपयोगकर्ता ने किस बटन पर क्लिक किया है, alert() के लिए रिटर्न वैल्यू की तुलना Ui.Button enum से करें.

function onOpen() {
  SpreadsheetApp.getUi() // Or DocumentApp or SlidesApp or FormApp.
      .createMenu('Custom Menu')
      .addItem('Show alert', 'showAlert')
      .addToUi();
}

function showAlert() {
  var ui = SpreadsheetApp.getUi(); // Same variations.

  var result = ui.alert(
     'Please confirm',
     'Are you sure you want to continue?',
      ui.ButtonSet.YES_NO);

  // Process the user's response.
  if (result == ui.Button.YES) {
    // User clicked "Yes".
    ui.alert('Confirmation received.');
  } else {
    // User clicked "No" or X in the title bar.
    ui.alert('Permission denied.');
  }
}

प्रॉम्प्ट से जुड़े डायलॉग

प्रॉम्प्ट पहले से बना हुआ एक डायलॉग बॉक्स होता है, जो Google Docs, Sheets, Slides या Forms एडिटर में खुलता है. इसमें एक मैसेज, एक टेक्स्ट-इनपुट फ़ील्ड, और एक "ठीक है" बटन दिखता है. टाइटल और वैकल्पिक बटन ज़रूरी नहीं होते. यह किसी वेब ब्राउज़र में क्लाइंट-साइड JavaScript में window.prompt() को कॉल करने जैसा है.

डायलॉग खुला होने पर, सर्वर साइड स्क्रिप्ट को अनुरोध दिखने की वजह से निलंबित कर दिया जाता है. उपयोगकर्ता के डायलॉग बंद करने के बाद स्क्रिप्ट फिर से शुरू हो जाती है, लेकिन निलंबन के दौरान JDBC कनेक्शन नहीं बना रहता.

जैसा कि नीचे दिए गए उदाहरण में दिखाया गया है, Google Docs फ़ॉर्म, Slides, और Sheets में Ui.prompt() तरीके का इस्तेमाल होता है. यह तीन वैरिएंट में उपलब्ध है. डिफ़ॉल्ट "OK" बटन को बदलने के लिए, Ui.ButtonSet Enum से buttons आर्ग्युमेंट के तौर पर कोई वैल्यू पास करें. उपयोगकर्ता के रिस्पॉन्स का आकलन करने के लिए, prompt() के लिए रिटर्न वैल्यू कैप्चर करें. इसके बाद, PromptResponse.getResponseText() को कॉल करें, ताकि उपयोगकर्ता का इनपुट फिर से मिल सके. साथ ही, PromptResponse.getSelectedButton() के लिए रिटर्न वैल्यू की तुलना Ui.Button Enum से करें.

function onOpen() {
  SpreadsheetApp.getUi() // Or DocumentApp or SlidesApp or FormApp.
      .createMenu('Custom Menu')
      .addItem('Show prompt', 'showPrompt')
      .addToUi();
}

function showPrompt() {
  var ui = SpreadsheetApp.getUi(); // Same variations.

  var result = ui.prompt(
      'Let\'s get to know each other!',
      'Please enter your name:',
      ui.ButtonSet.OK_CANCEL);

  // Process the user's response.
  var button = result.getSelectedButton();
  var text = result.getResponseText();
  if (button == ui.Button.OK) {
    // User clicked "OK".
    ui.alert('Your name is ' + text + '.');
  } else if (button == ui.Button.CANCEL) {
    // User clicked "Cancel".
    ui.alert('I didn\'t get your name.');
  } else if (button == ui.Button.CLOSE) {
    // User clicked X in the title bar.
    ui.alert('You closed the dialog.');
  }
}

कस्टम डायलॉग

कस्टम डायलॉग बॉक्स में Google Docs, Sheets, Slides या Forms एडिटर में HTML सेवा के लिए यूज़र इंटरफ़ेस दिखाया जा सकता है.

डायलॉग खुले होने पर कस्टम डायलॉग, सर्वर साइड स्क्रिप्ट को निलंबित नहीं करते हैं. क्लाइंट-साइड कॉम्पोनेंट एचटीएमएल-सर्विस इंटरफ़ेस के लिए google.script एपीआई का इस्तेमाल करके, सर्वर-साइड स्क्रिप्ट को एसिंक्रोनस कॉल कर सकता है.

एचटीएमएल-सेवा इंटरफ़ेस के क्लाइंट साइड में google.script.host.close() को कॉल करके डायलॉग अपने-आप बंद हो सकता है. इस डायलॉग को सिर्फ़ उपयोगकर्ता या खुद दूसरे इंटरफ़ेस से बंद नहीं किया जा सकता.

जैसा कि नीचे दिए गए उदाहरण में दिखाया गया है, Google Docs, Forms, Slides, और Sheets, सभी डायलॉग बॉक्स खोलने के लिए Ui.showModalDialog() तरीके का इस्तेमाल करते हैं.

Code.gs

function onOpen() {
  SpreadsheetApp.getUi() // Or DocumentApp or SlidesApp or FormApp.
      .createMenu('Custom Menu')
      .addItem('Show dialog', 'showDialog')
      .addToUi();
}

function showDialog() {
  var html = HtmlService.createHtmlOutputFromFile('Page')
      .setWidth(400)
      .setHeight(300);
  SpreadsheetApp.getUi() // Or DocumentApp or SlidesApp or FormApp.
      .showModalDialog(html, 'My custom dialog');
}

पेज.html

Hello, world! <input type="button" value="Close" onclick="google.script.host.close()" />

पसंद के मुताबिक साइडबार

साइडबार में Google Docs, Forms, Slides, और Sheets एडिटर में एचटीएमएल सेवा यूज़र इंटरफ़ेस दिखाया जा सकता है.

डायलॉग खुले होने पर साइडबार, सर्वर साइड स्क्रिप्ट को निलंबित नहीं करते हैं. क्लाइंट-साइड कॉम्पोनेंट एचटीएमएल-सर्विस इंटरफ़ेस के लिए google.script एपीआई का इस्तेमाल करके, सर्वर-साइड स्क्रिप्ट को एसिंक्रोनस कॉल कर सकता है.

एचटीएमएल-सेवा इंटरफ़ेस के क्लाइंट साइड में google.script.host.close() को कॉल करके साइडबार खुद को बंद कर सकता है. इस साइडबार को दूसरे इंटरफ़ेस से, सिर्फ़ उपयोगकर्ता या खुद बंद नहीं किया जा सकता.

जैसा कि नीचे दिए गए उदाहरण में दिखाया गया है, Google Docs, Forms, Slides, और Sheets, ये सभी साइडबार खोलने के लिए, Ui.showSidebar() तरीके का इस्तेमाल करते हैं.

Code.gs

function onOpen() {
  SpreadsheetApp.getUi() // Or DocumentApp or SlidesApp or FormApp.
      .createMenu('Custom Menu')
      .addItem('Show sidebar', 'showSidebar')
      .addToUi();
}

function showSidebar() {
  var html = HtmlService.createHtmlOutputFromFile('Page')
      .setTitle('My custom sidebar');
  SpreadsheetApp.getUi() // Or DocumentApp or SlidesApp or FormApp.
      .showSidebar(html);
}

पेज.html

Hello, world! <input type="button" value="Close" onclick="google.script.host.close()" />

फ़ाइल खोलने के लिए डायलॉग बॉक्स

Google पिकर एक "फ़ाइल खोलने वाला" डायलॉग है, जो Google के सर्वर पर सेव की गई जानकारी के लिए होता है. इसमें Google Drive, Google Image Search, Google Video Search वगैरह शामिल हैं.

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

पिकर चालू करने और एपीआई पासकोड पाने के लिए, इन निर्देशों का पालन करें:

पुष्टि करें कि आपका स्क्रिप्ट प्रोजेक्ट, स्टैंडर्ड GCP प्रोजेक्ट का इस्तेमाल कर रहा है.
अपने Google Cloud प्रोजेक्ट में "Google पिकर एपीआई" चालू करें.
जब आपका Google Cloud प्रोजेक्ट खुला हो, तब एपीआई और सेवाएं चुनें. इसके बाद, क्रेडेंशियल पर क्लिक करें.
क्रेडेंशियल बनाएं > एपीआई पासकोड पर क्लिक करें. इस कार्रवाई से कुंजी बनती है, लेकिन आपको कुंजी में ऐप्लिकेशन पाबंदियां और एपीआई पाबंदी, दोनों जोड़ने के लिए कुंजी में बदलाव करना चाहिए.
एपीआई कुंजी के डायलॉग बॉक्स में, बंद करें पर क्लिक करें.
आपने जो एपीआई पासकोड बनाया है उसके बगल में, ज़्यादा > एपीआई पासकोड में बदलाव करें पर क्लिक करें.
ऐप्लिकेशन पाबंदियों में जाकर, इन चरणों को पूरा करें:
1. एचटीटीपी के रेफ़रल देने वाले (वेबसाइटें) चुनें.
2. वेबसाइट पाबंदियां में जाकर, कोई आइटम जोड़ें पर क्लिक करें.
3. रेफ़रर पर क्लिक करें और *.google.com डालें.
4. एक और आइटम जोड़ें और रेफ़रल देने वाले के तौर पर *.googleusercontent.com डालें.
5. हो गया पर क्लिक करें.
एपीआई से जुड़ी पाबंदियों में, इन चरणों को पूरा करें:
1. बटन पर पाबंदी लगाएं को चुनें.
2. एपीआई चुनें सेक्शन में, Google पिकर एपीआई चुनें और ठीक है पर क्लिक करें.
  
  ध्यान दें: Google पिकर एपीआई तब तक नहीं दिखता, जब तक आप उसे चालू नहीं करते. ऐसा इसलिए होता है, क्योंकि इस सूची में सिर्फ़ वे एपीआई ही दिखते हैं जो Cloud प्रोजेक्ट के लिए चालू किए गए हैं.
एपीआई पासकोड में, क्लिपबोर्ड पर कॉपी करें पर क्लिक करें.
सबसे नीचे, सेव करें पर क्लिक करें.

नीचे दिए गए उदाहरण में ScriptApp.getOAuthToken() को कहा गया है, ताकि यह उपयोगकर्ता के OAuth 2.0 ऐक्सेस टोकन को पिकर को पास कर सके. इस तकनीक की मदद से, पिकर को अपनी अनुमति देने वाला डायलॉग दिखाने की ज़रूरत नहीं पड़ती. हालांकि, ऐसा सिर्फ़ तब किया जा सकता है, जब पिकर को जिस OAuth दायरे की ज़रूरत हो वह Apps Script में उपलब्ध हो. ऐसा न होने पर, आपके पिकर कोड को अपने OAuth दायरों का एलान करना होगा, जैसा कि इस "hello world" उदाहरण में दिखाया गया है.

PickerBuilder को बनाते समय, आपको setOrigin(google.script.host.origin) को कॉल करना होगा.

code.gs

पिकर/code.gs

GitHub पर देखें

/**
 * Creates a custom menu in Google Sheets when the spreadsheet opens.
 */
function onOpen() {
  try {
    SpreadsheetApp.getUi().createMenu('Picker')
        .addItem('Start', 'showPicker')
        .addToUi();
  } catch (e) {
    // TODO (Developer) - Handle exception
    console.log('Failed with error: %s', e.error);
  }
}

/**
 * Displays an HTML-service dialog in Google Sheets that contains client-side
 * JavaScript code for the Google Picker API.
 */
function showPicker() {
  try {
    const html = HtmlService.createHtmlOutputFromFile('dialog.html')
        .setWidth(600)
        .setHeight(425)
        .setSandboxMode(HtmlService.SandboxMode.IFRAME);
    SpreadsheetApp.getUi().showModalDialog(html, 'Select a file');
  } catch (e) {
    // TODO (Developer) - Handle exception
    console.log('Failed with error: %s', e.error);
  }
}

/**
 * Gets the user's OAuth 2.0 access token so that it can be passed to Picker.
 * This technique keeps Picker from needing to show its own authorization
 * dialog, but is only possible if the OAuth scope that Picker needs is
 * available in Apps Script. In this case, the function includes an unused call
 * to a DriveApp method to ensure that Apps Script requests access to all files
 * in the user's Drive.
 *
 * @return {string} The user's OAuth 2.0 access token.
 */
function getOAuthToken() {
  try {
    DriveApp.getRootFolder();
    return ScriptApp.getOAuthToken();
  } catch (e) {
    // TODO (Developer) - Handle exception
    console.log('Failed with error: %s', e.error);
  }
}

डायलॉग.html

पिकर/dialog.html

GitHub पर देखें

<!DOCTYPE html>
<html>
<head>
  <link rel="stylesheet" href="https://ssl.gstatic.com/docs/script/css/add-ons.css">
  <script>
    // IMPORTANT: Replace the value for DEVELOPER_KEY with the API key obtained
    // from the Google Developers Console.
    var DEVELOPER_KEY = 'ABC123 ... ';
    var DIALOG_DIMENSIONS = {width: 600, height: 425};
    var pickerApiLoaded = false;

    /**
     * Loads the Google Picker API.
     */
    function onApiLoad() {
      gapi.load('picker', {'callback': function() {
        pickerApiLoaded = true;
      }});
     }

    /**
     * Gets the user's OAuth 2.0 access token from the server-side script so that
     * it can be passed to Picker. This technique keeps Picker from needing to
     * show its own authorization dialog, but is only possible if the OAuth scope
     * that Picker needs is available in Apps Script. Otherwise, your Picker code
     * will need to declare its own OAuth scopes.
     */
    function getOAuthToken() {
      google.script.run.withSuccessHandler(createPicker)
          .withFailureHandler(showError).getOAuthToken();
    }

    /**
     * Creates a Picker that can access the user's spreadsheets. This function
     * uses advanced options to hide the Picker's left navigation panel and
     * default title bar.
     *
     * @param {string} token An OAuth 2.0 access token that lets Picker access the
     *     file type specified in the addView call.
     */
    function createPicker(token) {
      if (pickerApiLoaded && token) {
        var picker = new google.picker.PickerBuilder()
            // Instruct Picker to display only spreadsheets in Drive. For other
            // views, see https://developers.google.com/picker/docs/#otherviews
            .addView(google.picker.ViewId.SPREADSHEETS)
            // Hide the navigation panel so that Picker fills more of the dialog.
            .enableFeature(google.picker.Feature.NAV_HIDDEN)
            // Hide the title bar since an Apps Script dialog already has a title.
            .hideTitleBar()
            .setOAuthToken(token)
            .setDeveloperKey(DEVELOPER_KEY)
            .setCallback(pickerCallback)
            .setOrigin(google.script.host.origin)
            // Instruct Picker to fill the dialog, minus 2 pixels for the border.
            .setSize(DIALOG_DIMENSIONS.width - 2,
                DIALOG_DIMENSIONS.height - 2)
            .build();
        picker.setVisible(true);
      } else {
        showError('Unable to load the file picker.');
      }
    }

    /**
     * A callback function that extracts the chosen document's metadata from the
     * response object. For details on the response object, see
     * https://developers.google.com/picker/docs/result
     *
     * @param {object} data The response object.
     */
    function pickerCallback(data) {
      var action = data[google.picker.Response.ACTION];
      if (action == google.picker.Action.PICKED) {
        var doc = data[google.picker.Response.DOCUMENTS][0];
        var id = doc[google.picker.Document.ID];
        var url = doc[google.picker.Document.URL];
        var title = doc[google.picker.Document.NAME];
        document.getElementById('result').innerHTML =
            '<b>You chose:</b><br>Name: <a href="' + url + '">' + title +
            '</a><br>ID: ' + id;
      } else if (action == google.picker.Action.CANCEL) {
        document.getElementById('result').innerHTML = 'Picker canceled.';
      }
    }

    /**
     * Displays an error message within the #result element.
     *
     * @param {string} message The error message to display.
     */
    function showError(message) {
      document.getElementById('result').innerHTML = 'Error: ' + message;
    }
  </script>
</head>
<body>
  <div>
    <button onclick="getOAuthToken()">Select a file</button>
    <p id="result"></p>
  </div>
  <script src="https://apis.google.com/js/api.js?onload=onApiLoad"></script>
</body>
</html>