Class DataSourcePivotTable

DataSourcePivotTable

Auf vorhandene Datenquellen-Pivot-Tabelle zugreifen und sie bearbeiten. Um eine neue Pivot-Tabelle für die Datenquelle zu erstellen, verwenden Sie Range.createDataSourcePivotTable(dataSource)

Verwenden Sie diese Klasse nur mit Daten, die mit einer Datenbank verbunden sind.

Methoden

MethodeRückgabetypKurzbeschreibung
addColumnGroup(columnName)PivotGroupFügt eine neue Pivot-Spaltengruppe basierend auf der angegebenen Datenquellenspalte hinzu.
addFilter(columnName, filterCriteria)PivotFilterFügt einen neuen Filter basierend auf der angegebenen Datenquellenspalte mit den angegebenen Filterkriterien hinzu.
addPivotValue(columnName)PivotValueFügt einen neuen Pivot-Wert basierend auf der angegebenen Datenquellenspalte ohne Zusammenfassung hinzu .
addPivotValue(columnName, summarizeFunction)PivotValueFügt einen neuen Pivot-Wert basierend auf der angegebenen Datenquellenspalte mit der angegebenen Zusammenfassung hinzu .
addRowGroup(columnName)PivotGroupHiermit wird eine neue Pivot-Zeilengruppe basierend auf der angegebenen Datenquellenspalte hinzugefügt.
asPivotTable()PivotTableGibt die Pivot-Tabelle der Datenquelle als reguläres Pivot-Tabellenobjekt zurück.
cancelDataRefresh()DataSourcePivotTableBricht die Datenaktualisierung für dieses Objekt ab, falls sie gerade ausgeführt wird.
forceRefreshData()DataSourcePivotTableAktualisiert die Daten dieses Objekts unabhängig vom aktuellen Status.
getDataSource()DataSourceRuft die Datenquelle ab, mit der das Objekt verknüpft ist.
getStatus()DataExecutionStatusRuft den Datenausführungsstatus des Objekts ab.
refreshData()DataSourcePivotTableAktualisiert die Daten des Objekts
waitForCompletion(timeoutInSeconds)DataExecutionStatusWartet, bis die aktuelle Ausführung abgeschlossen ist, wobei nach der angegebenen Anzahl von Sekunden eine Zeitüberschreitung auftritt.

Detaillierte Dokumentation

addColumnGroup(columnName)

Fügt eine neue Pivot-Spaltengruppe basierend auf der angegebenen Datenquellenspalte hinzu.

Parameter

NameTypBeschreibung
columnNameStringDer Name der Datenquellenspalte, auf der die Pivot-Gruppe basiert.

Rückflug

PivotGroup: Die neue Pivot-Gruppe.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

addFilter(columnName, filterCriteria)

Fügt einen neuen Filter basierend auf der angegebenen Datenquellenspalte mit den angegebenen Filterkriterien hinzu.

Parameter

NameTypBeschreibung
columnNameStringDer Name der Datenquellenspalte, auf der der Filter basiert.
filterCriteriaFilterCriteriaDie Kriterien, die vom Filter verwendet werden.

Rückflug

PivotFilter: Der neue Filter.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

addPivotValue(columnName)

Fügt einen neuen Pivot-Wert basierend auf der angegebenen Datenquellenspalte ohne Zusammenfassung hinzu . Nur für Looker-Messwerte.

Der folgende Code zeigt, wie Sie einen Looker-Messwert als Pivot-Wert hinzufügen können. 

// 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");

Diese Methode ist nur für Looker-Datenquellen verfügbar.

Parameter

NameTypBeschreibung
columnNameStringDer Name der Datenquellenspalte, auf der der Pivot-Wert basiert.

Rückflug

PivotValue: Der neue Pivot-Wert.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

addPivotValue(columnName, summarizeFunction)

Fügt einen neuen Pivot-Wert basierend auf der angegebenen Datenquellenspalte mit der angegebenen Zusammenfassung hinzu .

Verwenden Sie addPivotValue(columnName), um Pivot-Werte für Looker-Messwerte hinzuzufügen.

Parameter

NameTypBeschreibung
columnNameStringDer Name der Datenquellenspalte, auf der der Pivot-Wert basiert.
summarizeFunctionPivotTableSummarizeFunctionDie summarize-Funktion, die der Pivot-Wert verwendet.

Rückflug

PivotValue: Der neue Pivot-Wert.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

addRowGroup(columnName)

Hiermit wird eine neue Pivot-Zeilengruppe basierend auf der angegebenen Datenquellenspalte hinzugefügt.

Parameter

NameTypBeschreibung
columnNameStringDer Name der Datenquellenspalte, auf der die Pivot-Gruppe basiert.

Rückflug

PivotGroup: Die neue Pivot-Gruppe.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

asPivotTable()

Gibt die Pivot-Tabelle der Datenquelle als reguläres Pivot-Tabellenobjekt zurück.

Rückflug

PivotTable: Die Pivot-Tabelle.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

cancelDataRefresh()

Bricht die mit diesem Objekt verknüpfte Datenaktualisierung ab, wenn es gerade ausgeführt wird.

In diesem Beispiel wird gezeigt, wie Sie eine Formelaktualisierung abbrechen. 

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

Löst eine Ausnahme aus, wenn der Datenquellentyp nicht aktiviert ist. Mit SpreadsheetApp#enable...Execution()-Methoden die Datenausführung für eine bestimmte Datenquelle aktivieren Typ.

Rückflug

DataSourcePivotTable: Das Datenobjekt.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

forceRefreshData()

Aktualisiert die Daten dieses Objekts unabhängig vom aktuellen Status. refreshData() ansehen für erhalten Sie weitere Informationen. Informationen zum Abbrechen einer aktuell laufenden Aktualisierung dieses Objekts finden Sie unter cancelDataRefresh().

Löst eine Ausnahme aus, wenn der Datenquellentyp nicht aktiviert ist. Mit SpreadsheetApp#enable...Execution()-Methoden die Datenausführung für eine bestimmte Datenquelle aktivieren Typ.

Rückflug

DataSourcePivotTable: Das Datenobjekt.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getDataSource()

Ruft die Datenquelle ab, mit der das Objekt verknüpft ist.

Rückflug

DataSource: Die Datenquelle.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getStatus()

Ruft den Datenausführungsstatus des Objekts ab.

Rückflug

DataExecutionStatus: Der Status der Datenausführung.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

refreshData()

Aktualisiert die Daten des Objekts.

Löst eine Ausnahme aus, wenn sie sich derzeit im Status error befindet. Verwenden Sie DataSource#updateSpec(), um die Spezifikation zu aktualisieren. Die Methode ist gegenüber forceRefreshData() bevorzugt, um unerwartete Änderungen an der Datenquelle zu vermeiden.

Löst eine Ausnahme aus, wenn der Datenquellentyp nicht aktiviert ist. Mit SpreadsheetApp#enable...Execution()-Methoden die Datenausführung für eine bestimmte Datenquelle aktivieren Typ.

Rückflug

DataSourcePivotTable: Das Datenobjekt.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

waitForCompletion(timeoutInSeconds)

Es wird gewartet, bis die aktuelle Ausführung abgeschlossen ist. Nach der angegebenen Anzahl von Sekunden kommt es zu einer Zeitüberschreitung. Löst eine Ausnahme aus, wenn die Ausführung bei Ablauf der Zeitüberschreitung nicht abgeschlossen ist, bricht die Datenausführung aber nicht ab.

Parameter

NameTypBeschreibung
timeoutInSecondsIntegerDie Zeit in Sekunden, die auf die Datenausführung gewartet werden soll. Maximal sind 300 zulässig Sekunden.

Rückflug

DataExecutionStatus: Der Status der Datenausführung.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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