GASでスプレッドシートの交互背景色設定を効率的に取得する方法

どげんね、Googleスプレッドシートを使いこなしたかね？今回は、Google Apps Script（GAS）で使える getBandings() メソッドについて詳しく話していくばい！バンディング（交互の色分け）をプログラムで操作できる強力な機能じゃけ、しっかり押さえておくと、スプレッドシートの見栄えやデータ整理が一気に楽になるっちゃ！

詳解！Ｇｏｏｇｌｅ　Ａｐｐｓ　Ｓｃｒｉｐｔ完全入門ＧｏｏｇｌｅアプリケーションとＧｏｏｇｌｅ　Ｗｏｒ第３版/秀和システム/高橋宣成

posted with カエレバ

楽天市場

Amazon

Yahooショッピング

getBandings() とは？
基本的な使い方
取得できる情報
getBandings() の活用例
1. 1. バンディングの条件付き変更
2. 2. エラーハンドリング
まとめ

getBandings() とは？

getBandings() メソッドは、スプレッドシートの「バンディング情報」を取得するための機能さ。スプレッドシートのセルを「縞模様」にする機能があるっちゃろ？それをプログラムで扱うためのメソッドじゃ。

このメソッドには Sheet.getBandings() と Range.getBandings() の2種類があるばい。

Sheet.getBandings()：シート全体のバンディングを取得する
Range.getBandings()：特定の範囲に適用されているバンディングを取得する

要するに、スプレッドシート全体の装飾ルールを取得するか、選択した範囲の装飾だけを取得するかの違いじゃな。

基本的な使い方

まずはシンプルな使い方を見てみるばい。

// シート全体のバンディング情報を取得
const sheetBandings = SpreadsheetApp.getActiveSheet().getBandings();

// 選択範囲のバンディング情報を取得
const rangeBandings = SpreadsheetApp.getActiveRange().getBandings();

ポイントは、このメソッドは引数を一切受け取らんってことさ。対象範囲はメソッドを呼び出すオブジェクト（Sheet または Range）によって決まるけん、使い方を間違えんように気をつけるばい。

取得できる情報

この getBandings() メソッドを使って取得できる Banding オブジェクトには、以下の情報が含まれとるばい。

適用範囲：getRange() で取得
バンディングの色：
- ヘッダー行の色 → getHeaderRowColor()
- フッター行の色 → getFooterRowColor()
- 奇数行の色 → getFirstRowColor()
- 偶数行の色 → getSecondRowColor()
バンディングテーマ：getBandingTheme() で取得

例えば、取得したバンディング情報をログに出力するスクリプトはこんな感じになるばい。

function analyzeBandings() {
  const sheet = SpreadsheetApp.getActiveSheet();
  const bandings = sheet.getBandings();
  
  bandings.forEach((banding, index) => {
    console.log(`Banding ${index + 1}:`);
    console.log(`- Range: ${banding.getRange().getA1Notation()}`);
    console.log(`- Theme: ${banding.getBandingTheme().toString()}`);
    console.log(`- Header Color: ${banding.getHeaderRowColor()}`);
    console.log(`- First Band: ${banding.getFirstRowColor()}`);
    console.log(`- Second Band: ${banding.getSecondRowColor()}`);
  });
}

これを実行すると、適用されているバンディングの色や範囲がコンソールに出力されるばい。

getBandings() の活用例

1. バンディングの条件付き変更

データの量によってバンディングのテーマを変更するスクリプトを作ってみるばい。

function applyDynamicBanding() {
  const range = SpreadsheetApp.getActiveRange();
  const dataValues = range.getValues();
  
  const theme = dataValues.length > 20 ? 
    SpreadsheetApp.BandingTheme.LIGHT_GREY :
    SpreadsheetApp.BandingTheme.CYAN;
  
  const existingBandings = range.getBandings();
  existingBandings.forEach(banding => banding.remove());
  
  const newBanding = range.applyRowBanding(theme, true, false);
  Logger.log(`Applied ${theme.toString()} to ${range.getA1Notation()}`);
}

このスクリプトを実行すると、データが20行を超えていたらグレーのバンディング、それ以下ならシアンのバンディングを適用するようになるばい。

2. エラーハンドリング

GASでは、権限不足や無効な範囲にアクセスするとエラーが出るけん、安全なスクリプトにするならエラーハンドリングを組み込むとよかばい。

function safeGetBandings() {
  try {
    const sheet = SpreadsheetApp.getActiveSheet();
    const bandings = sheet.getBandings();
    
    if (!bandings || bandings.length === 0) {
      throw new Error("No bandings found in active sheet");
    }
    
    return bandings.map(banding => ({
      range: banding.getRange().getA1Notation(),
      theme: banding.getBandingTheme().toString(),
      colors: {
        header: banding.getHeaderRowColor(),
        first: banding.getFirstRowColor(),
        second: banding.getSecondRowColor()
      }
    }));
    
  } catch (error) {
    console.error(`Banding retrieval failed: ${error.message}`);
    console.error(`Stack trace: ${error.stack}`);
    return [];
  }
}