Class DataSourcePivotTable

DataSourcePivotTable

既存のデータソースのピボット テーブルにアクセスして編集します。新しいデータソースのピボット テーブルを作成するには、Range.createDataSourcePivotTable(dataSource) を使用します。

このクラスは、データベースに接続されているデータでのみ使用してください。

方法

メソッド戻り値の型概要
addColumnGroup(columnName)PivotGroup指定されたデータソース列に基づいて新しいピボット列グループを追加します。
addFilter(columnName, filterCriteria)PivotFilter指定したフィルタ条件を使用して、指定したデータソース列に基づいて新しいフィルタを追加します。
addPivotValue(columnName, summarizeFunction)PivotValue指定された集計関数を使用して、指定されたデータソース列に基づいて新しいピボット値を追加します。
addRowGroup(columnName)PivotGroup指定されたデータソース列に基づいて、新しいピボット行グループを追加します。
asPivotTable()PivotTableデータソースのピボット テーブルを通常のピボット テーブル オブジェクトとして返します。
cancelDataRefresh()DataSourcePivotTableこのオブジェクトに関連付けられているデータの更新（現在実行中の場合）をキャンセルします。
forceRefreshData()DataSourcePivotTable現在の状態に関係なく、このオブジェクトのデータを更新します。
getDataSource()DataSourceオブジェクトがリンクされているデータソースを取得します。
getStatus()DataExecutionStatusオブジェクトのデータ実行ステータスを取得します。
refreshData()DataSourcePivotTableオブジェクトのデータを更新します。
waitForCompletion(timeoutInSeconds)DataExecutionStatus現在の実行が完了するまで待機し、指定された秒数後にタイムアウトします。

詳細なドキュメント

addColumnGroup(columnName)

指定されたデータソース列に基づいて新しいピボット列グループを追加します。

パラメータ

名前型説明
columnNameStringピボット グループのベースとなるデータソースの列名。

リターン

PivotGroup - 新しいピボット グループ。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

addFilter(columnName, filterCriteria)

指定したフィルタ条件を使用して、指定したデータソース列に基づいて新しいフィルタを追加します。

パラメータ

名前型説明
columnNameStringフィルタの基になるデータソースの列名。
filterCriteriaFilterCriteriaフィルタで使用される条件。

リターン

PivotFilter - 新しいフィルタ。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

addPivotValue(columnName, summarizeFunction)

指定された集計関数を使用して、指定されたデータソース列に基づいて新しいピボット値を追加します。

パラメータ

名前型説明
columnNameStringピボット値の基になるデータソースの列名。
summarizeFunctionPivotTableSummarizeFunctionピボット値で使用される集計関数です。

リターン

PivotValue - 新しいピボット値。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

addRowGroup(columnName)

指定されたデータソース列に基づいて、新しいピボット行グループを追加します。

パラメータ

名前型説明
columnNameStringピボット グループのベースとなるデータソースの列名。

リターン

PivotGroup - 新しいピボット グループ。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

asPivotTable()

データソースのピボット テーブルを通常のピボット テーブル オブジェクトとして返します。

リターン

PivotTable - ピボット テーブル。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

cancelDataRefresh()

このオブジェクトに関連付けられているデータの更新をキャンセルします（現在実行中の場合）。

次の例は、数式の更新をキャンセルする方法を示しています。 

const spreadsheet = SpreadsheetApp.getActive();
const formula = spreadsheet.getDataSourceFormulas()[0];
// Cancel the ongoing refresh on the formula.
formula.cancelDataRefresh();

データソース タイプが有効になっていない場合は、例外をスローします。特定のデータソース タイプでデータ実行を有効にするには、 SpreadsheetApp#enable...Execution() メソッドを使用します。

リターン

DataSourcePivotTable - データ オブジェクト。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

forceRefreshData()

現在の状態に関係なく、このオブジェクトのデータを更新します。詳しくは、refreshData() をご覧ください。このオブジェクトの現在実行中の更新をキャンセルする場合は、cancelDataRefresh() をご覧ください。

データソース タイプが有効になっていない場合は、例外をスローします。特定のデータソース タイプでデータ実行を有効にするには、SpreadsheetApp#enable...Execution() メソッドを使用します。

リターン

DataSourcePivotTable - データ オブジェクト。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getDataSource()

オブジェクトがリンクされているデータソースを取得します。

リターン

DataSource - データソース。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getStatus()

オブジェクトのデータ実行ステータスを取得します。

リターン

DataExecutionStatus - データ実行ステータス。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

refreshData()

オブジェクトのデータを更新します。

現在 error 状態の場合は、例外をスローします。DataSource#updateSpec() を使用して仕様を更新します。データソースで予期しない編集が行われないように、この方法は forceRefreshData() よりも推奨されています。

データソース タイプが有効になっていない場合は、例外をスローします。特定のデータソース タイプでデータ実行を有効にするには、SpreadsheetApp#enable...Execution() メソッドを使用します。

リターン

DataSourcePivotTable - データ オブジェクト。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

waitForCompletion(timeoutInSeconds)

現在の実行が完了するまで待機し、指定された秒数後にタイムアウトします。タイムアウト時に実行が完了していない場合、例外をスローしますが、データ実行はキャンセルされません。

パラメータ

名前型説明
timeoutInSecondsIntegerデータ実行の待機時間（秒）。最大値は 300 秒です。

リターン

DataExecutionStatus - データ実行ステータス。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets