دیالوگ ها و نوارهای جانبی در اسناد Google Workspace

اسکریپت‌هایی که به Google Docs، Sheets یا Forms متصل هستند، می‌توانند انواع مختلفی از عناصر رابط کاربری را نمایش دهند - هشدارها و اعلان‌های از پیش ساخته شده، به‌علاوه دیالوگ‌ها و نوارهای جانبی که حاوی صفحات خدمات HTML سفارشی هستند. به طور معمول، این عناصر از آیتم های منو باز می شوند. (توجه داشته باشید که در فرم‌های Google، عناصر رابط کاربری فقط برای ویرایشگری که فرم را برای تغییر آن باز می‌کند، قابل مشاهده است، نه برای کاربری که فرم را برای پاسخگویی باز می‌کند.)

گفتگوهای هشدار

هشدار یک گفتگوی از پیش ساخته شده است که در ویرایشگر Google Docs، Sheets، Slides یا Forms باز می شود. یک پیام و دکمه "OK" را نمایش می دهد. عنوان و دکمه های جایگزین اختیاری هستند. این شبیه به فراخوانی 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 باز می شود. این یک پیام، یک فیلد ورودی متن و یک دکمه "OK" را نمایش می دهد. عنوان و دکمه های جایگزین اختیاری هستند. این شبیه به فراخوانی window.prompt() در جاوا اسکریپت سمت سرویس گیرنده در مرورگر وب است.

هنگام باز بودن گفتگو، اسکریپت سمت سرور را به حالت تعلیق درآورد. اسکریپت پس از بستن گفتگو توسط کاربر از سر گرفته می شود، اما اتصالات JDBC در سراسر تعلیق باقی نمی مانند.

همانطور که در مثال زیر نشان داده شده است، Google Docs¸ Forms، Slides و Sheets همگی از روش Ui.prompt() استفاده می کنند که در سه نوع موجود است. برای لغو دکمه پیش‌فرض «OK»، یک مقدار از Ui.ButtonSet enum را به عنوان آرگومان buttons ارسال کنید. برای ارزیابی پاسخ کاربر، مقدار بازگشتی را برای 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.");
  }
}

دیالوگ های سفارشی

یک گفتگوی سفارشی می‌تواند یک رابط کاربری سرویس HTML را در ویرایشگر Google Docs، Sheets، Slides یا Forms نمایش دهد.

گفتگوهای سفارشی اسکریپت سمت سرور را تا زمانی که گفتگو باز است به حالت تعلیق در نمی آورند. مؤلفه سمت سرویس گیرنده می تواند با استفاده از google.script API برای رابط های سرویس HTML با اسکریپت سمت سرور تماس های ناهمزمان برقرار کند.

دیالوگ می تواند با فراخوانی google.script.host.close() در سمت سرویس گیرنده یک رابط سرویس HTML بسته شود. دیالوگ را نمی توان توسط رابط های دیگر بسته کرد، فقط توسط کاربر یا خودش.

همانطور که در مثال زیر نشان داده شده است، 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 API برای رابط های سرویس HTML با اسکریپت سمت سرور تماس های ناهمزمان برقرار کند.

نوار کناری می تواند با فراخوانی google.script.host.close() در سمت سرویس گیرنده یک رابط سرویس HTML، خود را ببندد. نوار کناری را نمی‌توان توسط رابط‌های دیگر، فقط توسط کاربر یا خودش، بست.

همانطور که در مثال زیر نشان داده شده است، 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 Picker یک API جاوا اسکریپت است که به کاربران اجازه می‌دهد فایل‌های Google Drive را انتخاب یا آپلود کنند. کتابخانه Google Picker را می توان در سرویس HTML برای ایجاد یک گفتگوی سفارشی استفاده کرد که به کاربران امکان می دهد فایل های موجود را انتخاب کنند یا فایل های جدید را آپلود کنند، سپس آن انتخاب را برای استفاده بیشتر به اسکریپت خود برگردانند.

الزامات

چندین الزام برای استفاده از Google Picker با Apps Script وجود دارد.

مثال

مثال زیر Google Picker را در Apps Script نشان می دهد.

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"
        }
      ]
    }
  }