【スプレッドシート】シート名・すべてのシート名を取得する方法｜GASの利用例

今回は、Google スプレッドシートで現在のシート名を取得する方法と、ファイル内のすべてのシート名を取得する方法となります。

例ではGoogle Apps Script （GAS）を利用して関数を定義し、その関数でシート名を取得します。

スプレッドシートでGASを利用する方法については、以下のリンク先を参考にしてみてください。

【GAS】スクリプトを作成・実行・管理する方法｜スプレッドシート・カレンダー・メールなど

現在のシート名を取得する方法

現在のシート名を取得する関数の例は以下となり、スクリプトエディタに記述します。

// シート名を取得
function mySheetName() {
  const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
  return sheet.getName();
}

シート名を取得する際には、シート名を表示したいセルで定義した関数を利用します。 

利用したGASのメソッドについて

上記の関数では、SpreadsheetクラスのgetActiveSheetメソッドで取得した現在のシートに対して、SheetクラスのgetNameメソッドを利用することで、シート名を取得しています。

すべてのシート名を取得する方法

ファイル内のすべてのシート名を取得する関数の例は以下となり、スクリプトエディタに記述します。

// すべてのシート名を取得
function myAllSheetName() {
  const sheets = SpreadsheetApp.getActiveSpreadsheet().getSheets();
  return sheets.map(sheet => sheet.getName());
}

すべてのシート名を取得する際には、シート名を表示したいセルで定義した関数を利用します。また、関数の戻り値はシート名の配列となるため、複数のシートがある場合は、シート名ごとに関数を利用した下のセルに表示されます。

利用したGASのメソッドについて

上記の関数では、SpreadsheetクラスのgetSheetsメソッドで取得したすべてのシートの配列に対して、mapを利用しSheetクラスのgetNameメソッドで、シート名を配列で取得しています。

また、上記コードは配列のmapを利用しているため、GASのランタイム環境が「V8」でない場合に構文エラーとなります。

詳しくは以下のリンク先を参考にしてみてください。

【GAS】スクリプトが構文エラーとなる場合｜ランタイムを変更