【GAS】Google Apps ScriptでSpreadSheetのシートを指定する方法を解説

Google Apps Script(以下GAS)で、SpreadSheetを扱いたい場合には必ず対象のシートを指定します。

その指定方法についてケース別で解説します。

例として今回はこんなシートを用意しました!

SpreadSheetのシート名
この記事でわかること
  • ケース別のシートの指定の方法がわかる

ワークブックの指定方法についてはこちらの記事で解説していますので、抑えておきましょう!

【GAS】Google Apps ScriptでSpreadSheetのワークブックを指定する方法を解説

シート名を直接指定して取得

getSheetByNameを使う

const activeSpreadSheet = SpreadsheetApp.getActiveSpreadsheet(); // 現在のSpreadSheetを取得
const sheet = activeSpreadSheet.getSheetByName('テスト'); // シート(SpreadSheetの下のタブ名を指定)

モグモグさん

シートの名前の変更には気をつける必要がありますね!

選択中のシートを取得

選択中のシートを取得する方法です。

例の画像だと、テスト3のシートが取得できます。

getActiveSheetを使う

const activeSpreadSheet = SpreadsheetApp.getActiveSpreadsheet(); // 現在のSpreadSheetを取得
const sheet = activeSpreadSheet.getActiveSheet();

シートの位置から取得

シートの位置から取得する方法です。

注意

インデックスは、0から始まります

例の画像だと、「テスト => 0」「テスト1 => 1」「テスト2 => 2」になります。

getSheetsを使う

const activeSpreadSheet = SpreadsheetApp.getActiveSpreadsheet(); // 現在のSpreadSheetを取得
const sheet = activeSpreadSheet.getSheets()[0]; // 「テスト」を取得

まとめ

ケース別にSpreadSheetのシートを指定する方法について解説しました。

最後にまとめです。

シートを指定する方法のまとめ
  • シート名を直接指定して取得: getSheetByName(‘シート名’)
  • 選択中のシートを取得: getActiveSheet()
  • シートの位置から取得: getSheets()[インデックス番号]

コメントを残す

メールアドレスが公開されることはありません。