Class 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)

Добавляет новую группу сводных столбцов на основе указанного столбца источника данных.

Параметры

Имя Тип Описание
columnName String Имя столбца источника данных, на котором основана сводная группа.

Возвращаться

PivotGroup — новая сводная группа.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

addFilter(columnName, filterCriteria)

Добавляет новый фильтр на основе указанного столбца источника данных с указанными критериями фильтра.

Параметры

Имя Тип Описание
columnName String Имя столбца источника данных, на котором основан фильтр.
filterCriteria FilterCriteria Критерии, которые использует фильтр.

Возвращаться

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

pivotTable.addPivotValue("columnName");

Этот метод доступен только для источников данных Looker.

Параметры

Имя Тип Описание
columnName String Имя столбца источника данных, на котором основано сводное значение.

Возвращаться

PivotValue — Новое значение поворота.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

addPivotValue(columnName, summarizeFunction)

Добавляет новое сводное значение на основе указанного столбца источника данных с указанной функцией суммирования.

Чтобы добавить значения сводки для мер Looker, используйте addPivotValue(columnName) .

Параметры

Имя Тип Описание
columnName String Имя столбца источника данных, на котором основано сводное значение.
summarizeFunction PivotTableSummarizeFunction Функция суммирования, которую использует сводное значение.

Возвращаться

PivotValue — Новое значение поворота.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

addRowGroup(columnName)

Добавляет новую группу сводных строк на основе указанного столбца источника данных.

Параметры

Имя Тип Описание
columnName 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)

Ожидает завершения текущего выполнения, время ожидания истекает через указанное количество секунд. Вызывает исключение, если выполнение не завершено по истечении времени ожидания, но не отменяет выполнение данных.

Параметры

Имя Тип Описание
timeoutInSeconds Integer Время ожидания выполнения данных в секундах. Максимум — 300 секунд.

Возвращаться

DataExecutionStatus — Статус выполнения данных.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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