Class DataSourcePivotTable

DataSourcePivotTable

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

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

メソッド

メソッド戻り値の型概要
addColumnGroup(columnName)PivotGroup指定されたデータソース列に基づいて新しいピボット列グループを追加します。
addFilter(columnName, filterCriteria)PivotFilter指定されたデータソースの列とフィルタ条件に基づいて、新しいフィルタを追加します。
addPivotValue(columnName)PivotValue集計関数を使用せずに、指定されたデータソース列に基づいて新しいピボット値を追加します。
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)

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

次のコードは、Looker の指標をピボット値として追加する方法を示しています。

// TODO(developer): Replace with your spreadsheet ID which has a Looker data
// source.
const spreadsheet = SpreadsheetApp.openById('abcd1234');
const datasource = spreadsheet.getDataSources()[0];
const pivotTable = datasource.createDataSourcePivotTableOnNewSheet();

pivotTable.addPivotValue('columnName');

このメソッドは Looker データソースでのみ使用できます。

パラメータ

名前タイプ説明
columnNameStringピボット値の基準となるデータソースの列名。

戻る

PivotValue - 新しいピボット値。

承認

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

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

addPivotValue(columnName, summarizeFunction)

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

Looker メジャーにピボット値を追加するには、addPivotValue(columnName) を使用します。

パラメータ

名前タイプ説明
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