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

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

सूचना के डायलॉग

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

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

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

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 का एडिटर. यह एक संदेश, एक टेक्स्ट-इनपुट फ़ील्ड, और एक "OK" दिखाता है बटन; शीर्षक और वैकल्पिक बटन का इस्तेमाल करना ज़रूरी नहीं है. यह कॉल करने की तरह है window.prompt() का इस्तेमाल किस तरह किया जा सकता है.

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

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

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 एडिटर में ऐक्सेस कर सकते हैं.

कस्टम डायलॉग, डायलॉग खुले रहने पर सर्वर-साइड स्क्रिप्ट को निलंबित नहीं करते. क्लाइंट-साइड कॉम्पोनेंट, सर्वर साइड स्क्रिप्ट को एसिंक्रोनस कॉल कर सकता है 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');
}

Page.html

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

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

साइडबार, HTML सेवा उपयोगकर्ता को दिखा सकता है इंटरफ़ेस 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);
}

Page.html

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

फ़ाइल खोलने के डायलॉग

Google पिकर एक "फ़ाइल-ओपन" होता है इसमें संग्रहित जानकारी के लिए डायलॉग बॉक्स Google सर्वर, जिनमें Google डिस्क, Google चित्र खोज, Google वीडियो शामिल हैं खोज वगैरह.

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

ध्यान दें: Google पिकर का इस्तेमाल करने के लिए, आपका स्क्रिप्ट प्रोजेक्ट स्टैंडर्ड Google Cloud प्रोजेक्ट.

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

1. पुष्टि करें कि आपका स्क्रिप्ट प्रोजेक्ट, स्टैंडर्ड GCP प्रोजेक्ट का इस्तेमाल कर रहा हो.
2. "Google पिकर एपीआई" चालू करें Google Cloud प्रोजेक्ट में.
3. जब आपका Google Cloud प्रोजेक्ट खुला हो, तब एपीआई और Services चुनें. इसके बाद, क्रेडेंशियल पर क्लिक करें.
4. क्रेडेंशियल बनाएं > एपीआई पासकोड पर क्लिक करें. इस कार्रवाई से कुंजी बन जाती है. हालांकि, आपको कुंजी में बदलाव करके, ऐप्लिकेशन से जुड़ी पाबंदियों और एपीआई से जुड़ी पाबंदी, दोनों को जोड़ना होगा.
5. एपीआई पासकोड डायलॉग में, बंद करें पर क्लिक करें.
6. आपने जो एपीआई पासकोड बनाया है उसके बगल में, ज़्यादा > एपीआई पासकोड में बदलाव करें पर क्लिक करें.

7. ऐप्लिकेशन से जुड़ी पाबंदियां में जाकर, नीचे दिया गया तरीका अपनाएं:

   1. एचटीटीपी रेफ़रर (वेबसाइटें) चुनें.
   2. वेबसाइट से जुड़ी पाबंदियां में जाकर, कोई आइटम जोड़ें पर क्लिक करें.
   3. रेफ़रलकर्ता पर क्लिक करके *.google.com डालें.
   4. कोई दूसरा आइटम जोड़ें और *.googleusercontent.com को रेफ़रर के तौर पर डालें.
   5. हो गया पर क्लिक करें.

8. एपीआई से जुड़ी पाबंदियों में जाकर, इन चरणों को पूरा करें:

   1. कुंजी पर पाबंदी लगाएं को चुनें.

   2. एपीआई चुनें सेक्शन में, Google पिकर एपीआई चुनें और ठीक है पर क्लिक करें.

      ध्यान दें: Google पिकर एपीआई तब तक नहीं दिखता, जब तक आपने इसे चालू न किया हो यह इसलिए है, क्योंकि सूची में सिर्फ़ वे एपीआई दिखते हैं जो क्लाउड के लिए चालू किए गए हैं प्रोजेक्ट.

9. एपीआई पासकोड में जाकर, क्लिपबोर्ड पर कॉपी करें पर क्लिक करें.

10. सबसे नीचे, सेव करें पर क्लिक करें.

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

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

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);
  }
}

dialog.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>