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

Google Dokümanlar, Google E-Tablolar veya Google Formlar'a bağlı Google Apps Komut Dosyası projeleri, önceden oluşturulmuş uyarılar, istemler, kısa mesajlar, iletişim kutuları ve kenar çubukları gibi kullanıcı arayüzü öğelerini gösterebilir. Bu öğeler genellikle özel HTML hizmeti içeriği içerir ve çoğu zaman menü öğelerinden açılır. Formlar'da kullanıcı arayüzü öğeleri yalnızca formu değiştirmek için açan bir düzenleyiciye görünür, yanıtlayana görünmez.

Uyarı iletişim kutuları

Uyarı, Dokümanlar, E-Tablolar, Slaytlar veya Formlar düzenleyicisinde açılan önceden oluşturulmuş bir iletişim kutusudur. Bir mesaj ve Tamam düğmesi gösterir. Başlık ve alternatif düğmeler isteğe bağlıdır. Bu, bir web tarayıcısında istemci tarafı JavaScript'te 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 işlemi sırasında kalıcı olmaz.

Aşağıdaki örnekte gösterildiği gibi Dokümanlar, Formlar, Slaytlar ve E-Tablolar'ın tümünde, üç varyantı bulunan Ui.alert yöntemi kullanılır. Varsayılan Tamam düğmesini geçersiz kılmak için Ui.ButtonSet enum'ından bir değeri buttons bağımsız değişkeni olarak iletin. Kullanıcının hangi düğmeyi tıkladığını değerlendirmek için alert döndürme değerini Ui.Button enum'u 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() {
  const ui = SpreadsheetApp.getUi(); // Same variations.

  const 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, Dokümanlar, E-Tablolar, Slaytlar veya Formlar düzenleyicisinde açılan önceden oluşturulmuş bir iletişim kutusudur. Bir mesaj, metin giriş alanı ve Tamam düğmesi gösterir. Başlık ve alternatif düğmeler isteğe bağlıdır. Bu, bir web tarayıcısında istemci tarafı JavaScript'te window.prompt çağırmaya benzer.

İstemler, 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 işlemi sırasında kalıcı olmaz.

Aşağıdaki örnekte gösterildiği gibi Dokümanlar, Formlar, Slaytlar ve E-Tablolar'da Ui.prompt yöntemi kullanılır. Bu yöntem üç varyantta kullanılabilir. Varsayılan Tamam düğmesini geçersiz kılmak için Ui.ButtonSet enum'ından bir değeri buttons bağımsız değişkeni olarak iletin. Kullanıcının yanıtını değerlendirmek için prompt dönüş değerini yakalayın, ardından kullanıcının girişini almak için PromptResponse.getResponseText işlevini çağırın ve PromptResponse.getSelectedButton dönüş değerini 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() {
  const ui = SpreadsheetApp.getUi(); // Same variations.

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

  // Process the user's response.
  const button = result.getSelectedButton();
  const 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.");
  }
}

E-tablo bildirimleri

"Toast", bir mesaj görüntüleyen ancak komut dosyasını askıya almayan, bir E-Tablolar düzenleyicisinin sağ alt köşesindeki küçük bir iletişim kutusu penceresidir. Kullanıcı etkileşimi gerektirmeyen durum mesajlarını veya güncellemeleri göstermek için iyi bir yöntemdir.

Aşağıdaki örnekte gösterildiği gibi, E-Tablolar Spreadsheet.toast yöntemini kullanır. Bildirimler yalnızca E-Tablolar'da kullanılabilir.

function showToast() {
  SpreadsheetApp.getActiveSpreadsheet().toast("Task completed successfully.");
}

Özel iletişim kutuları

Özel bir iletişim kutusu, 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. Asenkron oldukları için iletişim kutusunu açan sunucu tarafı işlevi hemen tamamlanır. Özel iletişim kutusundan sunucuya veri iletmek için istemci tarafı kodunuzda google.script API'sini kullanın.

İletişim kutusu, bir HTML hizmeti arayüzünün istemci tarafında google.script.host.close çağrılarak kendi 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 Dokümanlar, Formlar, Slaytlar ve E-Tablolar'da iletişim kutusunu açmak için Ui.showModalDialog yöntemi kullanılır.

Code.gs

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

function showDialog() {
  const 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ı

Bir kenar çubuğu, Dokümanlar, Formlar, Slaytlar ve E-Tablolar düzenleyicisinde HTML hizmeti kullanıcı arayüzü gösterebilir.

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

Kenar çubuğu, bir HTML hizmeti arayüzünün istemci tarafında google.script.host.close çağrılarak kendi kendini kapatabilir. Kenar çubuğu, 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 Dokümanlar, Formlar, Slaytlar ve E-Tablolar'da kenar çubuğunu açmak için Ui.showSidebar yöntemi kullanılır.

Code.gs

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

function showSidebar() {
  const 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. Kullanıcıların mevcut dosyaları seçmesine veya yeni dosyalar yüklemesine olanak tanıyan özel bir iletişim kutusu oluşturmak için HTML hizmetindeki Google Picker kitaplığını kullanın, ardından seçimi komut dosyanıza geri iletin.

Şartlar

Google Seçici'yi Google Apps Komut Dosyası ile kullanmak için çeşitli şartlar gerekir:

Örnek

Aşağıdaki örnekte, Apps Komut Dosyası'nda Google Picker 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");
}
// Ensure the Drive API is enabled.
if (!Drive) {
  throw new Error("Please enable the Drive advanced service.");
}

/**
 * Checks that the file can be accessed.
 * @param {string} fileId The ID of the file.
 * @return {Object} The file resource.
 */
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.");
        }
      }

      /**
       * @typedef {Object} PickerResponse
       * @property {string} action
       * @property {PickerDocument[]} docs
       */

      /**
       * @typedef {Object} PickerDocument
       * @property {string} id
       * @property {string} name
       * @property {string} mimeType
       * @property {string} url
       * @property {string} lastEditedUtc
       */

      /**
       * 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 {PickerResponse} 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 {PickerResponse} 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"
      }
    ]
  }
}