Class Browser

ブラウザ

このクラスは、Google スプレッドシートに固有のダイアログ ボックスへのアクセスを提供します。

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

関連情報

プロパティ

プロパティタイプ説明
ButtonsButtonSet

メソッド

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

詳細なドキュメント

inputBox(prompt)

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

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

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

パラメータ

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

戻る

String|null - ユーザーが入力したテキスト（ダイアログがキャンセルまたは閉じられた場合は「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'.
const name = Browser.inputBox('Enter your name', Browser.Buttons.OK_CANCEL);
 このメソッドはおすすめできません。代わりに、UI プロンプトを使用してください。

パラメータ

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

戻る

String|null - ユーザーが入力したテキスト（ダイアログがキャンセルまたは閉じられた場合は「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'.
const name = Browser.inputBox(
    'ID Check',
    'Enter your name',
    Browser.Buttons.OK_CANCEL,
);
 このメソッドはおすすめできません。代わりに、UI プロンプトを使用してください。

パラメータ

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

戻る

String|null - ユーザーが入力したテキスト（ダイアログがキャンセルまたは閉じられた場合は「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|null - ユーザーがクリックしたボタンの小文字のテキスト（ダイアログが閉じられた場合は「cancel」）。

承認

このメソッドを使用するスクリプトには、次の 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|null - ユーザーがクリックしたボタンの小文字のテキスト（ダイアログが閉じられた場合は「cancel」）。

承認

このメソッドを使用するスクリプトには、次の 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|null - ユーザーがクリックしたボタンの小文字のテキスト（ダイアログが閉じられた場合は「cancel」）。

承認

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

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