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.
var spreadsheet = SpreadsheetApp.openById("abcd1234")
var datasource = spreadsheet.getDataSources()[0];
var 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