Class Browser

ブラウザ

このクラスを使用すると、Google スプレッドシート固有のダイアログ ボックスにアクセスできます。

このクラスのメソッドは、Google スプレッドシートのコンテキストでのみ使用できます。代わりに Google Workspace ダイアログを使用してください。

関連ドキュメント

プロパティ

プロパティ種類説明
ButtonsButtonSet

Methods

メソッド戻り値の型概要
inputBox(prompt)Stringユーザーのブラウザに、テキスト入力ボックスを含むダイアログ ボックスをポップアップします。
inputBox(prompt, buttons)Stringユーザーのブラウザに、テキスト入力ボックスを含むダイアログ ボックスをポップアップします。
inputBox(title, prompt, buttons)Stringユーザーのブラウザに、テキスト入力ボックスを含むダイアログ ボックスをポップアップします。
msgBox(prompt)Stringユーザーのブラウザに、指定したメッセージと [OK] ボタンを含むダイアログ ボックスを表示します。
msgBox(prompt, buttons)Stringユーザーのブラウザに、指定したメッセージと指定したボタンを含むダイアログ ボックスをポップアップします。
msgBox(title, prompt, buttons)String指定したタイトル、メッセージ、指定したボタンを含むダイアログ ボックスをユーザーのブラウザにポップアップします。

詳細なドキュメント

inputBox(prompt)

ユーザーのブラウザに、テキスト入力ボックスを含むダイアログ ボックスを表示します。

inputBox メソッドは、指定されたプロンプトをユーザーに表示するクライアント側の入力ボックスを表示します。この関数により、サーバーサイドのスクリプトが一時停止されることに注意してください。ユーザーがダイアログをクリアすると自動的に再開されますが、中断すると JDBC 接続は維持されません。

// The code below sets the value of name to the name input by the user, or 'cancel'.
var name = Browser.inputBox('Enter your name');
この方法はおすすめしません。代わりに UI プロンプトを使用してください。

パラメータ

名前説明
promptStringダイアログ ボックスに表示されるテキスト。

リターン

String - ユーザーが入力したテキスト(キャンセルしたダイアログや閉じたダイアログの場合は「cancel」)。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

inputBox(prompt, buttons)

ユーザーのブラウザに、テキスト入力ボックスを含むダイアログ ボックスを表示します。

inputBox メソッドは、指定されたプロンプトをユーザーに表示するとともに、表示するボタンの選択肢を提供するクライアント側の入力ボックスを表示します。この関数により、サーバーサイドのスクリプトが一時停止されることに注意してください。ユーザーがダイアログをクリアすると自動的に再開しますが、停止中は JDBC 接続は維持されません。

// The code below sets the value of name to the name input by the user, or 'cancel'.
var name = Browser.inputBox('Enter your name', Browser.Buttons.OK_CANCEL);
この方法はおすすめしません。代わりに UI プロンプトを使用してください。

パラメータ

名前説明
promptStringダイアログ ボックスに表示されるテキスト。
buttonsButtonSet使用するボタンのタイプ。

リターン

String - ユーザーが入力したテキスト(キャンセルしたダイアログや閉じたダイアログの場合は「cancel」)。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

inputBox(title, prompt, buttons)

ユーザーのブラウザに、テキスト入力ボックスを含むダイアログ ボックスを表示します。

inputBox メソッドは指定されたタイトルでクライアント側の入力ボックスを表示し、指定されたプロンプトをユーザーに表示して、表示するボタンの選択肢を提供します。この関数により、サーバーサイドのスクリプトが一時停止されることに注意してください。ユーザーがダイアログをクリアすると自動的に再開しますが、停止中は JDBC 接続は維持されません。

// The code below sets the value of name to the name input by the user, or 'cancel'.
var name = Browser.inputBox('ID Check', 'Enter your name', Browser.Buttons.OK_CANCEL);
この方法はおすすめしません。代わりに UI プロンプトを使用してください。

パラメータ

名前説明
titleStringダイアログ ボックスのタイトル。
promptStringダイアログ ボックスに表示されるテキスト。
buttonsButtonSet使用するボタンのタイプ。

リターン

String - ユーザーが入力したテキスト(キャンセルしたダイアログや閉じたダイアログの場合は「cancel」)。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

msgBox(prompt)

ユーザーのブラウザに、指定したメッセージと [OK] ボタンを含むダイアログ ボックスを表示します。

msgBox メソッドは、クライアント サイドのメッセージ ボックスを表示して、指定されたメッセージをユーザーに表示します。この方法では、サーバー側のスクリプトが一時停止します。ユーザーがダイアログをクリアすると自動的に再開されますが、中断すると JDBC 接続は維持されません。

// The code below displays "hello world" in a dialog box with an OK button
Browser.msgBox('hello world');
この方法はおすすめしません。代わりに、UI アラート ダイアログを使用してください。

パラメータ

名前説明
promptStringダイアログ ボックスに表示されるテキスト。

リターン

String - ユーザーがクリックしたボタンの小文字テキスト(閉じたダイアログの場合は「キャンセル」)。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

msgBox(prompt, buttons)

ユーザーのブラウザに、指定したメッセージと指定したボタンを含むダイアログ ボックスをポップアップします。

msgBox メソッドは、クライアント サイドのメッセージ ボックスを表示して、指定されたメッセージをユーザーに表示するとともに、表示するボタンの選択肢を提供します。この方法では、サーバーサイドのスクリプトが一時停止されることに注意してください。ユーザーがダイアログをクリアすると自動的に再開しますが、停止中は JDBC 接続は維持されません。

// The code below displays "hello world" in a dialog box with OK and Cancel buttons.
Browser.msgBox('hello world', Browser.Buttons.OK_CANCEL);
この方法はおすすめしません。代わりに、UI アラート ダイアログを使用してください。

パラメータ

名前説明
promptStringダイアログ ボックスに表示されるテキスト。
buttonsButtonSet使用するボタンのタイプ。

リターン

String - ユーザーがクリックしたボタンの小文字テキスト(閉じたダイアログの場合は「キャンセル」)。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

msgBox(title, prompt, buttons)

指定したタイトル、メッセージ、指定したボタンを含むダイアログ ボックスをユーザーのブラウザにポップアップします。

msgBox メソッドは、指定されたタイトルでクライアント側のメッセージ ボックスを表示し、指定されたメッセージをユーザーに表示します。また、表示するボタンの選択肢も提示します。この方法では、サーバー側のスクリプトが一時停止されます。ユーザーがダイアログをクリアすると自動的に再開しますが、停止中は JDBC 接続は維持されません。

// The code below displays "hello world" in a dialog box with a custom title and Yes and
// No buttons
Browser.msgBox('Greetings', 'hello world', Browser.Buttons.YES_NO);
この方法はおすすめしません。代わりに、UI アラート ダイアログを使用してください。

パラメータ

名前説明
titleStringダイアログ ボックスのタイトル。
promptStringダイアログ ボックスに表示されるテキスト。
buttonsButtonSet使用するボタンのタイプ。

リターン

String - ユーザーがクリックしたボタンの小文字テキスト(閉じたダイアログの場合は「キャンセル」)。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets