Google Workspace Dokümanlarındaki İletişim Kutuları ve Kenar Çubukları

Google Dokümanlar, E-Tablolar veya Formlar'a bağlı komut dosyaları, önceden oluşturulmuş uyarılar ve istemlerin yanı sıra özel HTML hizmeti sayfaları içeren iletişim kutuları ve kenar çubukları gibi çeşitli kullanıcı arayüzü öğeleri gösterebilir. Bu öğeler genellikle menü öğelerinden açılır. (Google Formlar'da kullanıcı arayüzü öğelerinin, formu yanıtlamak için açan kullanıcılara değil, yalnızca formu değiştirmek için açan düzenleyicilere gösterildiğini unutmayın.)

Uyarı iletişim kutuları

Uyarı, Google Dokümanlar, E-Tablolar, Slaytlar veya Forms düzenleyicisinde açılan önceden oluşturulmuş bir iletişim kutusudur. Bir mesaj ve "Tamam" düğmesi gösterilir. Başlık ve alternatif düğmeler isteğe bağlıdır. Bu, web tarayıcısında istemci tarafı JavaScript'de window.alert() çağırmaya benzer.

Uyarılar, iletişim kutusu açıkken sunucu tarafı komut dosyasını askıya alır. Kullanıcı iletişim kutusunu kapattıktan sonra komut dosyası devam eder ancak JDBC bağlantıları askıya alma sırasında devam etmez.

Aşağıdaki örnekte gösterildiği gibi, Google Dokümanlar, Formlar, Slaytlar ve E-Tablolar'ın tümü üç varyantta kullanılabilen Ui.alert() yöntemini kullanır. Varsayılan "Tamam" düğmesini geçersiz kılmak için buttons bağımsız değişkeni olarak Ui.ButtonSet enumerasyonundan bir değer iletin. Kullanıcının hangi düğmeyi tıkladığını değerlendirmek için alert() için döndürülen değeri Ui.Button enum ile karşılaştırın.

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

İstem iletişim kutuları

İstem, Google Dokümanlar, E-Tablolar, Slaytlar veya Forms düzenleyicisinde açılan önceden oluşturulmuş bir iletişim kutusudur. Bir mesaj, metin giriş alanı ve "Tamam" düğmesi gösterilir. Başlık ve alternatif düğmeler isteğe bağlıdır. Bu, web tarayıcısında istemci tarafı JavaScript'de window.prompt() çağırmaya benzer.

İletişim kutusu açıkken sunucu tarafı komut dosyasının askıya alınmasını ister. Kullanıcı iletişim kutusunu kapattıktan sonra komut dosyası devam eder ancak JDBC bağlantıları askıya alma sırasında devam etmez.

Aşağıdaki örnekte gösterildiği gibi, Google Dokümanlar, Formlar, Slaytlar ve E-Tablolar'ın tümü üç varyantta kullanılabilen Ui.prompt() yöntemini kullanır. Varsayılan "Tamam" düğmesini geçersiz kılmak için buttons bağımsız değişkeni olarak Ui.ButtonSet enumerasyonundan bir değer iletin. Kullanıcının yanıtını değerlendirmek için prompt() için döndürülen değeri yakalayın, ardından kullanıcının girişini almak için PromptResponse.getResponseText() işlevini çağırın ve PromptResponse.getSelectedButton() için döndürülen değeri Ui.Button enum ile karşılaştırın.

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

Özel iletişim kutuları

Özel iletişim kutuları, Google Dokümanlar, E-Tablolar, Slaytlar veya Formlar düzenleyicisinde HTML hizmeti kullanıcı arayüzü gösterebilir.

Özel iletişim kutuları, iletişim kutusu açıkken sunucu tarafı komut dosyasını askıya almaz. İstemci tarafı bileşen, HTML hizmet arayüzleri için google.script API'sini kullanarak sunucu tarafı komut dosyasına asenkron çağrılar yapabilir.

İletişim kutusu, HTML hizmet arayüzünün istemci tarafında google.script.host.close() çağrısı yaparak kendini kapatabilir. İletişim kutusu diğer arayüzler tarafından kapatılamaz, yalnızca kullanıcı veya kendisi tarafından kapatılabilir.

Aşağıdaki örnekte gösterildiği gibi Google Dokümanlar, Formlar, Slaytlar ve E-Tablolar'ın tümü iletişim kutusunu açmak için Ui.showModalDialog() yöntemini kullanır.

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()" />

Özel kenar çubukları

Yan panel, Google Dokümanlar, Formlar, Slaytlar ve E-Tablolar düzenleyicisinde HTML hizmeti kullanıcı arayüzü gösterebilir.

Yan paneller, iletişim kutusu açıkken sunucu tarafı komut dosyasını askıya almaz. İstemci tarafı bileşen, HTML hizmet arayüzleri için google.script API'sini kullanarak sunucu tarafı komut dosyasına eşzamansız çağrılar yapabilir.

Kenar çubuğu, HTML hizmet arayüzünün istemci tarafında google.script.host.close() çağrısı yaparak kendini kapatabilir. Kenar çubuğu diğer arayüzler tarafından kapatılamaz, yalnızca kullanıcı tarafından veya kendisi tarafından kapatılabilir.

Aşağıdaki örnekte gösterildiği gibi, Google Dokümanlar, Formlar, Slaytlar ve E-Tablolar'ın tümü kenar çubuğunu açmak için Ui.showSidebar() yöntemini kullanır.

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()" />

Dosya açma iletişim kutuları

Google Picker, kullanıcıların Google Drive dosyalarını seçmesine veya yüklemesine olanak tanıyan bir JavaScript API'dir. Google Seçici kitaplığı, kullanıcıların mevcut dosyaları seçmesine veya yeni dosya yüklemesine olanak tanıyan ve daha sonra bu seçimi daha fazla kullanım için komut dosyanıza geri gönderen özel bir iletişim kutusu oluşturmak amacıyla HTML hizmetinde kullanılabilir.

Şartlar

Google Seçici'yi Apps Script ile kullanmanın bazı koşulları vardır.

Örnek

Aşağıdaki örnekte, Apps Komut Dosyası'ndaki Google Seçici gösterilmektedir.

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