Google SpreadsheetのGASでgetActiveRangeを使って選択範囲を取得する方法

Google SpreadsheetのGAS（Google Apps Script）を使って、スプレッドシートの操作を自動化したり、カスタマイズしたりすることができます。GASの関数の中には、スプレッドシートの選択範囲を取得するgetActiveRangeというものがあります。この関数は、どういうときに使うのでしょうか？

getActiveRange関数の使い方とプログラムサンプル

getActiveRange関数は、スプレッドシートのアクティブなシートの選択範囲を取得する関数です。選択範囲とは、ユーザーがマウスやキーボードで選択したセルの範囲のことです。例えば、A1からC3までのセルを選択した場合、その範囲が選択範囲になります。

getActiveRange関数は、以下のように使います。

// スプレッドシートのアクティブなシートを取得
var sheet = SpreadsheetApp.getActiveSheet();

// 選択範囲を取得
var range = sheet.getActiveRange();

// 選択範囲の情報をログに出力
Logger.log(range.getA1Notation()); // A1:C3
Logger.log(range.getNumRows()); // 3
Logger.log(range.getNumColumns()); // 3
Logger.log(range.getValues()); // [[1, 2, 3], [4, 5, 6], [7, 8, 9]]

このプログラムは、スプレッドシートのアクティブなシートの選択範囲を取得し、その範囲のA1表記、行数、列数、値をログに出力します。選択範囲がA1からC3までのセルで、その値が1から9までの連番だった場合、上記のようなログが出力されます。

getActiveRange関数の引数と戻り値の解説

getActiveRange関数は、引数をとりません。戻り値は、Rangeオブジェクトです。Rangeオブジェクトは、スプレッドシートのセルの範囲を表すオブジェクトで、さまざまなメソッドやプロパティを持ちます。例えば、getA1Notationメソッドは、範囲のA1表記を返します。getNumRowsメソッドは、範囲の行数を返します。getNumColumnsメソッドは、範囲の列数を返します。getValuesメソッドは、範囲の値を二次元配列で返します。

まとめ

この記事では、Google SpreadsheetのGASの関数getActiveRangeについて、以下の内容を紹介しました。

• getActiveRange関数の使い方とプログラムサンプル
• getActiveRange関数の引数と戻り値の解説

getActiveRange関数を使えば、スプレッドシートの選択範囲を取得して、その範囲に対してさまざまな操作を行うことができます。GASを使ってスプレッドシートを便利に使いこなしてみましょう。

参考文献

• https://developers.google.com/apps-script/reference/spreadsheet/spreadsheet?hl=ja#getactiverange