[GAS]シートの行・列を追加・挿入・削除する方法 -Sheetクラス-

Google Apps Script (GAS) でシートの行・列を追加・挿入する方法、また削除する方法を説明します。

Sheetクラスのメソッドを利用した手順について説明します。

SpreadSheetクラスでアクティブなシートに対して実施する方法については、下記をご覧ください。

Google Apps Scriptの基本的な使い方については下記をご覧ください。

GASによるスプレッドシート操作の概要

GASでスプレッドシートを操作するための「SpreadSheetサービス」は、主に下記のクラスで構成されています。

クラス	説明
SpreadSheetApp	SpreadSheetサービスの親クラス
Spreadsheet	スプレッドシートを操作するクラス
Sheet	シートを操作するクラス
Range	セル範囲を操作するクラス

それぞれ下記のような位置付けになります。

「SpreadSheetApp」→「SpreadSheet」→「Sheet」→「Range」という順の階層構造になっています。操作対象に応じて、下の階層にたどってオブジェクトを取得して利用します。

このページでは、上記の中のSheetクラスの下記のメソッドについて説明します。

メソッド	戻り値	説明
insertRowBefore(beforePosition)	Sheet	このシートの指定した行の前に行を挿入する
insertRowsBefore(beforePosition, howMany)	Sheet	このシートの指定した行の前に複数の行を挿入する
insertRowAfter(afterPosition)	Sheet	このシートの指定した行の後に行を挿入する
insertRowsAfter(afterPosition, howMany)	Sheet	このシートの指定した行の後に複数の行を挿入する
insertRows(rowIndex)	void	このシートの指定した行の前に行を挿入する
insertRows(rowIndex, numRows)	void	このシートの指定した行の前に複数の行を挿入する
insertColumnBefore(beforePosition)	Sheet	このシートの指定した列の前に列を挿入する
insertColumnsBefore(beforePosition, howMany)	Sheet	このシートの指定した列の前に複数の列を挿入する
insertColumnAfter(afterPosition)	Sheet	このシートの指定した列の後に列を挿入する
insertColumnsAfter(afterPosition, howMany)	Sheet	このシートの指定した列の後に複数の列を挿入する
insertColumns(columnIndex)	void	このシートの指定した列の前に列を挿入する
insertColumns(columnIndex, numColumns)	void	このシートの指定した列の前に複数の列を挿入する
deleteRow(rowPosition)	Sheet	このシートの指定した行を削除する
deleteRows(rowPosition, howMany)	void	このシートの指定した複数の行を削除する
deleteColumn(columnPosition)	Sheet	このシートの指定した列を削除する
deleteColumns(columnPosition, howMany)	void	このシートの指定した複数の列を削除する

このシートに行を挿入する

このシートの指定した場所に行を挿入するメソッドを説明します。

このシートの指定した行の前に行を挿入する：insertRowBefore(beforePosition)

このシートの指定した行の前に行を挿入する方法です。

下記のように実行します。

function myFunction() {
  const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();
  const testSheet = testSpreadSheet.getSheetByName("シート1");
  testSheet.insertRowBefore(3);
}

function myFunction() {

const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();

const testSheet = testSpreadSheet.getSheetByName("シート1");

testSheet.insertRowBefore(3);

}

下記のファイルに対して実行すると、

下記の結果になります。もともとの3行目の上に新しい行が挿入されます。

このシートの指定した行の前に複数の行を挿入する：insertRowsBefore(beforePosition, howMany)

このシートの指定した行の前に複数の行を挿入する方法です。

下記のように実行します。

function myFunction() {
  const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();
  const testSheet = testSpreadSheet.getSheetByName("シート1");
  testSheet.insertRowsBefore(3, 3);
}

function myFunction() {

const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();

const testSheet = testSpreadSheet.getSheetByName("シート1");

testSheet.insertRowsBefore(3, 3);

}

下記のファイルに対して実行すると、

下記の結果になります。もともとの3行目の上に新しい行が3行挿入されます。

このシートの指定した行の後に行を挿入する：insertRowAfter(afterPosition)

このシートの指定した行の後に行を挿入する方法です。

下記のように実行します。

function myFunction() {
  const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();
  const testSheet = testSpreadSheet.getSheetByName("シート1");
  testSheet.insertRowAfter(3);
}

function myFunction() {

const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();

const testSheet = testSpreadSheet.getSheetByName("シート1");

testSheet.insertRowAfter(3);

}

下記のファイルに対して実行すると、

下記の結果になります。3行目の下に新しい行が挿入されます。

このシートの指定した行の後に複数の行を挿入する：insertRowsAfter(afterPosition, howMany)

このシートの指定した行の後に複数の行を挿入する方法です。

下記のように実行します。

function myFunction() {
  const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();
  const testSheet = testSpreadSheet.getSheetByName("シート1");
  testSheet.insertRowsAfter(3, 3);
}

function myFunction() {

const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();

const testSheet = testSpreadSheet.getSheetByName("シート1");

testSheet.insertRowsAfter(3, 3);

}

下記のファイルに対して実行すると、

下記の結果になります。3行目の下に新しい行が3行挿入されます。

このシートの指定した行の前に行を挿入する：insertRows(rowIndex)

このシートの指定した行の前に複数の行を挿入する方法です。

insertRowBefore(beforePosition)と同様の動作になります。

下記のように実行します。

function myFunction() {
  const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();
  const testSheet = testSpreadSheet.getSheetByName("シート1");
  testSheet.insertRows(3);
}

function myFunction() {

const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();

const testSheet = testSpreadSheet.getSheetByName("シート1");

testSheet.insertRows(3);

}

下記のファイルに対して実行すると、

下記の結果になります。もともとの3行目の上に新しい行が挿入されます。

このシートの指定した行の前に複数の行を挿入する：insertRows(rowIndex, numRows)

このシートの指定した行の前に複数の行を挿入する方法です。

insertRowsBefore(beforePosition, howMany)も同様の動作になります。

下記のように実行します。

function myFunction() {
  const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();
  const testSheet = testSpreadSheet.getSheetByName("シート1");
  testSheet.insertRows(3, 3);
}

function myFunction() {

const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();

const testSheet = testSpreadSheet.getSheetByName("シート1");

testSheet.insertRows(3, 3);

}

下記のファイルに対して実行すると、

下記の結果になります。もともとの3行目の上に新しい行が3行挿入されます。

このシートに列を挿入する

このシートの指定した場所に列を挿入するメソッドを説明します。

このシートの指定した列の前に列を挿入する：insertColumnBefore(beforePosition)

このシートの指定した列の前に列を挿入する方法です。

下記のように実行します。

function myFunction() {
  const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();
  const testSheet = testSpreadSheet.getSheetByName("シート1");
  testSheet.insertColumnBefore(3);
}

function myFunction() {

const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();

const testSheet = testSpreadSheet.getSheetByName("シート1");

testSheet.insertColumnBefore(3);

}

下記のファイルに対して実行すると、

下記の結果になります。もともとの3列目の左に新しい列が挿入されます。

このシートの指定した列の前に複数の列を挿入する：insertColumnsBefore(beforePosition, howMany)

このシートの指定した列の前に複数の列を挿入する方法です。

下記のように実行します。

function myFunction() {
  const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();
  const testSheet = testSpreadSheet.getSheetByName("シート1");
  testSheet.insertColumnsBefore(3, 3);
}

function myFunction() {

const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();

const testSheet = testSpreadSheet.getSheetByName("シート1");

testSheet.insertColumnsBefore(3, 3);

}

下記のファイルに対して実行すると、

下記の結果になります。もともとの3列目の左に新しい列が3列挿入されます。

このシートの指定した列の後に列を挿入する：insertColumnAfter(afterPosition)

このシートの指定した列の後に列を挿入する方法です。

下記のように実行します。

function myFunction() {
  const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();
  const testSheet = testSpreadSheet.getSheetByName("シート1");
  testSheet.insertColumnAfter(3);
}

function myFunction() {

const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();

const testSheet = testSpreadSheet.getSheetByName("シート1");

testSheet.insertColumnAfter(3);

}

下記のファイルに対して実行すると、

下記の結果になります。3列目の右に新しい列が挿入されます。

このシートの指定した列の後に複数の列を挿入する：insertColumnsAfter(afterPosition, howMany)

このシートの指定した列の後に複数の列を挿入する方法です。

下記のように実行します。

function myFunction() {
  const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();
  const testSheet = testSpreadSheet.getSheetByName("シート1");
  testSheet.insertColumnsAfter(3, 3);
}

function myFunction() {

const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();

const testSheet = testSpreadSheet.getSheetByName("シート1");

testSheet.insertColumnsAfter(3, 3);

}

下記のファイルに対して実行すると、

下記の結果になります。3列目の右に新しい列が3列挿入されます。

このシートの指定した列の前に列を挿入する：insertColumns(columnIndex)

このシートの指定した列の前に列を挿入する方法です。

insertColumnBefore(beforePosition)と同様の動作です。

下記のように実行します。

function myFunction() {
  const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();
  const testSheet = testSpreadSheet.getSheetByName("シート1");
  testSheet.insertColumns(3);
}

function myFunction() {

const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();

const testSheet = testSpreadSheet.getSheetByName("シート1");

testSheet.insertColumns(3);

}

下記のファイルに対して実行すると、

下記の結果になります。もともとの3列目の左に新しい列が挿入されます。

このシートの指定した列の前に複数の列を挿入する：insertColumns(columnIndex, numColumns)

このシートの指定した列の前に複数の列を挿入する方法です。

insertColumnsBefore(beforePosition, howMany)と同様の動作です。

下記のように実行します。

function myFunction() {
  const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();
  const testSheet = testSpreadSheet.getSheetByName("シート1");
  testSheet.insertColumns(3, 3);
}

function myFunction() {

const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();

const testSheet = testSpreadSheet.getSheetByName("シート1");

testSheet.insertColumns(3, 3);

}

下記のファイルに対して実行すると、

下記の結果になります。もともとの3列目の左に新しい列が3列挿入されます。

このシートの行を削除する

このシートの指定した行を削除するメソッドを説明します。

このシートの指定した行を削除する：deleteRow(rowPosition)

このシートの指定した行を削除する方法です。

下記のように実行します。

function myFunction() {
  const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();
  const testSheet = testSpreadSheet.getSheetByName("シート1");
  testSheet.deleteRow(3);
}

function myFunction() {

const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();

const testSheet = testSpreadSheet.getSheetByName("シート1");

testSheet.deleteRow(3);

}

下記のファイルに対して実行すると、

下記の結果になります。指定した3行目が削除されます。

このシートの指定した複数の行を削除する：deleteRows(rowPosition, howMany)

このシートの指定した複数の行を削除する方法です。

下記のように実行します。

function myFunction() {
  const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();
  const testSheet = testSpreadSheet.getSheetByName("シート1");
  testSheet.deleteRows(3, 2);
}

function myFunction() {

const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();

const testSheet = testSpreadSheet.getSheetByName("シート1");

testSheet.deleteRows(3, 2);

}

下記のファイルに対して実行すると、

下記の結果になります。指定した3行目から2行分が削除されます。

このシートの列を削除する

このシートの指定した列を削除するメソッドを説明します。

このシートの指定した列を削除する：deleteColumn(columnPosition)

このシートの指定した列を削除する方法です。

下記のように実行します。

function myFunction() {
  const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();
  const testSheet = testSpreadSheet.getSheetByName("シート1");
  testSheet.deleteColumn(3);
}

function myFunction() {

const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();

const testSheet = testSpreadSheet.getSheetByName("シート1");

testSheet.deleteColumn(3);

}

下記のファイルに対して実行すると、

下記の結果になります。指定した3列目が削除されます。

このシートの指定した複数の列を削除する：deleteColumns(columnPosition, howMany)

このシートの指定した複数の列を削除する方法です。

下記のように実行します。

function myFunction() {
  const testSpreadSheet = SpreadsheetApp.getActiveSpreadsheet();
  const testSheet = testSpreadSheet.getSheetByName("シート1");
  testSheet.deleteColumns(3, 2);
}