Class DataSourcePivotTable

DataSourcePivotTable

Acceder a la tabla dinámica de la fuente de datos existente y modificarla Para crear una tabla dinámica de una nueva fuente de datos, usa Range.createDataSourcePivotTable(dataSource).

Solo usa esta clase con datos conectados a una base de datos.

Métodos

MétodoTipo de datos que se devuelveDescripción breve
addColumnGroup(columnName)PivotGroupAgrega un nuevo grupo de columnas dinámicas según la columna de la fuente de datos especificada.
addFilter(columnName, filterCriteria)PivotFilterAgrega un filtro nuevo basado en la columna de la fuente de datos especificada con los criterios de filtro especificados.
addPivotValue(columnName)PivotValueAgrega un nuevo valor de dinamización basado en la columna de la fuente de datos especificada sin ninguna función de resumen.
addPivotValue(columnName, summarizeFunction)PivotValueAgrega un nuevo valor de dinamización basado en la columna de la fuente de datos especificada con la función de resumen especificada.
addRowGroup(columnName)PivotGroupAgrega un nuevo grupo de filas de tabla dinámica según la columna de la fuente de datos especificada.
asPivotTable()PivotTableDevuelve la tabla dinámica de la fuente de datos como un objeto de tabla dinámica normal.
cancelDataRefresh()DataSourcePivotTableCancela la actualización de datos asociada a este objeto si se está ejecutando.
forceRefreshData()DataSourcePivotTableActualiza los datos de este objeto, independientemente del estado actual.
getDataSource()DataSourceObtiene la fuente de datos a la que está vinculado el objeto.
getStatus()DataExecutionStatusObtiene el estado de ejecución de datos del objeto.
refreshData()DataSourcePivotTableActualiza los datos del objeto.
waitForCompletion(timeoutInSeconds)DataExecutionStatusEspera hasta que se complete la ejecución actual y se agota el tiempo de espera después de la cantidad de segundos proporcionada.

Documentación detallada

addColumnGroup(columnName)

Agrega un nuevo grupo de columnas dinámicas según la columna de la fuente de datos especificada.

Parámetros

NombreTipoDescripción
columnNameStringEs el nombre de la columna de la fuente de datos en la que se basa el grupo de la tabla dinámica.

Volver

PivotGroup: Es el nuevo grupo de segmentación.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

addFilter(columnName, filterCriteria)

Agrega un filtro nuevo basado en la columna de la fuente de datos especificada con los criterios de filtro especificados.

Parámetros

NombreTipoDescripción
columnNameStringEs el nombre de la columna de la fuente de datos en la que se basa el filtro.
filterCriteriaFilterCriteriaSon los criterios que usa el filtro.

Volver

PivotFilter: Es el filtro nuevo.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

addPivotValue(columnName)

Agrega un nuevo valor de dinamización basado en la columna de la fuente de datos especificada sin ninguna función de resumen. Solo para medidas de Looker.

En el siguiente código, se muestra cómo puedes agregar una medida de Looker como valor de tabla dinámica. 

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

Este método solo está disponible para las fuentes de datos de Looker.

Parámetros

NombreTipoDescripción
columnNameStringEs el nombre de la columna de la fuente de datos en la que se basa el valor de la tabla dinámica.

Volver

PivotValue: Es el nuevo valor de pivote.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

addPivotValue(columnName, summarizeFunction)

Agrega un nuevo valor de dinamización basado en la columna de la fuente de datos especificada con la función de resumen especificada.

Para agregar valores de pivote a las medidas de Looker, usa addPivotValue(columnName).

Parámetros

NombreTipoDescripción
columnNameStringEs el nombre de la columna de la fuente de datos en la que se basa el valor de la tabla dinámica.
summarizeFunctionPivotTableSummarizeFunctionEs la función de resumen que usa el valor de la tabla dinámica.

Volver

PivotValue: Es el nuevo valor de pivote.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

addRowGroup(columnName)

Agrega un nuevo grupo de filas de tabla dinámica según la columna de la fuente de datos especificada.

Parámetros

NombreTipoDescripción
columnNameStringEs el nombre de la columna de la fuente de datos en la que se basa el grupo de la tabla dinámica.

Volver

PivotGroup: Es el nuevo grupo de segmentación.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

asPivotTable()

Devuelve la tabla dinámica de la fuente de datos como un objeto de tabla dinámica normal.

Volver

PivotTable: La tabla dinámica.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

cancelDataRefresh()

Cancela la actualización de datos asociada a este objeto si se está ejecutando.

En este ejemplo, se muestra cómo cancelar una actualización de fórmula. 

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

Se arroja una excepción si el tipo de fuente de datos no está habilitado. Usa los métodos SpreadsheetApp#enable...Execution() para habilitar la ejecución de datos para un tipo de fuente de datos específico.

Volver

DataSourcePivotTable: Es el objeto de datos.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

forceRefreshData()

Actualiza los datos de este objeto, independientemente del estado actual. Consulta refreshData() para obtener más detalles. Si quieres cancelar una actualización en ejecución de este objeto, consulta cancelDataRefresh().

Se arroja una excepción si el tipo de fuente de datos no está habilitado. Usa los métodos SpreadsheetApp#enable...Execution() para habilitar la ejecución de datos para un tipo de fuente de datos específico.

Volver

DataSourcePivotTable: Es el objeto de datos.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getDataSource()

Obtiene la fuente de datos a la que está vinculado el objeto.

Volver

DataSource: Es la fuente de datos.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getStatus()

Obtiene el estado de ejecución de datos del objeto.

Volver

DataExecutionStatus: Es el estado de ejecución de los datos.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

refreshData()

Actualiza los datos del objeto.

Arroja una excepción si actualmente se encuentra en el estado error. Usa DataSource#updateSpec() para actualizar la especificación. Se prefiere el método forceRefreshData() en lugar de forceRefreshData() para evitar ediciones inesperadas en la fuente de datos.

Se arroja una excepción si el tipo de fuente de datos no está habilitado. Usa los métodos SpreadsheetApp#enable...Execution() para habilitar la ejecución de datos para un tipo de fuente de datos específico.

Volver

DataSourcePivotTable: Es el objeto de datos.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

waitForCompletion(timeoutInSeconds)

Espera hasta que se complete la ejecución actual y se agota el tiempo de espera después de la cantidad de segundos proporcionada. Arroja una excepción si la ejecución no se completa cuando se agota el tiempo de espera, pero no cancela la ejecución de datos.

Parámetros

NombreTipoDescripción
timeoutInSecondsIntegerTiempo de espera para la ejecución de datos, en segundos. El máximo es de 300 segundos.

Volver

DataExecutionStatus: Es el estado de ejecución de los datos.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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