[GAS] シートを取得する方法

JavaScriptGAS

Google Apps Script で シートを取得する方法のまとめ。
シートの位置（インデックス）で、シート名で、アクティブシート、シート全部を取得する方法をメモ。

シート位置（インデックス）から取得

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[index];

index のところにシートのインデックス番号を記入する。
インデックス番号は 0 から始まる。一番左の 1 枚目のシートを取得する場合は、

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

シート名から取得

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheetByName('シート名');

後からシート名が変更されるとエラーとなる。
またシート名の最後に半角スペースがある場合には、半角スペースも含めて指定しないとエラーとなる。

アクティブな（今開いている）シートを取得

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();

全てのシートを取得

var sheets = SpreadsheetApp.getActiveSpreadsheet().getSheets();

if (sheets.length > 1) {
  // シート名を取得
  Logger.log(sheets[0].getName());
}

Posted by Agopeanuts