このページは Cloud Translation API によって翻訳されました。

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

Google ドキュメント、スプレッドシート、フォームにバインドされているスクリプトでは、数種類のユーザーインターフェース要素（事前構築済みのアラートやプロンプト）と、カスタム HTML サービスページを含むダイアログとサイドバーを表示できます。通常、これらの要素はメニュー項目から開きます。（Google フォームでユーザーインターフェース要素を表示できるのは、編集するフォームを開いた編集者のみで、回答を開くフォームを表示したユーザーには表示されません）。

アラートダイアログ

アラートは、Google ドキュメント、スプレッドシート、スライド、フォームエディタ内に表示される事前構築済みのダイアログボックスです。メッセージと「OK」ボタンが表示されます。タイトルと代替ボタンは省略可能です。これは、ウェブブラウザのクライアント側 JavaScript で window.alert() を呼び出す場合に似ています。

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

以下の例に示すように、Google ドキュメント、フォーム、スライド、スプレッドシートはすべてメソッド Ui.alert() を使用します。このメソッドは 3 つのバリアントで使用できます。デフォルトの [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() {
  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 ドキュメント、スプレッドシート、スライド、フォームエディタ内に表示される事前構築済みのダイアログボックスです。メッセージ、テキスト入力フィールド、「OK」ボタンが表示されます。タイトルと代替ボタンは省略可能です。これは、ウェブブラウザのクライアント側 JavaScript で window.prompt() を呼び出す場合に似ています。

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

以下の例に示すように、Google ドキュメント - フォーム、スライド、スプレッドシートはすべて 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() {
  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 ドキュメント、スプレッドシート、スライド、フォームエディタ内に HTML サービスのユーザーインターフェースを表示します。

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

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

下記の例に示すように、Google ドキュメント、フォーム、スライド、スプレッドシートはすべて、メソッド 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 ドキュメント、フォーム、スライド、スプレッドシートエディタ内に HTML サービスのユーザーインターフェースを表示できます。

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

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

以下の例に示すように、Google ドキュメント、フォーム、スライド、スプレッドシートはすべて、メソッド 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 は、Google ドライブ、Google 画像検索、Google 動画検索など、Google サーバーに保存されている情報を表示する「ファイルを開く」ダイアログです。

以下の例に示すように、Picker のクライアントサイド JavaScript API を HTML サービスで使用して、既存のファイルの選択や新しいファイルのアップロードを可能にし、その選択をスクリプトに戻すためのカスタムダイアログを作成できます。

Picker を有効にして API キーを取得する手順は次のとおりです。

スクリプトプロジェクトが標準の GCP プロジェクトを使用していることを確認します。
GCP プロジェクトで「Google Picker API」を有効にします。
GCP プロジェクトを開いた状態で、[API とサービス] を選択し、[認証情報] をクリックします。
[認証情報を作成] > [API キー] の順にクリックします。この操作によりキーが作成されますが、キーを編集してアプリケーションの制限と API の制限の両方を追加する必要があります。
[API キー] ダイアログで、[閉じる] をクリックします。
作成した API キーの横にあるその他アイコン > [API キーを編集] をクリックします。
[アプリケーションの制限] で、次の手順を行います。
1. [HTTP リファラー（ウェブサイト）] を選択します。
2. [ウェブサイトの制限] で [項目を追加] をクリックします。
3. [Referrer] をクリックし、「*.google.com」と入力します。
4. 別のアイテムを追加し、参照 URL に「*.googleusercontent.com」と入力します。
5. [完了] をクリックします。
[API の制限] で、次の手順を行います。
1. [キーを制限] を選択します。
2. [Select APIs] セクションで [Google Picker API] を選択し、[OK] をクリックします。
  
  注: Google Picker API は、Cloud プロジェクトで有効な API のみをリストに表示するため、有効にしない限り表示されません。
[API キー] で、[クリップボードにコピー ] をクリックします。
下部にある [保存] をクリックします。

次の例では、ScriptApp.getOAuthToken() を呼び出して、ユーザーの OAuth 2.0 アクセストークンを Picker に渡すことができます。この手法により、Picker は独自の承認ダイアログを表示する必要がなくなりますが、Apps Script で Picker に必要な OAuth スコープが使用可能である場合にのみ可能です。それ以外の場合は、この「hello world」の例に示すように、Picker コードで独自の OAuth スコープを宣言する必要があります。

PickerBuilder の作成時に setOrigin(google.script.host.origin) を呼び出す必要があります。

code.gs

選択ツール/コード.gs

GitHub で表示

/**
 * Creates a custom menu in Google Sheets when the spreadsheet opens.
 */
function onOpen() {
  try {
    SpreadsheetApp.getUi().createMenu('Picker')
        .addItem('Start', 'showPicker')
        .addToUi();
  } catch (e) {
    // TODO (Developer) - Handle exception
    console.log('Failed with error: %s', e.error);
  }
}

/**
 * Displays an HTML-service dialog in Google Sheets that contains client-side
 * JavaScript code for the Google Picker API.
 */
function showPicker() {
  try {
    const html = HtmlService.createHtmlOutputFromFile('dialog.html')
        .setWidth(600)
        .setHeight(425)
        .setSandboxMode(HtmlService.SandboxMode.IFRAME);
    SpreadsheetApp.getUi().showModalDialog(html, 'Select a file');
  } catch (e) {
    // TODO (Developer) - Handle exception
    console.log('Failed with error: %s', e.error);
  }
}

/**
 * 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() {
  try {
    DriveApp.getRootFolder();
    return ScriptApp.getOAuthToken();
  } catch (e) {
    // TODO (Developer) - Handle exception
    console.log('Failed with error: %s', e.error);
  }
}

Dialogflow.html

選択ツール/Dialogflow.html

GitHub で表示

<!DOCTYPE html>
<html>
<head>
  <link rel="stylesheet" href="https://ssl.gstatic.com/docs/script/css/add-ons.css">
  <script>
    // IMPORTANT: Replace the value for DEVELOPER_KEY with the API key obtained
    // from the Google Developers Console.
    var DEVELOPER_KEY = 'ABC123 ... ';
    var DIALOG_DIMENSIONS = {width: 600, height: 425};
    var pickerApiLoaded = false;

    /**
     * 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(createPicker)
          .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) {
      if (pickerApiLoaded && token) {
        var picker = new google.picker.PickerBuilder()
            // Instruct Picker to display only spreadsheets in Drive. For other
            // views, see https://developers.google.com/picker/docs/#otherviews
            .addView(google.picker.ViewId.SPREADSHEETS)
            // 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)
            .setCallback(pickerCallback)
            .setOrigin(google.script.host.origin)
            // Instruct Picker to fill the dialog, minus 2 pixels for the border.
            .setSize(DIALOG_DIMENSIONS.width - 2,
                DIALOG_DIMENSIONS.height - 2)
            .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/docs/result
     *
     * @param {object} data The response object.
     */
    function pickerCallback(data) {
      var action = data[google.picker.Response.ACTION];
      if (action == google.picker.Action.PICKED) {
        var doc = data[google.picker.Response.DOCUMENTS][0];
        var id = doc[google.picker.Document.ID];
        var url = doc[google.picker.Document.URL];
        var title = doc[google.picker.Document.NAME];
        document.getElementById('result').innerHTML =
            '<b>You chose:</b><br>Name: <a href="' + url + '">' + title +
            '</a><br>ID: ' + id;
      } else if (action == google.picker.Action.CANCEL) {
        document.getElementById('result').innerHTML = 'Picker canceled.';
      }
    }

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

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

アラート ダイアログ

プロンプト ダイアログ

カスタム ダイアログ

Code.gs

Page.html

カスタム サイドバー

Code.gs

Page.html

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

code.gs

Dialogflow.html

アラートダイアログ

プロンプトダイアログ

カスタムダイアログ

カスタムサイドバー