Для доступа к существующей сводной таблице источника данных и ее изменения. Чтобы создать новую сводную таблицу источника данных, используйте Range.createDataSourcePivotTable(dataSource) .
Используйте этот класс только с данными, подключенными к базе данных.
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
add Column Group(columnName) | Pivot Group | Добавляет новую группу столбцов сводной таблицы на основе указанного столбца источника данных. |
add Filter(columnName, filterCriteria) | Pivot Filter | Добавляет новый фильтр на основе указанного столбца источника данных с заданными критериями фильтрации. |
add Pivot Value(columnName) | Pivot Value | Добавляет новое значение сводной таблицы на основе указанного столбца источника данных без использования функции суммирования. |
add Pivot Value(columnName, summarizeFunction) | Pivot Value | Добавляет новое значение сводной таблицы на основе указанного столбца источника данных с использованием указанной функции суммирования. |
add Row Group(columnName) | Pivot Group | Добавляет новую группу строк сводной таблицы на основе указанного столбца источника данных. |
as Pivot Table() | Pivot Table | Возвращает сводную таблицу источника данных в виде обычного объекта сводной таблицы. |
cancel Data Refresh() | Data Source Pivot Table | Отменяет обновление данных, связанное с этим объектом, если оно в данный момент выполняется. |
force Refresh Data() | Data Source Pivot Table | Обновляет данные этого объекта независимо от его текущего состояния. |
get Data Source() | Data Source | Получает источник данных, к которому привязан объект. |
get Status() | Data Execution Status | Получает статус выполнения данных объекта. |
refresh Data() | Data Source Pivot Table | Обновляет данные объекта. |
wait For Completion(timeoutInSeconds) | Data Execution Status | Ожидает завершения текущего выполнения, истекая по истечении заданного количества секунд. |
Подробная документация
addColumnGroup(columnName)
Добавляет новую группу столбцов сводной таблицы на основе указанного столбца источника данных.
Параметры
| Имя | Тип | Описание |
|---|---|---|
column Name | String | Название столбца источника данных, на основе которого строится сводная группа. |
Возвращаться
PivotGroup — новая группа по созданию ключевых платформ.
Авторизация
Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
addFilter(columnName, filterCriteria)
Добавляет новый фильтр на основе указанного столбца источника данных с заданными критериями фильтрации.
Параметры
| Имя | Тип | Описание |
|---|---|---|
column Name | String | Название столбца источника данных, на основе которого работает фильтр. |
filter Criteria | Filter Criteria | Критерии, используемые фильтром. |
Возвращаться
PivotFilter — новый фильтр.
Авторизация
Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :
-
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.
Параметры
| Имя | Тип | Описание |
|---|---|---|
column Name | String | Название столбца источника данных, на основе которого строится сводная таблица. |
Возвращаться
PivotValue — новое значение для построения опорной точки.
Авторизация
Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
addPivotValue(columnName, summarizeFunction)
Добавляет новое значение сводной таблицы на основе указанного столбца источника данных с использованием указанной функции суммирования.
Для добавления сводных значений в меры Looker используйте addPivotValue(columnName) .
Параметры
| Имя | Тип | Описание |
|---|---|---|
column Name | String | Название столбца источника данных, на основе которого строится сводная таблица. |
summarize Function | Pivot Table Summarize Function | Функция суммирования, используемая в опорном значении. |
Возвращаться
PivotValue — новое значение для построения опорной точки.
Авторизация
Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
addRowGroup(columnName)
Добавляет новую группу строк сводной таблицы на основе указанного столбца источника данных.
Параметры
| Имя | Тип | Описание |
|---|---|---|
column Name | String | Название столбца источника данных, на основе которого строится сводная группа. |
Возвращаться
PivotGroup — новая группа по созданию ключевых платформ.
Авторизация
Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
asPivotTable()
Возвращает сводную таблицу источника данных в виде обычного объекта сводной таблицы.
Возвращаться
PivotTable — сводная таблица.
Авторизация
Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :
-
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 — объект данных.
Авторизация
Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
forceRefreshData()
Обновляет данные этого объекта независимо от его текущего состояния. Дополнительные сведения см. в refreshData() . Если вы хотите отменить текущее обновление этого объекта, см. cancelDataRefresh() .
Генерирует исключение, если тип источника данных не включен. Используйте методы SpreadsheetApp#enable...Execution() для включения выполнения данных для определенного типа источника данных.
Возвращаться
DataSourcePivotTable — объект данных.
Авторизация
Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getDataSource()
Получает источник данных, к которому привязан объект.
Возвращаться
DataSource — Источник данных.
Авторизация
Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getStatus()
Получает статус выполнения данных объекта.
Возвращаться
DataExecutionStatus — Статус выполнения данных.
Авторизация
Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
refreshData()
Обновляет данные объекта.
Генерирует исключение, если в данный момент находится в состоянии error . Используйте DataSource#updateSpec() для обновления спецификации. Этот метод предпочтительнее, чем forceRefreshData() чтобы предотвратить неожиданные изменения в источнике данных.
Генерирует исключение, если тип источника данных не включен. Используйте методы SpreadsheetApp#enable...Execution() для включения выполнения данных для определенного типа источника данных.
Возвращаться
DataSourcePivotTable — объект данных.
Авторизация
Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
waitForCompletion(timeoutInSeconds)
Ожидает завершения текущего выполнения, истекая по истечении заданного количества секунд. Генерирует исключение, если выполнение не завершается по истечении времени ожидания, но не отменяет выполнение данных.
Параметры
| Имя | Тип | Описание |
|---|---|---|
timeout In Seconds | Integer | Время ожидания обработки данных в секундах. Максимальное значение — 300 секунд. |
Возвращаться
DataExecutionStatus — Статус выполнения данных.
Авторизация
Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets