Google Spreadsheetで複数の行を一括削除する方法【GASの関数deleteRowsを使ってみた】

Google Spreadsheetで複数の行を一括削除したいときに便利な関数があります。それは、deleteRowsという関数です。この関数は、Google Apps Script（GAS）のスプレッドシートクラスに属するメソッドで、指定した位置から指定した数の行を削除します。この関数は、スプレッドシートに複数の行がある場合にのみ使用できます。スプレッドシートに行が一つしかない場合は、エラーが発生します。

deleteRows関数の基本的な構文と引数の意味

deleteRows関数の基本的な構文は以下のとおりです。

var spreadsheet = spreadsheet.deleteRows(rowPosition, howMany);

ここで、spreadsheetはスプレッドシートオブジェクトで、SpreadsheetApp.getActiveSpreadsheet()などで取得できます。rowPositionは削除したい行の位置で、数値型の値を指定します。例えば、1を指定すると最初の行から削除します。howManyは削除したい行の数で、数値型の値を指定します。例えば、2を指定すると、rowPositionで指定した行とその下の行を削除します。spreadsheetは行を削除した後に、同じスプレッドシートオブジェクトを返します。この関数には引数が二つあります。

deleteRows関数で複数の行を一括削除するプログラムサンプルとその結果

では、実際にdeleteRows関数で複数の行を一括削除するプログラムを書いてみましょう。以下のようなスプレッドシートを用意します。

このスプレッドシートで、最初の行から3行分を削除するプログラムは以下のようになります。

function deleteRows() {
  // スプレッドシートオブジェクトを取得
  var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
  // 最初の行から3行分を削除
  spreadsheet.deleteRows(1, 3);
}

このプログラムを実行すると、以下のようにスプレッドシートが変更されます。

deleteRows関数でエラーが発生する場合の対処法

deleteRows関数は、スプレッドシートに行が一つしかない場合には使用できません。この場合は、エラーが発生します。例えば、以下のようなスプレッドシートで、deleteRows関数を実行すると、以下のようなエラーメッセージが表示されます。

Exception: You can't remove the last row in a sheet.

まとめ

この記事では、Google Spreadsheetで複数の行を一括削除する方法について紹介しました。deleteRows関数を使えば、指定した位置から指定した数の行を削除することができます。この関数は、Google Apps Script（GAS）のスプレッドシートクラスに属するメソッドで、行を削除した後に、同じスプレッドシートオブジェクトを返します。この関数には引数が二つあります。ただし、スプレッドシートに行が一つしかない場合は、エラーが発生するので注意が必要です。詳細は、公式ドキュメントを参照してください。

参考文献

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