GAS

シートのIDを取得する | getSheetId()【GAS】

たけだ

GASを使ってシートのIDを取得する方法をご紹介します

💡この記事でわかること
  • getSheetId関数を使ってシート固有のIDを取得する方法
  • シート指定でスプレッドシートを開くURLの作成方法

getSheetId()

const spreadsheet = SpreadsheetApp.getActiveSpreadsheet()
const sheet = spreadsheet.getSheetByName("社員名簿")

// シートのIDを取得する
const sheetId = sheet.getSheetId()
console.log(sheetId)

実行結果

1662571970

公式ドキュメント

https://developers.google.com/apps-script/reference/spreadsheet/sheet#getsheetid

引数

引数なし

戻り値

シート固有の ID(数値)

シート指定でスプレッドシートを開くURLの作成方法

ぴよこ

このシートIDの使い道を知りたいです！

たけだ

特定のシートを選択した状態でスプレッドシートを開くURLを作成するときにシートIDを利用します

通常、スプレッドシートのURLは次のような構造になっています。

https://docs.google.com/spreadsheets/d/{スプレッドシートID}/edit#gid={シートID}

ここのgid=に続くシートIDを今回のgetSheetId()を使うことによって取得することができます。

例えばGASで新しくシートを追加し、そのシートを開くURLを発行するには次のようなスクリプトを書きます。

const spreadsheet = SpreadsheetApp.getActiveSpreadsheet()
// 新しくシートを追加する
const newSheet = spreadsheet.insertSheet()

// スプレッドシートIDを取得
const spreadsheetId = spreadsheet.getId()
// シートIDを取得
const sheetId = newSheet.getSheetId()
console.log(`https://docs.google.com/spreadsheets/d/${spreadsheetId}/edit#gid=${sheetId}`)

実行結果

https://docs.google.com/spreadsheets/d/{スプレッドシートID}/edit#gid=17509463

まとめ

たけだ

以上、GASを使ってシートのIDを取得する方法でした。

最後まで読んでいただきありがとうございました！

GASをイチから学びたい方へ

このブログでは断片的な説明になってしまっていますが、本書は幅広いGASの内容が網羅的に学べる本です。イチから学びたい方は是非読んでみてください。

すでにGASをある程度マスターした方にも辞書的に手元に置いておくと便利です。