Google Workspace ドキュメントのダイアログとサイドバー

Google ドキュメント、Google スプレッドシート、Google フォームにバインドされた Google Apps Script プロジェクトでは、組み込みのアラート、プロンプト、トースト、ダイアログ、サイドバーなどのユーザーインターフェース要素を表示できます。これらの要素には通常、カスタム HTML サービスコンテンツが含まれており、メニュー項目から開かれることがよくあります。フォームでは、ユーザーインターフェース要素は、フォームを開いて変更する編集者にのみ表示され、回答者には表示されません。

通知ダイアログ

アラートは、ドキュメント、スプレッドシート、スライド、フォームのエディタ内に開く組み込みのダイアログです。メッセージと [OK] ボタンが表示されます。タイトルと代替ボタンは省略可能です。ウェブブラウザ内のクライアントサイド JavaScript で window.alert を呼び出すのと似ています。

ダイアログが開いている間、アラートはサーバーサイドスクリプトを一時停止します。ユーザーがダイアログを閉じるとスクリプトは再開されますが、JDBC接続は一時停止後も維持されません。

次の例に示すように、ドキュメント、フォーム、スライド、スプレッドシートではすべて、3 つのバリエーションで使用できる 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() {
  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.");
  }
}

プロンプトダイアログ

プロンプトは、ドキュメント、スプレッドシート、スライド、フォームのエディタ内に開く組み込みのダイアログです。メッセージ、テキスト入力フィールド、[OK] ボタンが表示されます。タイトルと代替ボタンは省略可能です。ウェブブラウザ内のクライアントサイド JavaScript で window.prompt を呼び出すのと似ています。

ダイアログが開いている間、プロンプトはサーバーサイドスクリプトを一時停止します。ユーザーがダイアログを閉じるとスクリプトは再開されますが、JDBC接続は一時停止後も維持されません。

次の例に示すように、ドキュメント、フォーム、スライド、スプレッドシートではすべて、 Ui.prompt メソッドを使用します。これは 3 つのバリエーションで使用できます。デフォルトの [OK] ボタンをオーバーライドするには、 Ui.ButtonSet 列挙型の値を 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() {
  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.");
  }
}

スプレッドシートのトースト

「トースト」は、スプレッドシートエディタの右下隅に表示される小さなダイアログウィンドウで、メッセージを表示しますが、スクリプトは一時停止しません。ユーザーインタラクションを必要としないステータスメッセージや更新情報を表示するのに適しています。

次の例に示すように、スプレッドシートではメソッド Spreadsheet.toastを使用します。トーストはスプレッドシートでのみ使用できます。

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

カスタムダイアログ

カスタムダイアログでは、ドキュメント、スプレッドシート、スライド、フォームのエディタ内に HTML サービスユーザーインターフェースを表示できます。

ダイアログが開いている間、カスタムダイアログはサーバーサイドスクリプトを一時停止しません。非同期であるため、ダイアログを開くサーバーサイド関数はすぐに終了します。カスタムダイアログからサーバーにデータを渡すには、クライアントサイドコードで google.script API を使用します。

ダイアログは、HTML サービスインターフェースのクライアントサイドで google.script.host.close を呼び出すことで、自動的に閉じることができます。ダイアログは、他のインターフェースでは閉じることができません。ユーザーまたはダイアログ自体でのみ閉じることができます。

次の例に示すように、ドキュメント、フォーム、スライド、スプレッドシートではすべて、メソッド Ui.showModalDialog を使用してダイアログを開きます。

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

カスタムサイドバー

サイドバーでは、ドキュメント、フォーム、スライド、スプレッドシートのエディタ内に HTML サービスユーザーインターフェースを表示できます。

ダイアログが開いている間、サイドバーはサーバーサイドスクリプトを一時停止しません。クライアントサイドコンポーネントは、HTML サービスインターフェースの google.script API を使用して、サーバーサイドスクリプトに非同期呼び出しを行うことができます。

サイドバーは、HTML サービスインターフェースのクライアントサイドで google.script.host.close を呼び出すことで、自動的に閉じることができます。サイドバーは、他のインターフェースでは閉じることができません。ユーザーまたはサイドバー自体でのみ閉じることができます。

次の例に示すように、ドキュメント、フォーム、スライド、スプレッドシートではすべて、メソッド Ui.showSidebarを使用してサイドバーを開きます。

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

ファイルを開くダイアログ

Google Picker は、ユーザーが Google ドライブファイルを選択またはアップロードできるようにする JavaScript API です。HTML サービスで Google Picker ライブラリを使用して、ユーザーが既存のファイルを選択したり、新しいファイルをアップロードしたりできるカスタムダイアログを作成し、選択内容をスクリプトに渡します。

要件

Google Apps Script で Google Picker を使用するには、次の要件を満たす必要があります。

Google Picker の環境を設定します。
スクリプトプロジェクトでは、標準の Google Cloud プロジェクトを使用する必要があります。

同じクラウドプロジェクト番号を PickerBuilder.setAppId に渡します（drive.file スコープを使用する場合）。
Apps Script プロジェクトマニフェストで、Google Picker API で必要な認証スコープを指定する必要があります。これにより、 ScriptApp.getOAuthToken が PickerBuilder.setOauthtokenの正しいトークンを返します。
PickerBuilder.setDeveloperKey で設定された API キーを Apps Script に制限します。[アプリケーションの制限] で、次の操作を行います。
1. [HTTP リファラー（ウェブサイト）] を選択します。
2. [ウェブサイトの制限] で [項目を追加] をクリックします。
3. [リファラー] をクリックし、*.google.com と入力します。
4. 別の項目を追加し、リファラーとして *.googleusercontent.com と入力します。
5. [完了] をクリックします。
PickerBuilder.setOrigin を呼び出します。

例

次の例は、Apps Script での Google Picker を示しています。

code.gs

picker/code.gs

GitHub で表示

/**
 * 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

GitHub で表示

<!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

GitHub で表示

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

Google Workspace ドキュメントのダイアログとサイドバー コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

通知ダイアログ

プロンプト ダイアログ

スプレッドシートのトースト

カスタム ダイアログ

Code.gs

Page.html

カスタム サイドバー

Code.gs

Page.html

ファイルを開くダイアログ

要件

例

code.gs

dialog.html

appsscript.json

Google Workspace ドキュメントのダイアログとサイドバー

プロンプトダイアログ

カスタムダイアログ

カスタムサイドバー