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 キーを編集] をクリックします。
[アプリケーションの制限] で、次の手順を行います。
- [HTTP リファラー(ウェブサイト)] を選択します。
- [ウェブサイトの制限] で [項目を追加] をクリックします。
- [Referrer] をクリックし、「
*.google.com
」と入力します。 - 別のアイテムを追加し、参照 URL に「
*.googleusercontent.com
」と入力します。 - [完了] をクリックします。
[API の制限] で、次の手順を行います。
- [キーを制限] を選択します。
[Select APIs] セクションで [Google Picker API] を選択し、[OK] をクリックします。
注: Google Picker API は、Cloud プロジェクトで有効な API のみをリストに表示するため、有効にしない限り表示されません。
[API キー] で、[クリップボードにコピー
] をクリックします。
下部にある [保存] をクリックします。