Google SpreadsheetのGAS関数getDataSourcePivotTablesを理解する

Google Apps Script (GAS)は、Googleの各種サービスを自動化したり、カスタマイズしたりするためのスクリプト言語です。この記事では、Google SpreadsheetのGAS関数の一つであるgetDataSourcePivotTablesについて詳しく解説します。この関数は、スプレッドシートにあるデータソースピボットテーブルのリストを取得するために使用されます。

この記事でわかること

  • getDataSourcePivotTables関数の基本的な使い方
  • getDataSourcePivotTables関数の引数の解説
  • getDataSourcePivotTables関数の戻り値について

getDataSourcePivotTables関数

プログラムサンプル

// スプレッドシートを取得
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();

// データソースピボットテーブルのリストを取得
var pivotTables = spreadsheet.getDataSourcePivotTables();

// ピボットテーブルの情報をログに出力
for (var i = 0; i < pivotTables.length; i++) {
  Logger.log(pivotTables[i].getPivotTableId());
}

引数の解説

getDataSourcePivotTables関数は引数を取りません。

戻り値

getDataSourcePivotTables関数は、スプレッドシートにあるデータソースピボットテーブルのリストを返します。各ピボットテーブルはDataSourcePivotTableオブジェクトとして表されます。

公式ドキュメントのURL: Google Apps Script Reference

まとめ

この記事では、Google SpreadsheetのGAS関数getDataSourcePivotTablesについて詳しく解説しました。この関数を使うと、スプレッドシートにあるデータソースピボットテーブルのリストを簡単に取得することができます。これにより、データ分析やレポート作成の自動化がさらに進化します。

参考文献: Google Apps Script Reference

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

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

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