シート数の取得

特定のスプレッドシートからシート数を取得したい場合に使用する関数について解説します。

利用する関数

Spreadsheet.getNumSheets();

Spreadsheet クラスに用意されている、getNumSheets()を使用します。

実行にあたってスプレッドシートにアクセスすることになるため、初回実行時に認証が必要になる場合があります。

サンプルコード

/**
 * 対象スプレッドシートのID
 * https://docs.google.com/spreadsheets/d/〇〇〇/edit の〇〇〇の部分
 */
const SPREAD_SHEET_ID = '_______________';

/**
 * スプレッドシートのシート数を返却します
 */
const getNumSheets = () => {
  /** 対象スプレッドシート */
  const ss = SpreadsheetApp.openById(SPREAD_SHEET_ID);

  /** スプレッドシートのシート数 */
  const numSheets = ss.getNumSheets();

  console.log(numSheets);
  return numSheets;
};

実行すると、ログに対象シートのシート数が表示されます。