GASでスプレッドシートのシートを削除する方法(deleteSheet)

2020年8月5日2023年2月2日

Google Apps Script(GAS)では、スプレッドシートに対し様々処理を行うことが可能です。

シート追加や複製などに加え、存在しているシートをスプレッドシートから削除することもできます。

今回、GASでスプレッドシートに存在するシートを削除する方法を解説していきます。

1. GASでスプレッドシートのシート削除
2. deleteSheetメソッドでシートを削除
3. シートを削除するGASサンプルコード
4. 複数シートを削除したい場合は？
5. スプレッドシートにシートは最低1個は必要
6. まとめ・終わりに

GASでスプレッドシートのシート削除

Googleスプレッドシートに関する操作は、殆どのものがGoogle Apps Script(GAS)で処理自動化することができます。

スプレッドシートのシートを削除するのは、Google Apps Scriptでも実行可能

新しくスプレッドシートファイルを作成することはもちろん、シート追加・コピーに加え、存在するシートを削除するといった処理も可能です。

deleteSheetメソッドでシートを削除

Google Apps Script(GAS)では、SpreadsheetAppクラスにあるdeleteSheetメソッドでシート削除することができます。

SpreadsheetApp.getActiveSpreadsheet.deleteSheet(Sheet sheet)

スクリプトに紐づくスプレッドシートまたはスクリプトIDからSpreadsheetオブジェクトを生成します。

Spreadsheetオブジェクトで実行可能なdeleteSheetメソッドで、引数として削除したいシートを指定することで、スプレッドシートのシート削除が可能です。

シートを削除するGASサンプルコード

実際にGoogle Apps Script(GAS)でスプレッドシートに属するシートを削除するサンプルコードを解説したいと思います。

スプレッドシートに紐づくコンテナバインドスクリプトで、10行にも満たないGASコードでシート削除が可能です。

Google Apps Script(GAS)でスプレッドシートのシートを削除するサンプルコード

//シートを削除する関数
function delSheetTest() {
  // 現在アクティブなスプレッドシートを取得
  let mySheet = SpreadsheetApp.getActiveSpreadsheet();
  //取得したスプレッドシートでシート名を入力し、削除したいシートを取得
  let delSheet = mySheet.getSheetByName("削除したいシート");
  //deleteSheetメソッドでシート削除を実行
  mySheet.deleteSheet(delSheet);
}

まずスクリプトに紐づいているスプレッドシートをgetActiveSpreadsheetメソッドで取得します。

次にgetSheetByNameメソッドでスプレッドシートから削除したいシート名を引数に指定してシートを取得します。

最後にdeleteSheetメソッドで削除対象のシートを引数にすることで、シートの削除できます。

実際にこのスプレッドシートのシートを削除するGASスクリプトを実行すると、「削除したいシート」という名前のシートが削除されます。

Google Apps Script(GAS)でシート削除のスクリプトを実行した結果

なお、アクティブなシートを削除する「deleteActiveSheet」というメソッドがあり、こちらでも削除は可能です。

//アクティブなシートを削除する関数
function delSheetTest() {
  // 現在アクティブなスプレッドシートを取得
  let mySheet = SpreadsheetApp.getActiveSpreadsheet();
  //deleteActiveSheetメソッドでシート削除を実行
  mySheet.deleteActiveSheet();
}

deleteActiveSheetの場合、削除シートを引数で指定する必要がないため、よりシンプルなコードになります。

ただし、アクティブなシートが何かわからないため、誤って削除したくないシートを削除する恐れがあります。