GAS スプレッドシートに新しいシートを挿入する

GAS スプレッドシートに新しいシートを挿入する

GAS(Google Apps Script)で、スプレッドシートに新しいシートを挿入する手順を記述してます。「insertSheet()」にシート名を使用して、挿入します。

環境

  • OS windows11 home
  • ブラウザ chrome 110.0.5481.78

新しいシートを挿入

新しいシートを挿入するには、「insertSheet()」を使用します。

spreadsheet.insertSheet("シート名", インデックス番号 ,[ {template: テンプレート用のシート} ])

以下のスプレッドシートに追加してみます。

コードを実行します。

function myFunction() {

  // GASを作成したスプレッドシート
  let spreadsheet = SpreadsheetApp.getActiveSpreadsheet();

  // 新しいシートを挿入する
  spreadsheet.insertSheet('新しいシート');

}

挿入されていることが確認できます。

位置を指定

インデックス番号を指定することで、位置を指定して、挿入することも可能です。

function myFunction() {

  // GASを作成したスプレッドシート
  let spreadsheet = SpreadsheetApp.getActiveSpreadsheet();

  // テンプレート
  let templateSheet = spreadsheet.getSheetByName('シート1');

  // 新しいシートを挿入する
  spreadsheet.insertSheet('新しいシート', 2 , {template: templateSheet});

}

インデックス番号「2」の位置に挿入されていることが確認できます。

テンプレートを使用

次は「シート1」をテンプレートして、シートを挿入してみます。

function myFunction() {

  // GASを作成したスプレッドシート
  let spreadsheet = SpreadsheetApp.getActiveSpreadsheet();

  // テンプレート
  let templateSheet = spreadsheet.getSheetByName('シート1');

  // 新しいシートを挿入する
  spreadsheet.insertSheet('新しいシート', {template: templateSheet});

}

「シート1」と同じ状態で挿入されていることが確認できます。

存在するシート名を指定

すでに存在するシート名を指定するとエラーとなります。