Google アプリのユーザー インターフェース環境のインスタンスで、スクリプトでメニュー、ダイアログ、サイドバーなどの機能を追加できます。スクリプトは、開いているエディタの現在のインスタンスの UI のみを操作できます。また、スクリプトがエディタにコンテナ結合されている場合に限られます。
// Display a dialog box with a title, message, input field, and "Yes" and "No" // buttons. The user can also close the dialog by clicking the close button in // its title bar. const ui = SpreadsheetApp.getUi(); const response = ui.prompt( 'Getting to know you', 'May I know your name?', ui.ButtonSet.YES_NO, ); // Process the user's response. if (response.getSelectedButton() === ui.Button.YES) { Logger.log('The user\'s name is %s.', response.getResponseText()); } else if (response.getSelectedButton() === ui.Button.NO) { Logger.log('The user didn\'t want to provide a name.'); } else { Logger.log('The user clicked the close button in the dialog\'s title bar.'); }
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
Button | Button | アラートまたは Prompt によって返される、事前定義されたローカライズされたダイアログ ボタンを表す列挙型。ユーザーがダイアログ内のどのボタンをクリックしたかを示します。 |
Button | Button | アラートまたはプロンプトに追加できる、事前定義されたローカライズされた 1 つ以上のダイアログ ボタンのセットを表現する列挙型。 |
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
alert(prompt) | Button | 指定されたメッセージと [OK] ボタンを含むダイアログ ボックスがユーザーのエディタで開きます。 |
alert(prompt, buttons) | Button | 指定されたメッセージとボタンのセットが含まれるダイアログ ボックスをユーザーのエディタで開きます。 |
alert(title, prompt, buttons) | Button | 指定されたタイトル、メッセージ、ボタンのセットで、ユーザーのエディタにダイアログ ボックスを開きます。 |
create | Menu | エディタの [Extensions] メニューにサブメニューを挿入するために使用できるビルダーを作成します。 |
create | Menu | エディタのユーザー インターフェースにメニューを追加するために使用できるビルダーを作成します。 |
prompt(prompt) | Prompt | 指定されたメッセージと [OK] ボタンを含む入力ダイアログ ボックスがユーザーのエディタで開きます。 |
prompt(prompt, buttons) | Prompt | 指定されたメッセージとボタンのセットで、ユーザーのエディタに入力ダイアログ ボックスを開きます。 |
prompt(title, prompt, buttons) | Prompt | 指定されたタイトル、メッセージ、ボタンのセットで、ユーザーのエディタに入力ダイアログ ボックスを開きます。 |
show | void | カスタムのクライアントサイド コンテンツを含むモーダル ダイアログ ボックスがユーザーのエディタで開きます。 |
show | void | ユーザーのエディタに、カスタムのクライアントサイド コンテンツを含むモーダルのないダイアログ ボックスを開きます。 |
show | void | ユーザーのエディタに、カスタムのクライアントサイド コンテンツを含むサイドバーが開きます。 |
詳細なドキュメント
alert(prompt)
指定されたメッセージと [OK] ボタンを含むダイアログ ボックスがユーザーのエディタで開きます。このメソッドは、ダイアログが開いている間、サーバーサイド スクリプトを一時停止します。ユーザーがダイアログを閉じるとスクリプトが再開されますが、Jdbc
接続と Lock
ロックは停止中も保持されません。詳しくは、ダイアログとサイドバーのガイドをご覧ください。
// Display "Hello, world" in a dialog box with an "OK" button. The user can also // close the dialog by clicking the close button in its title bar. SpreadsheetApp.getUi().alert('Hello, world');
パラメータ
名前 | 型 | 説明 |
---|---|---|
prompt | String | ダイアログ ボックスに表示するメッセージ。 |
戻る
Button
- ユーザーがクリックしたボタン。
alert(prompt, buttons)
指定されたメッセージとボタンのセットが含まれるダイアログ ボックスがユーザーのエディタで開きます。このメソッドは、ダイアログが開いている間、サーバーサイド スクリプトを一時停止します。ユーザーがダイアログを閉じるとスクリプトが再開されますが、Jdbc
接続と Lock
ロックは停止中も保持されません。詳しくは、ダイアログとサイドバーのガイドをご覧ください。
// Display a dialog box with a message and "Yes" and "No" buttons. The user can // also close the dialog by clicking the close button in its title bar. const ui = SpreadsheetApp.getUi(); const response = ui.alert( 'Are you sure you want to continue?', ui.ButtonSet.YES_NO, ); // Process the user's response. if (response === ui.Button.YES) { Logger.log('The user clicked "Yes."'); } else { Logger.log( 'The user clicked "No" or the close button in the dialog\'s title bar.', ); }
パラメータ
名前 | 型 | 説明 |
---|---|---|
prompt | String | ダイアログ ボックスに表示するメッセージ。 |
buttons | Button | ダイアログ ボックスに表示されるボタン。 |
戻る
Button
- ユーザーがクリックしたボタン。
alert(title, prompt, buttons)
指定されたタイトル、メッセージ、ボタンのセットで、ユーザーのエディタにダイアログ ボックスを開きます。このメソッドは、ダイアログが開いている間、サーバーサイド スクリプトを一時停止します。ユーザーがダイアログを閉じるとスクリプトが再開されますが、Jdbc
接続と Lock
ロックは停止中に保持されません。詳しくは、ダイアログとサイドバーのガイドをご覧ください。
// Display a dialog box with a title, message, and "Yes" and "No" buttons. The // user can also close the dialog by clicking the close button in its title bar. const ui = SpreadsheetApp.getUi(); const response = ui.alert( 'Confirm', 'Are you sure you want to continue?', ui.ButtonSet.YES_NO, ); // Process the user's response. if (response === ui.Button.YES) { Logger.log('The user clicked "Yes."'); } else { Logger.log( 'The user clicked "No" or the close button in the dialog\'s title bar.', ); }
パラメータ
名前 | 型 | 説明 |
---|---|---|
title | String | ダイアログ ボックスの上に表示するタイトル。 |
prompt | String | ダイアログ ボックスに表示するメッセージ。 |
buttons | Button | ダイアログ ボックスに表示されるボタン。 |
戻る
Button
- ユーザーがクリックしたボタン。
create Addon Menu()
エディタの [Extensions] メニューにサブメニューを挿入するために使用できるビルダーを作成します。メニューは、Menu.addToUi()
が呼び出されるまでは実際に更新されません。スクリプトがアドオンとして実行されている場合、サブメニュー名はウェブストア内のアドオンの名前と一致します。スクリプトがドキュメントに直接バインドされている場合、サブメニュー名はスクリプトの名前と一致します。詳しくは、メニューのガイドをご覧ください。
// Add an item to the Add-on menu, under a sub-menu whose name is set // automatically. function onOpen(e) { SpreadsheetApp.getUi() .createAddonMenu() .addItem('Show', 'showSidebar') .addToUi(); }
戻る
Menu
- 新しいメニュー ビルダー。
create Menu(caption)
エディタのユーザー インターフェースにメニューを追加するために使用できるビルダーを作成します。メニューは、Menu.addToUi()
が呼び出されるまでは実際には追加されません。詳しくは、メニューのガイドをご覧ください。最上位メニューのラベルは見出しの語頭を大文字にする必要があります(すべての主要な単語を大文字にします)。サブメニューのラベルは最初の語頭を大文字にする必要があります(最初の単語のみを大文字にします)。スクリプトがアドオンとして公開されている場合、caption
パラメータは無視され、メニューは create
と同様に拡張機能メニューのサブメニューとして追加されます。
// Add a custom menu to the active document, including a separator and a // sub-menu. function onOpen(e) { SpreadsheetApp.getUi() .createMenu('My Menu') .addItem('My menu item', 'myFunction') .addSeparator() .addSubMenu( SpreadsheetApp.getUi() .createMenu('My sub-menu') .addItem('One sub-menu item', 'mySecondFunction') .addItem('Another sub-menu item', 'myThirdFunction'), ) .addToUi(); }
パラメータ
名前 | 型 | 説明 |
---|---|---|
caption | String | メニューのラベル。トップレベル メニューの場合はすべての主要な単語が大文字で、サブメニューの場合は最初の単語のみが大文字になります。 |
戻る
Menu
- 新しいメニュー ビルダー。
prompt(prompt)
指定されたメッセージと [OK] ボタンを含む入力ダイアログ ボックスがユーザーのエディタで開きます。このメソッドは、ダイアログが開いている間、サーバーサイド スクリプトを一時停止します。ユーザーがダイアログを閉じるとスクリプトが再開されますが、Jdbc
接続と Lock
ロックは停止中に保持されません。詳しくは、ダイアログとサイドバーのガイドをご覧ください。
// Display a dialog box with a message, input field, and an "OK" button. The // user can also close the dialog by clicking the close button in its title bar. const ui = SpreadsheetApp.getUi(); const response = ui.prompt('Enter your name:'); // Process the user's response. if (response.getSelectedButton() === ui.Button.OK) { Logger.log('The user\'s name is %s.', response.getResponseText()); } else { Logger.log('The user clicked the close button in the dialog\'s title bar.'); }
パラメータ
名前 | 型 | 説明 |
---|---|---|
prompt | String | ダイアログ ボックスに表示するメッセージ。 |
戻る
Prompt
- ユーザーの回答を表します。
prompt(prompt, buttons)
指定されたメッセージとボタンのセットで、ユーザーのエディタに入力ダイアログ ボックスを開きます。このメソッドは、ダイアログが開いている間、サーバーサイド スクリプトを一時停止します。ユーザーがダイアログを閉じるとスクリプトが再開されますが、Jdbc
接続と Lock
ロックは停止中に保持されません。詳しくは、ダイアログとサイドバーのガイドをご覧ください。
// Display a dialog box with a message, input field, and "Yes" and "No" buttons. // The user can also close the dialog by clicking the close button in its title // bar. const ui = SpreadsheetApp.getUi(); const response = ui.prompt('May I know your name?', ui.ButtonSet.YES_NO); // Process the user's response. if (response.getSelectedButton() === ui.Button.YES) { Logger.log('The user\'s name is %s.', response.getResponseText()); } else if (response.getSelectedButton() === ui.Button.NO) { Logger.log('The user didn\'t want to provide a name.'); } else { Logger.log('The user clicked the close button in the dialog\'s title bar.'); }
パラメータ
名前 | 型 | 説明 |
---|---|---|
prompt | String | ダイアログ ボックスに表示するメッセージ。 |
buttons | Button | ダイアログ ボックスに表示されるボタン。 |
戻る
Prompt
- ユーザーの回答を表します。
prompt(title, prompt, buttons)
指定されたタイトル、メッセージ、ボタンのセットで、ユーザーのエディタに入力ダイアログ ボックスを開きます。このメソッドは、ダイアログが開いている間、サーバーサイド スクリプトを停止します。ユーザーがダイアログを閉じるとスクリプトが再開されますが、Jdbc
接続と Lock
ロックは停止中に保持されません。詳しくは、ダイアログとサイドバーのガイドをご覧ください。
// Display a dialog box with a title, message, input field, and "Yes" and "No" // buttons. The user can also close the dialog by clicking the close button in // its title bar. const ui = SpreadsheetApp.getUi(); const response = ui.prompt( 'Getting to know you', 'May I know your name?', ui.ButtonSet.YES_NO, ); // Process the user's response. if (response.getSelectedButton() === ui.Button.YES) { Logger.log('The user\'s name is %s.', response.getResponseText()); } else if (response.getSelectedButton() === ui.Button.NO) { Logger.log('The user didn\'t want to provide a name.'); } else { Logger.log('The user clicked the close button in the dialog\'s title bar.'); }
パラメータ
名前 | 型 | 説明 |
---|---|---|
title | String | ダイアログ ボックスの上に表示するタイトル。 |
prompt | String | ダイアログ ボックスに表示するメッセージ。 |
buttons | Button | ダイアログ ボックスに表示されるボタン。 |
戻る
Prompt
- ユーザーの回答を表します。
show Modal Dialog(userInterface, title)
ユーザーのエディタに、カスタムのクライアントサイド コンテンツを含むモーダル ダイアログ ボックスを開きます。この方法では、ダイアログが開いている間、サーバーサイド スクリプトは停止されません。サーバーサイド スクリプトと通信するには、クライアントサイド コンポーネントが Html
の google.script
API を使用して非同期コールバックを行う必要があります。ダイアログをプログラムで閉じるには、Html
ウェブアプリのクライアントサイドで
google.script.host.close()
を呼び出します。詳しくは、ダイアログとサイドバーのガイドをご覧ください。
モーダル ダイアログでは、ユーザーはダイアログ以外の操作を行えません。一方、モードレス ダイアログとサイドバーでは、ユーザーがエディタとやり取りできます。ほとんどの場合、モードレス ダイアログよりもモーダル ダイアログまたはサイドバーの方が適しています。
// Display a modal dialog box with custom HtmlService content. const htmlOutput = HtmlService .createHtmlOutput( '<p>A change of speed, a change of style...</p>', ) .setWidth(250) .setHeight(300); SpreadsheetApp.getUi().showModalDialog(htmlOutput, 'My add-on');
パラメータ
名前 | 型 | 説明 |
---|---|---|
user | Object | 表示するインターフェースを表す Html 。 |
title | String | ダイアログのタイトル。user オブジェクトで set を呼び出して設定されたタイトルをオーバーライドします。 |
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/script.container.ui
show Modeless Dialog(userInterface, title)
ユーザーのエディタに、カスタムのクライアントサイド コンテンツを含むモーダルのないダイアログ ボックスを開きます。この方法では、ダイアログが開いている間、サーバーサイド スクリプトは停止されません。サーバーサイド スクリプトと通信するには、クライアントサイド コンポーネントが Html
の google.script
API を使用して非同期コールバックを行う必要があります。ダイアログをプログラムで閉じるには、Html
ウェブアプリのクライアントサイドで
google.script.host.close()
を呼び出します。詳しくは、ダイアログとサイドバーのガイドをご覧ください。
モードレス ダイアログでは、ユーザーはダイアログの背後にあるエディタとやり取りできます。一方、モーダル ダイアログはそうではありません。ほとんどの場合、モードレス ダイアログよりもモーダル ダイアログまたはサイドバーのほうが適しています。
// Display a modeless dialog box with custom HtmlService content. const htmlOutput = HtmlService .createHtmlOutput( '<p>A change of speed, a change of style...</p>', ) .setWidth(250) .setHeight(300); SpreadsheetApp.getUi().showModelessDialog(htmlOutput, 'My add-on');
パラメータ
名前 | 型 | 説明 |
---|---|---|
user | Object | 表示するインターフェースを表す Html 。 |
title | String | ダイアログのタイトル。user オブジェクトで set を呼び出して設定されたタイトルをオーバーライドします。 |
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/script.container.ui
show Sidebar(userInterface)
ユーザーのエディタに、カスタムのクライアントサイド コンテンツを含むサイドバーが開きます。この方法では、サイドバーが開いている間、サーバーサイド スクリプトは停止されません。サーバーサイド スクリプトと通信するには、クライアントサイド コンポーネントが Html
の google.script
API を使用して非同期コールバックを行う必要があります。サイドバーをプログラムで閉じるには、Html
ウェブアプリのクライアントサイドで
google.script.host.close()
を呼び出します。詳しくは、ダイアログとサイドバーのガイドをご覧ください。
サイドバーは、環境で左から右の言語を使用しているユーザーの場合はエディタの右側に、右から左の言語を使用しているユーザーの場合はエディタの左側に表示されます。スクリプトによって表示されるサイドバーはすべて、幅 300 ピクセルです。
// Display a sidebar with custom HtmlService content. const htmlOutput = HtmlService .createHtmlOutput( '<p>A change of speed, a change of style...</p>', ) .setTitle('My add-on'); SpreadsheetApp.getUi().showSidebar(htmlOutput);
パラメータ
名前 | 型 | 説明 |
---|---|---|
user | Object | 表示するインターフェースを表す Html 。 |
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/script.container.ui