データの入力規則のビルダー。
// Set the data validation for cell A1 to require a value from B1:B10. var cell = SpreadsheetApp.getActive().getRange('A1'); var range = SpreadsheetApp.getActive().getRange('B1:B10'); var rule = SpreadsheetApp.newDataValidation().requireValueInRange(range).build(); cell.setDataValidation(rule);
メソッド
詳細なドキュメント
build()
copy()
このルールの設定に基づいて、データ入力規則のビルダーを作成します。
// Change existing data validation rules that require a date in 2013 to require a date in 2014. var oldDates = [new Date('1/1/2013'), new Date('12/31/2013')]; var newDates = [new Date('1/1/2014'), new Date('12/31/2014')]; var sheet = SpreadsheetApp.getActiveSheet(); var range = sheet.getRange(1, 1, sheet.getMaxRows(), sheet.getMaxColumns()); var rules = range.getDataValidations(); for (var i = 0; i < rules.length; i++) { for (var j = 0; j < rules[i].length; j++) { var rule = rules[i][j]; if (rule != null) { var criteria = rule.getCriteriaType(); var args = rule.getCriteriaValues(); if (criteria == SpreadsheetApp.DataValidationCriteria.DATE_BETWEEN && args[0].getTime() == oldDates[0].getTime() && args[1].getTime() == oldDates[1].getTime()) { // Create a builder from the existing rule, then change the dates. rules[i][j] = rule.copy().withCriteria(criteria, newDates).build(); } } } } range.setDataValidations(rules);
戻る
DataValidationBuilder
- このルールの設定に基づくビルダー
getAllowInvalid()
入力がデータの検証で不合格だった場合にルールが警告を表示する場合は true
を返し、入力が完全に拒否された場合は false
を返します。新しいデータ入力規則のデフォルトは true
です。
戻る
Boolean
- データの検証で不合格だった入力がルールで許可されている場合は true
。含まれていない場合は false
getCriteriaType()
DataValidationCriteria
列挙型で定義されているルールの条件タイプを取得します。取得するには、
getCriteriaValues()
を使用します。これらの値を使用して
データの入力規則を変更する場合は、withCriteria(criteria, args)
をご覧ください。
// Log information about the data validation rule for cell A1. var cell = SpreadsheetApp.getActive().getRange('A1'); var rule = cell.getDataValidation(); if (rule != null) { var criteria = rule.getCriteriaType(); var args = rule.getCriteriaValues(); Logger.log('The data validation rule is %s %s', criteria, args); } else { Logger.log('The cell does not have a data validation rule.') }
戻る
DataValidationCriteria
- データ検証基準のタイプ
getCriteriaValues()
ルールの条件を表す引数の配列を取得します。条件タイプを取得するには、getCriteriaType()
を使用します。これらの値を使用してデータの入力規則を作成または変更するには、withCriteria(criteria, args)
をご覧ください。
// Log information about the data validation rule for cell A1. var cell = SpreadsheetApp.getActive().getRange('A1'); var rule = cell.getDataValidation(); if (rule != null) { var criteria = rule.getCriteriaType(); var args = rule.getCriteriaValues(); Logger.log('The data validation rule is %s %s', criteria, args); } else { Logger.log('The cell does not have a data validation rule.') }
戻る
Object[]
- ルールの条件タイプに応じた引数の配列。引数の数
かつ、その型が DataValidationBuilder
クラスの対応する require...()
メソッドと一致している
getHelpText()
ルールのヘルプテキストを取得します。ヘルプテキストが設定されていない場合は null
を取得します。
戻る
String
- ルールのヘルプテキスト。ヘルプテキストが設定されていない場合は null
。
requireCheckbox()
ブール値の入力を要求するようにデータ入力規則を設定します。この値は チェックボックスとして表示されます
// Set the data validation for cell A1 to require a boolean value; the value is rendered as a // checkbox. var cell = SpreadsheetApp.getActive().getRange('A1'); var rule = SpreadsheetApp.newDataValidation().requireCheckbox().build(); cell.setDataValidation(rule);
戻る
DataValidationBuilder
- このビルダー(チェーン用)
requireCheckbox(checkedValue)
データ入力規則を設定して、入力値が指定された値または空白になるようにします。日時 入力が指定された値と一致する場合、セルはオンのチェックボックスとしてレンダリングされます。Google 入力が空白の場合、セルはオフのチェックボックスとしてレンダリングされます。
// Set the data validation for cell A1 to require a custom checked value that is rendered as a // checkbox. var cell = SpreadsheetApp.getActive().getRange('A1'); var rule = SpreadsheetApp.newDataValidation().requireCheckbox('APPROVED').build(); cell.setDataValidation(rule);
パラメータ
名前 | 型 | 説明 |
---|---|---|
checkedValue | Object | チェックボックスがオンに割り当てられる値。 |
戻る
DataValidationBuilder
- このビルダー(チェーン用)
requireCheckbox(checkedValue, uncheckedValue)
データ入力規則を設定し、入力が指定された値のいずれかであることを必須にします。日時
入力が checkedValue
の場合、セルはオンのチェックボックスとしてレンダリングされます。Google
入力が uncheckedValue
の場合、セルはオフのチェックボックスとしてレンダリングされます。
// Set the data validation for cell A1 to require custom checked values that are rendered as a // checkbox. var cell = SpreadsheetApp.getActive().getRange('A1'); var rule = SpreadsheetApp.newDataValidation().requireCheckbox('APPROVED', 'PENDING').build(); cell.setDataValidation(rule);
パラメータ
名前 | 型 | 説明 |
---|---|---|
checkedValue | Object | チェックボックスがオンに割り当てられる値。 |
uncheckedValue | Object | オフのチェックボックスに割り当てられた値。 |
戻る
DataValidationBuilder
- このビルダー(チェーン用)
requireDate()
日付を要求するようにデータ入力規則を設定します。
// Set the data validation for cell A1 to require a date. var cell = SpreadsheetApp.getActive().getRange('A1'); var rule = SpreadsheetApp.newDataValidation().requireDate().build(); cell.setDataValidation(rule);
戻る
DataValidationBuilder
- このビルダー(チェーン用)
requireDateAfter(date)
指定した値より後の日付を要求するようにデータ入力規則を設定します。イベントの時間フィールドは、
Date
オブジェクトは無視されます。日、月、年のフィールドのみが使用されます。
// Set the data validation for cell A1 to require a date after January 1, 2013. var cell = SpreadsheetApp.getActive().getRange('A1'); var rule = SpreadsheetApp.newDataValidation().requireDateAfter(new Date('1/1/2013')).build(); cell.setDataValidation(rule);
パラメータ
名前 | 型 | 説明 |
---|---|---|
date | Date | 許可されない最新の日付です。 |
戻る
DataValidationBuilder
- このビルダー(チェーン用)
requireDateBefore(date)
指定した値より前の日付を要求するようにデータ入力規則を設定します。イベントの時間フィールドは、
Date
オブジェクトは無視されます。日、月、年のフィールドのみが使用されます。
// Set the data validation for cell A1 to require a date before January 1, 2013. var cell = SpreadsheetApp.getActive().getRange('A1'); var rule = SpreadsheetApp.newDataValidation().requireDateBefore(new Date('1/1/2013')).build(); cell.setDataValidation(rule);
パラメータ
名前 | 型 | 説明 |
---|---|---|
date | Date | 使用できない最も早い日付です。 |
戻る
DataValidationBuilder
- このビルダー(チェーン用)
requireDateBetween(start, end)
データ入力規則で、2 つの範囲、またはいずれか 2 つの日付
表示されます。Date
オブジェクトの時間フィールドは無視されます。日付、月、日、
指定する必要があります
// Set the data validation for cell A1 to require a date in 2013. var cell = SpreadsheetApp.getActive().getRange('A1'); var rule = SpreadsheetApp.newDataValidation() .requireDateBetween(new Date('1/1/2013'), new Date('12/31/2013')).build(); cell.setDataValidation(rule);
パラメータ
名前 | 型 | 説明 |
---|---|---|
start | Date | 最短の許容日。 |
end | Date | 最新の許容日。 |
戻る
DataValidationBuilder
- このビルダー(チェーン用)
requireDateEqualTo(date)
指定した値と等しい日付を必要とするデータ入力規則を設定します。時間フィールド
Date
オブジェクトは無視されます。日、月、年のフィールドのみが使用されます。
// Set the data validation for cell A1 to require a date equal to January 1, 2013. var cell = SpreadsheetApp.getActive().getRange('A1'); var rule = SpreadsheetApp.newDataValidation().requireDateEqualTo(new Date('1/1/2013')) .build(); cell.setDataValidation(rule);
パラメータ
名前 | 型 | 説明 |
---|---|---|
date | Date | 唯一の許容日。 |
戻る
DataValidationBuilder
- このビルダー(チェーン用)
requireDateNotBetween(start, end)
次の範囲になく、また、次の範囲に該当しない日付を要求するようにデータ入力規則を設定します。
日付を指定しますDate
オブジェクトの時間フィールドは無視されます。終日、
月と年のフィールドが使用されます
// Set the data validation for cell A1 to require a date not in 2013. var cell = SpreadsheetApp.getActive().getRange('A1'); var rule = SpreadsheetApp.newDataValidation() .requireDateNotBetween(new Date('1/1/2013'), new Date('12/31/2013')).build(); cell.setDataValidation(rule);
パラメータ
名前 | 型 | 説明 |
---|---|---|
start | Date | 使用できない最も早い日付です。 |
end | Date | 許可されない最新の日付です。 |
戻る
DataValidationBuilder
- このビルダー(チェーン用)
requireDateOnOrAfter(date)
指定した値以降の日付を要求するデータ入力規則を設定します。時間フィールド
Date
オブジェクトは無視されます。日、月、年のフィールドのみが使用されます。
// Set the data validation for cell A1 to require a date on or after January 1, 2013. var cell = SpreadsheetApp.getActive().getRange('A1'); var rule = SpreadsheetApp.newDataValidation() .requireDateOnOrAfter(new Date('1/1/2013')).build(); cell.setDataValidation(rule);
パラメータ
名前 | 型 | 説明 |
---|---|---|
date | Date | 最短の許容日。 |
戻る
DataValidationBuilder
- このビルダー(チェーン用)
requireDateOnOrBefore(date)
指定した値以前の日付を要求するようにデータ入力規則を設定します。時間フィールド
Date
オブジェクトのすべての要素は無視されます。日、月、年のフィールドのみが使用されます。
// Set the data validation for cell A1 to require a date on or before January 1, 2013. var cell = SpreadsheetApp.getActive().getRange('A1'); var rule = SpreadsheetApp.newDataValidation() .requireDateOnOrBefore(new Date('1/1/2013')).build(); cell.setDataValidation(rule);
パラメータ
名前 | 型 | 説明 |
---|---|---|
date | Date | 最新の許容日。 |
戻る
DataValidationBuilder
- このビルダー(チェーン用)
requireFormulaSatisfied(formula)
指定された数式が true
と評価されることを要求するようにデータ入力規則を設定します。
// Set the data validation for cell A1 to equal B1 with a custom formula. var cell = SpreadsheetApp.getActive().getRange('A1'); var rule = SpreadsheetApp.newDataValidation().requireFormulaSatisfied('=EQ(A1,B1)').build(); cell.setDataValidation(rule);
パラメータ
名前 | 型 | 説明 |
---|---|---|
formula | String | 入力が有効な場合に true と評価されるカスタム数式。 |
戻る
DataValidationBuilder
- このビルダー(チェーン用)
requireNumberBetween(start, end)
2 つの範囲かいずれかに該当する数値を要求するようにデータ入力規則を設定します 表します。
// Set the data validation for cell A1 to require a number between 1 and 10. var cell = SpreadsheetApp.getActive().getRange('A1'); var rule = SpreadsheetApp.newDataValidation().requireNumberBetween(1, 10).build(); cell.setDataValidation(rule);
パラメータ
名前 | 型 | 説明 |
---|---|---|
start | Number | 許容される最小値。 |
end | Number | 許容される最大値。 |
戻る
DataValidationBuilder
- このビルダー(チェーン用)
requireNumberEqualTo(number)
指定した値と等しい数値を要求するデータ入力規則を設定します。
// Set the data validation for cell A1 to require a number equal to 3.1415926536. var cell = SpreadsheetApp.getActive().getRange('A1'); var rule = SpreadsheetApp.newDataValidation().requireNumberEqualTo(3.1415926536).build(); cell.setDataValidation(rule);
パラメータ
名前 | 型 | 説明 |
---|---|---|
number | Number | 唯一の許容値。 |
戻る
DataValidationBuilder
- このビルダー(チェーン用)
requireNumberGreaterThan(number)
指定した値より大きい数値を要求するデータ入力規則を設定します。
// Set the data validation for cell A1 to require a number greater than 0. var cell = SpreadsheetApp.getActive().getRange('A1'); var rule = SpreadsheetApp.newDataValidation().requireNumberGreaterThan(0).build(); cell.setDataValidation(rule);
パラメータ
名前 | 型 | 説明 |
---|---|---|
number | Number | 許容できない最大値。 |
戻る
DataValidationBuilder
- このビルダー(チェーン用)
requireNumberGreaterThanOrEqualTo(number)
指定した値以上の数値を要求するデータ入力規則を設定します。
// Set the data validation for cell A1 to require a number greater than or equal to 0. var cell = SpreadsheetApp.getActive().getRange('A1'); var rule = SpreadsheetApp.newDataValidation().requireNumberGreaterThanOrEqualTo(0).build(); cell.setDataValidation(rule);
パラメータ
名前 | 型 | 説明 |
---|---|---|
number | Number | 許容される最小値。 |
戻る
DataValidationBuilder
- このビルダー(チェーン用)
requireNumberLessThan(number)
指定した値より小さい数値を要求するデータ入力規則を設定します。
// Set the data validation for cell A1 to require a number less than 0. var cell = SpreadsheetApp.getActive().getRange('A1'); var rule = SpreadsheetApp.newDataValidation().requireNumberLessThan(0).build(); cell.setDataValidation(rule);
パラメータ
名前 | 型 | 説明 |
---|---|---|
number | Number | 許可されない最小値。 |
戻る
DataValidationBuilder
- このビルダー(チェーン用)
requireNumberLessThanOrEqualTo(number)
指定した値以下の数値を要求するデータ入力規則を設定します。
// Set the data validation for cell A1 to require a number less than or equal to 0. var cell = SpreadsheetApp.getActive().getRange('A1'); var rule = SpreadsheetApp.newDataValidation().requireNumberLessThanOrEqualTo(0).build(); cell.setDataValidation(rule);
パラメータ
名前 | 型 | 説明 |
---|---|---|
number | Number | 許容される最大値。 |
戻る
DataValidationBuilder
- このビルダー(チェーン用)
requireNumberNotBetween(start, end)
範囲に含まれず、かついずれも該当しない数値を要求するようにデータ入力規則を設定します 計算します。
// Set the data validation for cell A1 to require a number not between 1 and 10. var cell = SpreadsheetApp.getActive().getRange('A1'); var rule = SpreadsheetApp.newDataValidation().requireNumberNotBetween(1, 10).build(); cell.setDataValidation(rule);
パラメータ
名前 | 型 | 説明 |
---|---|---|
start | Number | 許可されない最小値。 |
end | Number | 許容できない最大値。 |
戻る
DataValidationBuilder
- このビルダー(チェーン用)
requireNumberNotEqualTo(number)
指定した値と等しくない数値を要求するようにデータ入力規則を設定します。
// Set the data validation for cell A1 to require a number not equal to 0. var cell = SpreadsheetApp.getActive().getRange('A1'); var rule = SpreadsheetApp.newDataValidation().requireNumberNotEqualTo(0).build(); cell.setDataValidation(rule);
パラメータ
名前 | 型 | 説明 |
---|---|---|
number | Number | 許可されない唯一の値です。 |
戻る
DataValidationBuilder
- このビルダー(チェーン用)
requireTextContains(text)
指定した値が入力に含まれていることを必須とするデータ入力規則を設定します。
// Set the data validation for cell A1 to require any value that includes "Google". var cell = SpreadsheetApp.getActive().getRange('A1'); var rule = SpreadsheetApp.newDataValidation().requireTextContains('Google').build(); cell.setDataValidation(rule);
パラメータ
名前 | 型 | 説明 |
---|---|---|
text | String | 入力に含める必要がある値。 |
戻る
DataValidationBuilder
- このビルダー(チェーン用)
requireTextDoesNotContain(text)
指定した値が入力に含まれていないことを必須とするデータ入力規則を設定します。
// Set the data validation for cell A1 to require any value that does not include "@". var cell = SpreadsheetApp.getActive().getRange('A1'); var rule = SpreadsheetApp.newDataValidation().requireTextDoesNotContain('@').build(); cell.setDataValidation(rule);
パラメータ
名前 | 型 | 説明 |
---|---|---|
text | String | 入力に含めてはならない値。 |
戻る
DataValidationBuilder
- このビルダー(チェーン用)
requireTextEqualTo(text)
指定した値と入力が等しいことを必須とするデータ入力規則を設定します。
// Set the data validation for cell A1 to require "Yes". var cell = SpreadsheetApp.getActive().getRange('A1'); var rule = SpreadsheetApp.newDataValidation().requireTextEqualTo('Yes').build(); cell.setDataValidation(rule);
パラメータ
名前 | 型 | 説明 |
---|---|---|
text | String | 唯一の許容値。 |
戻る
DataValidationBuilder
- このビルダー(チェーン用)
requireTextIsEmail()
メールアドレスでの入力を要求するようにデータ入力規則を設定します。
// Set the data validation for cell A1 to require text in the form of an email address. var cell = SpreadsheetApp.getActive().getRange('A1'); var rule = SpreadsheetApp.newDataValidation().requireTextIsEmail().build(); cell.setDataValidation(rule);
戻る
DataValidationBuilder
- このビルダー(チェーン用)
requireTextIsUrl()
URL 形式での入力を要求するようにデータ入力規則を設定します。
// Set the data validation for cell A1 to require text in the form of a URL. var cell = SpreadsheetApp.getActive().getRange('A1'); var rule = SpreadsheetApp.newDataValidation().requireTextIsUrl().build(); cell.setDataValidation(rule);
戻る
DataValidationBuilder
- このビルダー(チェーン用)
requireValueInList(values)
データ入力規則を設定し、入力が指定された値のいずれかに等しいことを必須にします。
// Set the data validation for cell A1 to require "Yes" or "No", with a dropdown menu. var cell = SpreadsheetApp.getActive().getRange('A1'); var rule = SpreadsheetApp.newDataValidation().requireValueInList(['Yes', 'No']).build(); cell.setDataValidation(rule);
パラメータ
名前 | 型 | 説明 |
---|---|---|
values | String[] | 使用可能な値の配列。 |
戻る
DataValidationBuilder
- このビルダー(チェーン用)
requireValueInList(values, showDropdown)
入力が指定された値のいずれかと等しいことを必須とするデータ入力規則を設定します。 プルダウンメニューを非表示にできます
// Set the data validation for cell A1 to require "Yes" or "No", with no dropdown menu. var cell = SpreadsheetApp.getActive().getRange('A1'); var rule = SpreadsheetApp.newDataValidation().requireValueInList(['Yes', 'No'], false).build(); cell.setDataValidation(rule);
パラメータ
名前 | 型 | 説明 |
---|---|---|
values | String[] | 使用可能な値の配列。 |
showDropdown | Boolean | スプレッドシートに値のプルダウン メニューを表示する場合は true 、
そうでない場合は false 。 |
戻る
DataValidationBuilder
- このビルダー(チェーン用)
requireValueInRange(range)
入力が指定した範囲内の値と等しいことを必須とするデータ入力規則を設定します。
// Set the data validation for cell A1 to require a value from B1:B10, with a dropdown menu. var cell = SpreadsheetApp.getActive().getRange('A1'); var range = SpreadsheetApp.getActive().getRange('B1:B10'); var rule = SpreadsheetApp.newDataValidation().requireValueInRange(range).build(); cell.setDataValidation(rule);
パラメータ
名前 | 型 | 説明 |
---|---|---|
range | Range | 許容される値を含む範囲。 |
戻る
DataValidationBuilder
- このビルダー(チェーン用)
requireValueInRange(range, showDropdown)
入力が指定した範囲内の値と等しいことを必須とするデータ入力規則を設定します。 プルダウンメニューを非表示にできます
// Set the data validation for cell A1 to require value from B1:B10, with no dropdown menu. var cell = SpreadsheetApp.getActive().getRange('A1'); var range = SpreadsheetApp.getActive().getRange('B1:B10'); var rule = SpreadsheetApp.newDataValidation().requireValueInRange(range, false).build(); cell.setDataValidation(rule);
パラメータ
名前 | 型 | 説明 |
---|---|---|
range | Range | 許容される値を含む範囲。 |
showDropdown | Boolean | スプレッドシートに値のプルダウン メニューを表示する場合は true 、
そうでない場合は false 。 |
戻る
DataValidationBuilder
- このビルダー(チェーン用)
setAllowInvalid(allowInvalidData)
入力がデータ検証で不合格だった場合に警告を表示するかどうか、または入力を拒否するかどうかを設定します
提供します新しいデータ入力規則のデフォルトは true
です。
パラメータ
名前 | 型 | 説明 |
---|---|---|
allowInvalidData | Boolean | データの検証で不合格だった入力をルールで許可する場合は true 。
そうでない場合は false 。 |
戻る
DataValidationBuilder
- このビルダー(チェーン用)
setHelpText(helpText)
データの入力規則を適用するセルにユーザーがカーソルを合わせたときに表示されるヘルプテキストを設定します。 あります。
パラメータ
名前 | 型 | 説明 |
---|---|---|
helpText | String | 設定するヘルプテキスト。 |
戻る
DataValidationBuilder
- このビルダー(チェーン用)
withCriteria(criteria, args)
データの入力規則を DataValidationCriteria
値で定義された条件に設定します。
通常は既存のルールの criteria
と arguments
から取得されます。
// Change existing data validation rules that require a date in 2013 to require a date in 2014. var oldDates = [new Date('1/1/2013'), new Date('12/31/2013')]; var newDates = [new Date('1/1/2014'), new Date('12/31/2014')]; var sheet = SpreadsheetApp.getActiveSheet(); var range = sheet.getRange(1, 1, sheet.getMaxRows(), sheet.getMaxColumns()); var rules = range.getDataValidations(); for (var i = 0; i < rules.length; i++) { for (var j = 0; j < rules[i].length; j++) { var rule = rules[i][j]; if (rule != null) { var criteria = rule.getCriteriaType(); var args = rule.getCriteriaValues(); if (criteria == SpreadsheetApp.DataValidationCriteria.DATE_BETWEEN && args[0].getTime() == oldDates[0].getTime() && args[1].getTime() == oldDates[1].getTime()) { // Create a builder from the existing rule, then change the dates. rules[i][j] = rule.copy().withCriteria(criteria, newDates).build(); } } } } range.setDataValidations(rules);
パラメータ
名前 | 型 | 説明 |
---|---|---|
criteria | DataValidationCriteria | データの検証基準のタイプ。 |
args | Object[] | 条件タイプに応じた引数の配列。使用できる引数の数と、
その型は、上記の対応する require...() メソッドと一致します。 |
戻る
DataValidationBuilder
- このビルダー(チェーン用)