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

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

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

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

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

यहां दिए गए उदाहरण में दिखाया गया है कि Google Docs, Forms, Slides, और Sheets, सभी Ui.alert() तरीके का इस्तेमाल करते हैं. यह तरीका तीन वैरिएंट में उपलब्ध है. डिफ़ॉल्ट "ठीक है" बटन को बदलने के लिए, buttons आर्ग्युमेंट के तौर पर Ui.ButtonSet एनम से कोई वैल्यू पास करें. उपयोगकर्ता ने किस बटन पर क्लिक किया, इसका आकलन करने के लिए, 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 एडिटर में खुलता है. इसमें एक मैसेज, टेक्स्ट-इनपुट फ़ील्ड, और "ठीक है" बटन दिखता है. टाइटल और वैकल्पिक बटन ज़रूरी नहीं हैं. यह वेब ब्राउज़र में क्लाइंट-साइड JavaScript में, window.prompt() को कॉल करने जैसा ही है.

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

इस उदाहरण में दिखाया गया है कि Google Docs, Forms, Slides, और 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()" />

कस्टम साइडबार

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

ज़रूरी शर्तें

Apps Script के साथ Google पिकर का इस्तेमाल करने के लिए, कई ज़रूरी शर्तें पूरी करनी होती हैं.

  • Google पिकर के लिए अपना एनवायरमेंट सेट अप करें.

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

  • Apps Script के प्रोजेक्ट के मेनिफ़ेस्ट में, Google Picker API के लिए अनुमति के ज़रूरी स्कोप की जानकारी होनी चाहिए, ताकि ScriptApp.getOAuthToken(), PickerBuilder.setOauthtoken() के लिए सही टोकन दिखा सके.

  • PickerBuilder.setDeveloperKey() में सेट की गई एपीआई पासकोड पर, Apps Script के लिए पाबंदी लगाई जा सकती है. ऐप्लिकेशन पर लगी पाबंदियां में जाकर, यह तरीका अपनाएं:

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

  • आपको PickerBuilder.setOrigin(google.script.host.origin) को कॉल करना होगा.

उदाहरण

इस उदाहरण में, Apps Script में Google पिकर का इस्तेमाल दिखाया गया है.

code.gs

picker/code.gs
/**
 * Creates a custom menu in Google Sheets when the spreadsheet opens.
 */
function onOpen() {
  SpreadsheetApp.getUi()
    .createMenu("Picker")
    .addItem("Start", "showPicker")
    .addToUi();
}

/**
 * Displays an HTML-service dialog in Google Sheets that contains client-side
 * JavaScript code for the Google Picker API.
 */
function showPicker() {
  const html = HtmlService.createHtmlOutputFromFile("dialog.html")
    .setWidth(800)
    .setHeight(600)
    .setSandboxMode(HtmlService.SandboxMode.IFRAME);
  SpreadsheetApp.getUi().showModalDialog(html, "Select a file");
}
/**
 * Checks that the file can be accessed.
 */
function getFile(fileId) {
  return Drive.Files.get(fileId, { fields: "*" });
}

/**
 * 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() {
  return ScriptApp.getOAuthToken();
}

dialog.html

picker/dialog.html
<!DOCTYPE html>
<html>
  <head>
    <link
      rel="stylesheet"
      href="https://ssl.gstatic.com/docs/script/css/add-ons.css"
    />
    <style>
      #result {
        display: flex;
        flex-direction: column;
        gap: 0.25em;
      }

      pre {
        font-size: x-small;
        max-height: 25vh;
        overflow-y: scroll;
        background: #eeeeee;
        padding: 1em;
        border: 1px solid #cccccc;
      }
    </style>
    <script>
      // TODO: Replace the value for DEVELOPER_KEY with the API key obtained
      // from the Google Developers Console.
      const DEVELOPER_KEY = "AIza...";
      // TODO: Replace the value for CLOUD_PROJECT_NUMBER with the project
      // number obtained from the Google Developers Console.
      const CLOUD_PROJECT_NUMBER = "1234567890";

      let pickerApiLoaded = false;
      let oauthToken;

      /**
       * 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((token) => {
            oauthToken = token;
            createPicker(token);
          })
          .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) {
        document.getElementById("result").innerHTML = "";

        if (pickerApiLoaded && token) {
          const picker = new google.picker.PickerBuilder()
            // Instruct Picker to display only spreadsheets in Drive. For other
            // views, see https://developers.google.com/picker/reference/picker.viewid
            .addView(
              new google.picker.DocsView(
                google.picker.ViewId.SPREADSHEETS
              ).setOwnedByMe(true)
            )
            // 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)
            .setAppId(CLOUD_PROJECT_NUMBER)
            .setCallback(pickerCallback)
            .setOrigin(google.script.host.origin)
            .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/reference/picker.responseobject
       *
       * @param {object} data The response object.
       */
      function pickerCallback(data) {
        const action = data[google.picker.Response.ACTION];
        if (action == google.picker.Action.PICKED) {
          handlePicked(data);
        } else if (action == google.picker.Action.CANCEL) {
          document.getElementById("result").innerHTML = "Picker canceled.";
        }
      }

      /**
       * Handles `"PICKED"` responsed from the Google Picker.
       *
       * @param {object} data The response object.
       */
      function handlePicked(data) {
        const doc = data[google.picker.Response.DOCUMENTS][0];
        const id = doc[google.picker.Document.ID];

        google.script.run
          .withSuccessHandler((driveFilesGetResponse) => {
            // Render the response from Picker and the Drive.Files.Get API.
            const resultElement = document.getElementById("result");
            resultElement.innerHTML = "";

            for (const response of [
              {
                title: "Picker response",
                content: JSON.stringify(data, null, 2),
              },
              {
                title: "Drive.Files.Get response",
                content: JSON.stringify(driveFilesGetResponse, null, 2),
              },
            ]) {
              const titleElement = document.createElement("h3");
              titleElement.appendChild(document.createTextNode(response.title));
              resultElement.appendChild(titleElement);

              const contentElement = document.createElement("pre");
              contentElement.appendChild(
                document.createTextNode(response.content)
              );
              resultElement.appendChild(contentElement);
            }
          })
          .withFailureHandler(showError)
          .getFile(data[google.picker.Response.DOCUMENTS][0].id);
      }

      /**
       * 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>
      <div id="result"></div>
    </div>
    <script src="https://apis.google.com/js/api.js?onload=onApiLoad"></script>
  </body>
</html>

appsscript.json

picker/appsscript.json
{
    "timeZone": "America/Los_Angeles",
    "exceptionLogging": "STACKDRIVER",
    "runtimeVersion": "V8",
    "oauthScopes": [
      "https://www.googleapis.com/auth/script.container.ui",
      "https://www.googleapis.com/auth/drive.file"
    ],
    "dependencies": {
      "enabledAdvancedServices": [
        {
          "userSymbol": "Drive",
          "version": "v3",
          "serviceId": "drive"
        }
      ]
    }
  }