Google ドキュメント、スプレッドシート、フォームにバインドされたスクリプトは、数種類のユーザー インターフェース要素を表示できます。これには、事前構築済みのアラートとプロンプト、カスタム HTML サービス ページを含むダイアログやサイドバーなどがあります。通常、これらの要素はメニュー項目から開きます。(Google フォームでは、ユーザー インターフェース要素は、フォームを開いて変更を行う編集者にのみ表示され、フォームを開いて回答するユーザーには表示されません)。
アラート ダイアログ
アラートは、Google ドキュメント、スプレッドシート、スライド、フォームのエディタ内で開く、あらかじめ用意されたダイアログ ボックスです。メッセージと [OK] ボタンが表示されます。タイトルと代替ボタンは省略可能です。これは、ウェブブラウザ内のクライアントサイドの JavaScript で window.alert()
を呼び出すことに似ています。
ダイアログが開いている間は、アラートによりサーバー側スクリプトが停止します。ユーザーがダイアログを閉じるとスクリプトが再開されますが、停止後も JDBC 接続は保持されません。
以下の例に示すように、Google ドキュメント、フォーム、スライド、スプレッドシートはすべて、Ui.alert()
メソッドを使用します。このメソッドには 3 つのバリアントがあります。デフォルトの [OK] ボタンをオーバーライドするには、buttons
引数として Ui.ButtonSet
列挙型の値を渡します。ユーザーがクリックしたボタンを評価するには、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 ドキュメント、Google フォーム、Google スライド、Google スプレッドシートはすべて、Ui.prompt()
メソッドを使用します。このメソッドには 3 つのバージョンがあります。デフォルトの [OK] ボタンをオーバーライドするには、buttons
引数として Ui.ButtonSet
列挙型の値を渡します。ユーザーのレスポンスを評価するには、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 プロジェクトを使用していることを確認します。
- Google Cloud プロジェクトで「Google Picker API」を有効にします。
- Google Cloud プロジェクトがまだ開いている状態で、[API とサービス] を選択し、[認証情報] をクリックします。
- [認証情報を作成] > [API キー] をクリックします。この操作によりキーが作成されますが、キーを編集してアプリケーションの制限と API の制限の両方をキーに追加する必要があります。
- [API キー] ダイアログで [閉じる] をクリックします。
- 作成した API キーの横にあるその他アイコン > [API キーを編集] をクリックします。
[アプリケーションの制限] で、次の手順を行います。
- [HTTP リファラー(ウェブサイト)] を選択します。
- [ウェブサイトの制限] で [項目を追加] をクリックします。
- [参照 URL] をクリックして、「
*.google.com
」と入力します。 - 別のアイテムを追加し、参照 URL として「
*.googleusercontent.com
」と入力します。 - [完了] をクリックします。
[API の制限] で、次の操作を行います。
- [キーを制限] を選択します。
[API を選択] セクションで [Google Picker API] を選択し、[OK] をクリックします。
注: Google Picker API は、有効にしない限り表示されません。Cloud プロジェクトで有効になっている API のみがリストに表示されるためです。
[API キー] で、[クリップボードにコピー] をクリックします。
下部にある [保存] をクリックします。