Google Apps Scriptでスプレッドシートの全てのシートを取得する方法

概要

スプレッドシートの全てのシートを取得する方法です。

使用するメソッド

構文

Spreadsheetオブジェクト.getSheets()

引数

なし

戻り値

Sheet[]

サンプルプログラム

for文で繰り返す場合

function sample() {
  
  // スプレッドシートオブジェクトを取得
  const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
  
  // 全てのシート情報を取得
  const sheets = spreadsheet.getSheets();

  // シートの件数分繰り返し
  for (let i = 0; i < sheets.length; i++) {
    
    // シート名
    let sheetName = sheets[i].getName();

    // シートID
    let sheetId = sheets[i].getSheetId();

    // コンソールにシート名とシートIDを出力
    console.log(`シート名：${sheetName}、シートID：${sheetId}`);
  }
}

forEach文で繰り返す場合

function sample() {
  
  // スプレッドシートオブジェクトを取得
  const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
  
  // 全てのシート情報を取得
  const sheets = spreadsheet.getSheets();

  // シートの件数分繰り返し
  sheets.forEach(function(sheet){
    
    // シート名
    let sheetName = sheet.getName();

    // シートID
    let sheetId = sheet.getSheetId();

    // コンソールにシート名とシートIDを出力
    console.log(`シート名：${sheetName}、シートID：${sheetId}`);
  });
}

参考

Class Spreadsheet  |  Apps Script  |  Google Developers