【GAS】スプレッドシートの条件付き書式機能まとめ【サンプルソース付】

GAS開発者向けにスプレッドシートの条件付き書式機能をすべてまとめました。

セルの背景色やフォントをデータの条件によって自由自在に変えられれば、データも格段に見やすくなりますね。

GASで指定できる条件はたくさんあります。空白、日付、数値、数式、などなど。グラデーション設定なんかもできます。

全部まとめたら随分と長くなってしまいましたが。。。自分に必要な条件に絞って参考にしてください。

ちなみに、枠線が追加されるのはいつになるのでしょうか。。。いつか追加していただけることを期待しています。追加されたら反映したいと思います。

条件付き書式に関するメソッドをすべて載せてます。少しでも参考になれば幸いです。

Google Apps Script スプレッドシート基礎リファレンス
シートクラス[Sheet]の条件付き書式設定
1. 条件付き書式の設定[setConditionalFormatRules(ルール)]
シートクラス[Sheet]の条件付き書式取得
1. 条件付き書式の取得[getConditionalFormatRules()]
スプレッドシートAPPクラス[SpreadsheetApp]の条件付き書式作成
1. 条件付き書式作成[newConditionalFormatRule()]
条件付き書式クラス[ConditionalFormatRule]
条件付き書式ビルダークラス[ConditionalFormatRuleBuilder]
ブール値基準列挙型[BooleanCriteria]
最後に

Google Apps Script スプレッドシート基礎リファレンス

当ページは、GAS公式リファレンスを元にスプレッドシートの機能毎にまとめた基礎的な内容となっております。

若干、文言がおかしい可能性がありますが、あらかじめご了承ください。

GAS基本メソッドまとめ一覧はコチラ↓↓↓です。スプレッドシートの基本的な機能をまとめてますので、ぜひご活用ください。

【GAS】スプレッドシート基本メソッドまとめ一覧【初心者入門】

GAS開発者向けにスプレッドシートの基本的なメソッドを一覧にまとめました。各機能ごとのクラス、メソッドごとのサンプルソース付ページへリンクする一覧です。初心者にとって、スプレッドシートの基本的な操作・機能単位のメソッドを知...

まずは実際に動かしてみることをオススメします。マクロの登録方法は以下を参照いただければと思います。

【GAS】Googleスプレッドシートでマクロの使い方入門【動画付】

Googleの「Google Apps Script」通称GAS。GoogleマップやGメールなど、いろんなGoogle関連のサービスと自由に連携できたり、独自のWebアプリを開発することもできる、いろんな可能性を秘めたワクワクの...

GASの本はまだまだ少ないですね。基礎レベルであれば、以下の参考書が初心者にはベストの本です。

基本的な仕様やよく使われる機能の設定方法がまとまっています。

リンク

※JavaScriptの知識が既にある程度ある人にとっては冗長かもしれません。

シートクラス[Sheet]の条件付き書式設定

シートの条件付き書式設定メソッドです。

条件付き書式の設定[setConditionalFormatRules(ルール)]

setConditionalFormatRules(rules)
シート内に現在存在するすべての条件付き書式規則を入力規則に置き換えます。ルールは入力順に評価されます。

function setConditionalFormatRules1Sample() {
  // 既存の条件付き書式規則の1つを削除します。
  var sheet = SpreadsheetApp.getActiveSheet();
  var rules = sheet.getConditionalFormatRules();
  rules.splice(0, 1); // 2番目のフォーマット規則を削除します。
  sheet.setConditionalFormatRules(rules);
}

Parameters
名前	タイプ	説明
rules	ConditionalFormatRule[]	新しい条件付き書式の規則。

シートクラス[Sheet]の条件付き書式取得

シートの条件付き書式取得メソッドです。

条件付き書式の取得[getConditionalFormatRules()]

getConditionalFormatRules()
シートのすべての条件付き書式規則を取得します。

function getConditionalFormatRules1Sample() {
  // シートの最初の条件付き書式ルールの各範囲をログに記録します。
  var rule = SpreadsheetApp.getActiveSheet().getConditionalFormatRules()[0];
  var ranges = rule.getRanges();
  for (var i = 0; i < ranges.length; i++) {
    Logger.log(ranges[i].getA1Notation());
  }
}

function getConditionalFormatRules2Sample() {
  // シートの最初の条件付き書式ルールの各範囲をログに記録します。
  var rules = SpreadsheetApp.getActiveSheet().getConditionalFormatRules();
  Logger.log(rules.length);
  for (var i = 0; i < rules.length; i++) {
    var rule = rules[i];
    var ranges = rule.getRanges();
    for (var j = 0; j < ranges.length; j++) {
      Logger.log(ranges[j].getA1Notation());
    }
    var booleanConditios = rule.getBooleanCondition();
    Logger.log("背景色:"+booleanConditios.getBackground());
    Logger.log("太字:"+booleanConditios.getBold());
    Logger.log("基準型:"+booleanConditios.getCriteriaType());
    Logger.log("基準値:"+booleanConditios.getCriteriaValues());
    Logger.log("フォント色:"+booleanConditios.getFontColor());
    Logger.log("斜体:"+booleanConditios.getItalic());
    Logger.log("取り消し線:"+booleanConditios.getStrikethrough());
    Logger.log("下線:"+booleanConditios.getUnderline());
  }
}

Return
ConditionalFormatRule[] - シート内のすべての規則の配列。

スプレッドシートAPPクラス[SpreadsheetApp]の条件付き書式作成

スプレッドシートAPPの条件付き書式作成メソッドです。

条件付き書式作成[newConditionalFormatRule()]

newConditionalFormatRule()
条件付き書式設定ルール用のビルダーを作成します。

function newConditionalFormatRuleSample() {
  // シートに条件付き書式設定ルールを追加します。
  // これにより、A1:B3の範囲のすべてのセルに1〜10の数値が含まれている場合に赤に変わります。
  var sheet = SpreadsheetApp.getActive().getActiveSheet();
  var range = sheet.getRange('A1:B3');
  var rule = SpreadsheetApp.newConditionalFormatRule()
  .whenNumberBetween(1, 10)
  .setBackgroundColor("#FF0000")
  .setRanges([range])
  .build()
  var rules = sheet.getConditionalFormatRules();
  rules.push(rule);
  sheet.setConditionalFormatRules(rules);
}

Return
ConditionalFormatRuleBuilder - 新しいビルダー。

条件付き書式クラス[ConditionalFormatRule]

条件付き書式設定ルールにアクセスします。新しいルールを作成するには、SpreadsheetApp.newConditionalFormatRule()とConditionalFormatRuleBuilderを使用します。 Sheet.setConditionalFormatRules(rules)を使用して、特定のシートにルールを設定できます。

参照：Google Apps Script | REFERENCE | SpreadSheet | Class ConditionalFormatRule

Methods
方法	タイプ	説明
copy()	ConditionalFormatRuleBuilder	このルールの設定を持つルールビルダープリセットを返します。
getBooleanCondition()	BooleanCondition	BooleanConditionこのルールがブール条件基準を使用している場合、ルールの情報を取得します。
getGradientCondition()	GradientCondition	GradientConditionこのルールがグラデーション条件基準を使用している場合、ルールの情報を取得します。
getRanges()	Range[]	この条件付き書式規則が適用される範囲を取得します。

条件付き書式ビルダークラス[ConditionalFormatRuleBuilder]

条件付き書式規則のためのビルダー。

参照：Google Apps Script | REFERENCE | SpreadSheet | Class ConditionalFormatRuleBuilder

function conditionalFormatRuleBuilderSample() {
  // シートに条件付き書式設定ルールを追加します。
  // これにより、A1:B3の範囲のセルに1～10の数値が含まれている場合にそれらのセルが赤に変わります。
  var sheet = SpreadsheetApp.getActiveSheet();
  var range = sheet.getRange("A1:B3");
  var rule = SpreadsheetApp.newConditionalFormatRule()
      .whenNumberBetween(1, 10)
      .setBackground("#FF0000")
      .setRanges([range])
      .build();
  var rules = sheet.getConditionalFormatRules();
  rules.push(rule);
  sheet.setConditionalFormatRules(rules);
}

Methods
方法	タイプ	説明
build()	ConditionalFormatRule	ビルダーに適用された設定から条件付き書式規則を構築します。
copy()	ConditionalFormatRuleBuilder	このルールの設定を持つルールビルダープリセットを返します。
getBooleanCondition()	BooleanCondition	このルールがブール条件基準を使用する場合、ルールのBooleanCondition情報を取得します。
getGradientCondition()	GradientCondition	このルールがグラデーション条件基準を使用している場合、ルールのGradientCondition情報を取得します。
getRanges()	Range[]	この条件付き書式規則が適用される範囲を取得します。
setBackground(color)	ConditionalFormatRuleBuilder	条件付き書式設定ルールの書式の背景色を設定します。
setBold(bold)	ConditionalFormatRuleBuilder	条件付き書式設定ルールの書式にテキストの太字を設定します。
setFontColor(color)	ConditionalFormatRuleBuilder	条件付き書式設定ルールの書式のフォント色を設定します。
setGradientMaxpoint(color)	ConditionalFormatRuleBuilder	条件付き書式設定ルールのグラデーションの最大値をクリアし、代わりにルールの範囲内の最大値を使用します。
setGradientMaxpointWithValue(color, type, value)	ConditionalFormatRuleBuilder	条件付き書式ルールのグラデーション最大点フィールドを設定します。
setGradientMidpointWithValue(color, type, value)	ConditionalFormatRuleBuilder	条件付き書式設定ルールのグラデーション中間点フィールドを設定します。
setGradientMinpoint(color)	ConditionalFormatRuleBuilder	条件付き書式ルールのグラデーション最小値をクリアし、代わりにルールの範囲の最小値を使用します。
setGradientMinpointWithValue(color, type, value)	ConditionalFormatRuleBuilder	条件付き書式設定ルールのグラデーション最小ポイントフィールドを設定します。
setItalic(italic)	ConditionalFormatRuleBuilder	条件付き書式設定ルールの書式にテキスト斜体を設定します。
setRanges(ranges)	ConditionalFormatRuleBuilder	この条件付き書式規則が適用される1つ以上の範囲を設定します。
setStrikethrough(strikethrough)	ConditionalFormatRuleBuilder	条件付き書式設定ルールの書式のテキスト取り消し線を設定します。
setUnderline(underline)	ConditionalFormatRuleBuilder	条件付き書式設定ルールの書式にテキストの下線を設定します。
whenCellEmpty()	ConditionalFormatRuleBuilder	セルが空の場合にトリガーとなる条件付き書式設定ルールを設定します。
whenCellNotEmpty()	ConditionalFormatRuleBuilder	セルが空でない場合にトリガーとなる条件付き書式設定ルールを設定します。
whenDateAfter(date)	ConditionalFormatRuleBuilder	日付が指定された値より後になった場合にトリガーとなる条件付き書式規則を設定します。
whenDateAfter(relativeDate)	ConditionalFormatRuleBuilder	日付が指定の相対日付より後になった場合にトリガーとなる条件付き書式設定ルールを設定します。
whenDateBefore(date)	ConditionalFormatRuleBuilder	日付が指定の日付より前になった場合にトリガーとなる条件付き書式設定ルールを設定します。
whenDateBefore(relativeDate)	ConditionalFormatRuleBuilder	日付が指定の相対日付より前になった場合にトリガーとなる条件付き書式設定ルールを設定します。
whenDateEqualTo(date)	ConditionalFormatRuleBuilder	日付が指定の日付と等しい場合にトリガーとなる条件付き書式設定ルールを設定します。
whenDateEqualTo(relativeDate)	ConditionalFormatRuleBuilder	日付が指定の相対日付と等しい場合にトリガーとなる条件付き書式設定ルールを設定します。
whenFormulaSatisfied(formula)	ConditionalFormatRuleBuilder	指定された式がtrueと評価された場合にトリガーとなる条件付き書式設定ルールを設定します。
whenNumberBetween(start, end)	ConditionalFormatRuleBuilder	数値が指定された2つの値の間にあるか、そのいずれかである場合にトリガーとなる条件付き書式設定ルールを設定します。
whenNumberEqualTo(number)	ConditionalFormatRuleBuilder	数値が指定された値と等しい場合にトリガーとなる条件付き書式設定ルールを設定します。
whenNumberGreaterThan(number)	ConditionalFormatRuleBuilder	数値が指定された値よりも大きい場合にトリガーとなる条件付き書式設定ルールを設定します。
whenNumberGreaterThanOrEqualTo(number)	ConditionalFormatRuleBuilder	数値が指定された値以上の場合にトリガーとなる条件付き書式設定ルールを設定します。
whenNumberLessThan(number)	ConditionalFormatRuleBuilder	数値が指定された値より小さい場合にトリガーとなる条件付き条件付き書式ルールを設定します。
whenNumberLessThanOrEqualTo(number)	ConditionalFormatRuleBuilder	指定された値以下の数値が発生した場合にトリガーとなる条件付き書式設定ルールを設定します。
whenNumberNotBetween(start, end)	ConditionalFormatRuleBuilder	数値が2つの指定された値の間になく、どちらでもない場合にトリガーとなる条件付き書式設定ルールを設定します。
whenNumberNotEqualTo(number)	ConditionalFormatRuleBuilder	数値が指定された値と等しくない場合にトリガーとなる条件付き書式設定ルールを設定します。
whenTextContains(text)	ConditionalFormatRuleBuilder	入力に指定の値が含まれている場合にトリガーとなる条件付き書式設定ルールを設定します。
whenTextDoesNotContain(text)	ConditionalFormatRuleBuilder	入力に指定の値が含まれていない場合にトリガーとなる条件付き書式設定ルールを設定します。
whenTextEndsWith(text)	ConditionalFormatRuleBuilder	入力が指定の値で終了した場合にトリガーとなる条件付き書式設定ルールを設定します。
whenTextEqualTo(text)	ConditionalFormatRuleBuilder	入力が指定された値と等しい場合にトリガーとなる条件付き書式設定ルールを設定します。
whenTextStartsWith(text)	ConditionalFormatRuleBuilder	入力が指定された値で始まる場合にトリガーとなる条件付き書式設定ルールを設定します。
withCriteria(criteria, args)	ConditionalFormatRuleBuilder	条件付き書式ルールをBooleanCriteria値で定義された条件に設定します。通常は既存のルールの条件と引数から取得します。

条件付き書式構築[build()]

build()
ビルダーに適用された設定から条件付き書式規則を構築します。

Return
ConditionalFormatRule - 条件付き書式ルールの表現。

条件付き書式コピー作成[copy()]

copy()
このルールの設定を持つルールビルダープリセットを返します。

Return
ConditionalFormatRuleBuilder - このルールの設定に基づくビルダー。

ブール条件取得[getBooleanCondition()]

getBooleanCondition()
このルールがブール条件基準を使用する場合、ルールのBooleanCondition情報を取得します。それ以外の場合はnullを返します。

function getBooleanConditionSample() {
  // シートの最初の条件付き書式ルールのブール基準タイプを記録します。
  var rule = SpreadsheetApp.getActiveSheet().getConditionalFormatRules()[0];
  var booleanCondition = rule.getBooleanCondition();
  if (booleanCondition != null) {
    Logger.log(booleanCondition.getCriteriaType());
  }
}

Return
BooleanCondition - ブール条件オブジェクト。ルールがブール条件を使用しない場合はnull。

グラデーション条件取得[getGradientCondition()]

getGradientCondition()
このルールがグラデーション条件基準を使用している場合、ルールのGradientCondition情報を取得します。それ以外の場合はnullを返します。

function getGradientConditionSample() {
  //  シートの最初の条件付き書式ルールのグラデーション最小色を記録します。
  var rule = SpreadsheetApp.getActiveSheet().getConditionalFormatRules()[0];
  var gradientCondition = rule.getGradientCondition();
  if (gradientCondition != null) {
    Logger.log(gradientCondition.getMinColor());
  }
}

Return
GradientCondition - グラデーション条件オブジェクト。ルールがグラデーション条件を使用しない場合はnull。

範囲取得[getRanges()]

getRanges()
この条件付き書式規則が適用される範囲を取得します。

function getRangesSample() {
  //  シートの最初の条件付き書式ルールの各範囲を記録します。
  var rule = SpreadsheetApp.getActiveSheet().getConditionalFormatRules()[0];
  var ranges = rule.getRanges();
  for (int i = 0; i < ranges.length; i++) {
    Logger.log(ranges[i].getA1Notation());
  }
}

Return
Range [] - この条件付き書式規則が適用される範囲。