Google SpreadsheetのGAS関数getDataSourceSheetsをマスターする

Google Apps Script (GAS)は、Googleの各種サービスを自動化したり、カスタマイズしたりするためのスクリプト言語です。今回は、その中の一つであるgetDataSourceSheets関数について解説します。この関数は、Google Spreadsheet内のデータソースシートを取得するために使用します。

この記事でわかること

  1. getDataSourceSheets関数の基本的な使い方
  2. getDataSourceSheets関数の引数と戻り値の解説
  3. 実際のプログラムサンプルとその解説

getDataSourceSheets関数

プログラムサンプル

function myFunction() {
  var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
  var sheets = spreadsheet.getDataSourceSheets();
  for (var i = 0; i < sheets.length; i++) {
    Logger.log(sheets[i].getName());
  }
}

引数の解説

getDataSourceSheets関数は引数を必要としません。この関数は、アクティブなスプレッドシート内のすべてのデータソースシートを取得します。

戻り値

getDataSourceSheets関数は、スプレッドシート内のすべてのデータソースシートを表すSheetオブジェクトの配列を返します。データソースシートが存在しない場合、空の配列が返されます。

公式ドキュメントのURL

詳細な情報やその他の関数については、公式ドキュメントをご覧ください。

まとめ

この記事では、Google SpreadsheetのGAS関数getDataSourceSheetsについて解説しました。この関数を使うことで、スプレッドシート内のデータソースシートを簡単に取得することができます。これにより、データソースシートを活用した各種処理を自動化することが可能になります。

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

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

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