Pivot Tables

Tabela dinâmica

Uma tabela dinâmica.

Representação JSON
{
  "rows": [
    {
      object (PivotGroup)
    }
  ],
  "columns": [
    {
      object (PivotGroup)
    }
  ],
  "criteria": {
    integer: {
      object (PivotFilterCriteria)
    },
    ...
  },
  "filterSpecs": [
    {
      object (PivotFilterSpec)
    }
  ],
  "values": [
    {
      object (PivotValue)
    }
  ],
  "valueLayout": enum (PivotValueLayout),
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  },

  // Union field source_data can be only one of the following:
  "source": {
    object (GridRange)
  },
  "dataSourceId": string
  // End of list of possible types for union field source_data.
}
Campos
rows[]

object (PivotGroup)

Cada agrupamento de linhas na tabela dinâmica.

columns[]

object (PivotGroup)

Cada agrupamento de colunas na tabela dinâmica.

criteria
(deprecated)

map (key: integer, value: object ( PivotFilterCriteria))

Um mapeamento opcional de filtros por deslocamento da coluna de origem.

Os filtros são aplicados antes da agregação dos dados na tabela dinâmica. A chave do mapa é o deslocamento da coluna do intervalo de origem que você deseja filtrar, e o valor é o critério para aquela coluna.

Por exemplo, se a origem for C10:E15, uma chave de 0 terá o filtro para a coluna C, enquanto a chave 1 será para a coluna D.

Este campo está obsoleto e foi substituído por filterSpecs.

filterSpecs[]

object (PivotFilterSpec)

Os filtros aplicados às colunas de origem antes da agregação dos dados da tabela dinâmica.

Tanto criteria quanto filterSpecs são preenchidos nas respostas. Se ambos os campos forem especificados em uma solicitação de atualização, esse campo terá precedência.

values[]

object (PivotValue)

Uma lista de valores a serem incluídos na tabela dinâmica.

valueLayout

enum (PivotValueLayout)

Indica se os valores devem ser listados horizontalmente (como colunas) ou verticalmente (como linhas).

dataExecutionStatus

object (DataExecutionStatus)

Apenas saída. O status de execução de dados para tabelas dinâmicas de fonte de dados.

Campo de união source_data. A fonte dos dados da tabela dinâmica. source_data pode ser apenas uma das seguintes opções:
source

object (GridRange)

O intervalo do qual a tabela dinâmica está lendo dados.

dataSourceId

string

O código da fonte de dados em que a tabela dinâmica está lendo dados.

Grupo dinâmico

Um único agrupamento (linha ou coluna) em uma tabela dinâmica.

Representação JSON
{
  "showTotals": boolean,
  "valueMetadata": [
    {
      object (PivotGroupValueMetadata)
    }
  ],
  "sortOrder": enum (SortOrder),
  "valueBucket": {
    object (PivotGroupSortValueBucket)
  },
  "repeatHeadings": boolean,
  "label": string,
  "groupRule": {
    object (PivotGroupRule)
  },
  "groupLimit": {
    object (PivotGroupLimit)
  },

  // Union field source can be only one of the following:
  "sourceColumnOffset": integer,
  "dataSourceColumnReference": {
    object (DataSourceColumnReference)
  }
  // End of list of possible types for union field source.
}
Campos
showTotals

boolean

Verdadeiro se a tabela dinâmica precisar incluir os totais deste agrupamento.

valueMetadata[]

object (PivotGroupValueMetadata)

Metadados sobre valores no agrupamento.

sortOrder

enum (SortOrder)

A ordem em que os valores neste grupo devem ser classificados.

valueBucket

object (PivotGroupSortValueBucket)

O bucket do grupo dinâmico oposto ao qual classificar. Se não for especificado, a classificação será em ordem alfabética pelos valores deste grupo.

repeatHeadings

boolean

Verdadeiro se os cabeçalhos neste grupo dinâmico devem ser repetidos. Isso é válido apenas para agrupamentos de linhas e é ignorado pelas colunas.

Por padrão, minimizamos a repetição de cabeçalhos não mostrando cabeçalhos de nível superior onde eles são iguais. Por exemplo, mesmo que a terceira linha abaixo corresponda a "P1 Mar", "1T" não é mostrado porque é redundante com as linhas anteriores. A definição de repeatedHeadings como true faria com que "Q1" fosse repetido para "Fev" e "Mar".

+--------------+
| Q1     | Jan |
|        | Feb |
|        | Mar |
+--------+-----+
| Q1 Total     |
+--------------+
label

string

Os rótulos que serão usados nos grupos de linhas/colunas que podem ser personalizados. Por exemplo, na tabela dinâmica a seguir, o rótulo da linha é Region (que pode ser renomeado como State) e o rótulo da coluna é Product (que pode ser renomeado como Item). As tabelas dinâmicas criadas antes de dezembro de 2017 não têm rótulos de cabeçalho. Se você quiser adicionar rótulos de cabeçalho a uma tabela dinâmica existente, exclua a tabela dinâmica existente e crie uma nova tabela dinâmica com os mesmos parâmetros.

+--------------+---------+-------+
| SUM of Units | Product |       |
| Region       | Pen     | Paper |
+--------------+---------+-------+
| New York     |     345 |    98 |
| Oregon       |     234 |   123 |
| Tennessee    |     531 |   415 |
+--------------+---------+-------+
| Grand Total  |    1110 |   636 |
+--------------+---------+-------+
groupRule

object (PivotGroupRule)

A regra de grupo a ser aplicada ao grupo de linhas/colunas.

groupLimit

object (PivotGroupLimit)

O limite de contagem em linhas ou colunas a ser aplicado ao grupo dinâmico.

Campo de união source. A fonte de dados do grupo dinâmico. source pode ser apenas uma das seguintes opções:
sourceColumnOffset

integer

O deslocamento da coluna do intervalo de origem em que o agrupamento se baseia.

Por exemplo, se a origem for C10:E15, um sourceColumnOffset de 0 significa que esse grupo se refere à coluna C, enquanto o deslocamento 1 se refere à coluna D.

dataSourceColumnReference

object (DataSourceColumnReference)

A referência à coluna da fonte de dados na qual esse agrupamento é baseado.

PivotGroupValueMetadata

Metadados sobre um valor em um agrupamento dinâmico.

Representação JSON
{
  "value": {
    object (ExtendedValue)
  },
  "collapsed": boolean
}
Campos
value

object (ExtendedValue)

O valor calculado a que os metadados correspondem. Observe que formulaValue não é válido porque os valores serão calculados.

collapsed

boolean

Verdadeiro se os dados correspondentes ao valor estiverem recolhidos.

PivotGroupSortValueBucket

Informações sobre quais valores em um grupo dinâmico devem ser usados para classificação.

Representação JSON
{
  "valuesIndex": integer,
  "buckets": [
    {
      object (ExtendedValue)
    }
  ]
}
Campos
valuesIndex

integer

O deslocamento na lista PivotTable.values em que os valores neste agrupamento serão classificados.

buckets[]

object (ExtendedValue)

Determina o bucket em que os valores são escolhidos para classificação.

Por exemplo, em uma tabela dinâmica com um grupo de linhas e dois grupos de colunas, o grupo de linhas pode listar até dois valores. O primeiro valor corresponde a um valor no primeiro grupo de colunas e o segundo valor corresponde a um valor no segundo grupo de colunas. Se nenhum valor estiver listado, isso indica que a linha deve ser classificada de acordo com o "Total geral" nos grupos de colunas. Se um único valor estiver listado, isso corresponde ao uso do "Total" do bucket.

Regra de grupo dinâmico

Uma configuração opcional em um PivotGroup que define buckets para os valores na coluna de dados de origem em vez de detalhar cada valor individual. Somente uma PivotGroup com uma regra de grupo pode ser adicionada para cada coluna nos dados de origem. No entanto, em qualquer coluna, é possível adicionar um PivotGroup que tenha uma regra e um PivotGroup que não tenha.

Representação JSON
{

  // Union field rule can be only one of the following:
  "manualRule": {
    object (ManualRule)
  },
  "histogramRule": {
    object (HistogramRule)
  },
  "dateTimeRule": {
    object (DateTimeRule)
  }
  // End of list of possible types for union field rule.
}
Campos
Campo de união rule. A regra a ser aplicada ao PivotGroup. rule pode ser apenas uma das seguintes opções:
manualRule

object (ManualRule)

Um ManualRule.

histogramRule

object (HistogramRule)

Um HistogramRule.

dateTimeRule

object (DateTimeRule)

Um DateTimeRule.

Regra manual

Permite que você organize manualmente os valores em uma coluna de dados de origem em buckets com nomes de sua escolha. Por exemplo, uma tabela dinâmica que agrega a população por estado:

+-------+-------------------+
| State | SUM of Population |
+-------+-------------------+
| AK    |               0.7 |
| AL    |               4.8 |
| AR    |               2.9 |
...
+-------+-------------------+

poderia ser transformado em uma tabela dinâmica que agrega a população por fuso horário fornecendo uma lista de grupos (por exemplo, groupName = 'Central', items = ['AL', 'AR', 'IA', ...]) para uma regra de grupo manual. Para conseguir um efeito semelhante, adicione uma coluna de fuso horário aos dados de origem e ajuste a tabela dinâmica.

+-----------+-------------------+
| Time Zone | SUM of Population |
+-----------+-------------------+
| Central   |             106.3 |
| Eastern   |             151.9 |
| Mountain  |              17.4 |
...
+-----------+-------------------+
Representação JSON
{
  "groups": [
    {
      object (ManualRuleGroup)
    }
  ]
}
Campos
groups[]

object (ManualRuleGroup)

A lista dos nomes de grupos e os itens correspondentes dos dados de origem mapeados para cada nome de grupo.

Grupo de regras manuais

Um nome de grupo e uma lista de itens dos dados de origem que devem ser colocados no grupo com esse nome.

Representação JSON
{
  "groupName": {
    object (ExtendedValue)
  },
  "items": [
    {
      object (ExtendedValue)
    }
  ]
}
Campos
groupName

object (ExtendedValue)

O nome do grupo, que precisa ser uma string. Cada grupo em um determinado ManualRule precisa ter um nome de grupo exclusivo.

items[]

object (ExtendedValue)

Os itens nos dados de origem que devem ser colocados neste grupo. Cada item pode ser uma string, um número ou um booleano. Os itens podem aparecer em, no máximo, um grupo em um determinado ManualRule. Os itens que não forem exibidos em nenhum grupo aparecerão por conta própria.

HistogramRule

Permite que você organize os valores numéricos em uma coluna de dados de origem em buckets de tamanho constante. Todos os valores de HistogramRule.start a HistogramRule.end são colocados em grupos de tamanho HistogramRule.interval. Além disso, todos os valores abaixo de HistogramRule.start são colocados em um grupo, e todos os valores acima de HistogramRule.end são colocados em outro. Apenas HistogramRule.interval é obrigatório. No entanto, se HistogramRule.start e HistogramRule.end forem fornecidos, HistogramRule.start precisará ser menor que HistogramRule.end. Por exemplo, uma tabela dinâmica que mostra o valor médio da compra por idade com mais de 50 linhas:

+-----+-------------------+
| Age | AVERAGE of Amount |
+-----+-------------------+
| 16  |            $27.13 |
| 17  |             $5.24 |
| 18  |            $20.15 |
...
+-----+-------------------+

poderia ser transformado em uma tabela dinâmica semelhante à mostrada abaixo aplicando uma regra de grupo de histograma com HistogramRule.start de 25, HistogramRule.interval de 20 e HistogramRule.end de 65.

+-------------+-------------------+
| Grouped Age | AVERAGE of Amount |
+-------------+-------------------+
| < 25        |            $19.34 |
| 25-45       |            $31.43 |
| 45-65       |            $35.87 |
| > 65        |            $27.55 |
+-------------+-------------------+
| Grand Total |            $29.12 |
+-------------+-------------------+
Representação JSON
{
  "interval": number,
  "start": number,
  "end": number
}
Campos
interval

number

O tamanho dos buckets criados. Precisa ser positivo.

start

number

O valor mínimo em que os itens são colocados em segmentos de tamanho constante. Os valores abaixo do início são agrupados em um único bucket. Este campo é opcional.

end

number

O valor máximo em que os itens são colocados em buckets de tamanho constante. Os valores acima da extremidade são agrupados em um único bucket. Este campo é opcional.

DateTimeRule

Permite que você organize os valores de data e hora em uma coluna de dados de origem em intervalos com base nas partes selecionadas dos valores de data ou hora. Por exemplo, considere uma tabela dinâmica que mostra as transações de vendas por data:

+----------+--------------+
| Date     | SUM of Sales |
+----------+--------------+
| 1/1/2017 |      $621.14 |
| 2/3/2017 |      $708.84 |
| 5/8/2017 |      $326.84 |
...
+----------+--------------+

A aplicação de uma regra de grupo de data e hora com um DateTimeRuleType de YEAR_MONTH resulta na tabela dinâmica a seguir.

+--------------+--------------+
| Grouped Date | SUM of Sales |
+--------------+--------------+
| 2017-Jan     |   $53,731.78 |
| 2017-Feb     |   $83,475.32 |
| 2017-Mar     |   $94,385.05 |
...
+--------------+--------------+
Representação JSON
{
  "type": enum (DateTimeRuleType)
}
Campos
type

enum (DateTimeRuleType)

O tipo de agrupamento de data e hora a ser aplicado.

DateTimeRuleType

Os tipos disponíveis de regras de agrupamento de data e hora. Esta documentação pressupõe que a localidade da planilha é "en-US", embora a renderização real das datas e horas use a localidade da planilha para alguns tipos de regra.

Enums
DATE_TIME_RULE_TYPE_UNSPECIFIED O tipo padrão, não use.
SECOND Agrupe as datas por segundo de 0 a 59.
MINUTE Agrupe as datas por minuto, de 0 a 59.
HOUR Agrupe por hora usando um sistema de 24 horas, de 0 a 23.
HOUR_MINUTE Agrupe por hora e minuto usando um sistema de 24 horas, por exemplo, 19:45.
HOUR_MINUTE_AMPM Agrupe por hora e minuto usando um sistema de 12 horas, por exemplo 19h45. A designação AM/PM é traduzida com base na localidade da planilha.
DAY_OF_WEEK Datas do grupo por dia da semana, por exemplo, domingo. Os dias da semana serão traduzidos com base na localidade da planilha.
DAY_OF_YEAR Datas do grupo por dia do ano, de 1 a 366. As datas após 29 de fevereiro se enquadram em intervalos diferentes em anos bissextos e em anos não bissextos.
DAY_OF_MONTH Datas do grupo por dia do mês, de 1 a 31.
DAY_MONTH Agrupe datas por dia e mês, por exemplo, 22-nov. O mês é traduzido com base na localidade da planilha.
MONTH Datas de grupos por mês, por exemplo, novembro. O mês é traduzido com base na localidade da planilha.
QUARTER Datas do grupo por trimestre, por exemplo, 1o trimestre (que representa janeiro a março).
YEAR Datas de grupos por ano, por exemplo, 2008.
YEAR_MONTH Datas do grupo por ano e mês, por exemplo, 2008-nov. O mês é traduzido com base na localidade da planilha.
YEAR_QUARTER Datas do grupo por ano e trimestre, por exemplo, trimestre de 2008.
YEAR_MONTH_DAY Datas de grupos por ano, mês e dia, por exemplo, 2008-11-22.

PivotGroupLimit

O limite de contagem de linhas ou colunas no grupo dinâmico.

Representação JSON
{
  "countLimit": integer,
  "applyOrder": integer
}
Campos
countLimit

integer

O limite de contagem.

applyOrder

integer

A ordem em que o limite do grupo é aplicado à tabela dinâmica.

Os limites do grupo dinâmico são aplicados do número de pedido mais baixo para o mais alto. Os números de pedidos são normalizados para números inteiros consecutivos a partir de 0.

Para a solicitação de gravação, para personalizar totalmente os pedidos aplicados, todos os limites do grupo dinâmico devem ter este campo definido com um número exclusivo. Caso contrário, a ordem é determinada pelo índice na lista PivotTable.rows e, em seguida, na lista PivotTable.columns.

PivotFilterFilter

Critérios para mostrar/ocultar linhas em uma tabela dinâmica.

Representação JSON
{
  "visibleValues": [
    string
  ],
  "condition": {
    object (BooleanCondition)
  },
  "visibleByDefault": boolean
}
Campos
visibleValues[]

string

Valores que devem ser incluídos. Os valores não listados aqui são excluídos.

condition

object (BooleanCondition)

Uma condição que precisa ser verdadeira para os valores serem mostrados. visibleValues não substitui isso. Mesmo que um valor seja listado, ele ainda estará oculto se não atender à condição.

Os valores de condição que se referem a intervalos na notação A1 são avaliados em relação à página da tabela dinâmica. As referências são tratadas de forma absoluta e, portanto, não são preenchidas na tabela dinâmica. Por exemplo, o valor de condição =A1 em "Tabela dinâmica 1" é tratado como 'Pivot Table 1'!$A$1.

Os dados de origem da tabela dinâmica podem ser referenciados pelo nome do cabeçalho da coluna. Por exemplo, se os dados de origem tiverem colunas chamadas "Receita" e "Custo" e uma condição for aplicada à coluna "Receita" com o tipo NUMBER_GREATER e o valor =Cost, somente as colunas em que "Receita" > "Custo" serão incluídas.

visibleByDefault

boolean

Se os valores são visíveis por padrão. Se for verdadeiro, os visibleValues serão ignorados, todos os valores que atendem a condition (se especificado) serão mostrados. Se for falso, os valores que estão em visibleValues e atendem a condition são mostrados.

PivotFilterSpec

Os critérios de filtro da tabela dinâmica associados a um deslocamento de coluna de origem específico.

Representação JSON
{
  "filterCriteria": {
    object (PivotFilterCriteria)
  },

  // Union field source can be only one of the following:
  "columnOffsetIndex": integer,
  "dataSourceColumnReference": {
    object (DataSourceColumnReference)
  }
  // End of list of possible types for union field source.
}
Campos
filterCriteria

object (PivotFilterCriteria)

Os critérios da coluna.

Campo de união source. A coluna de origem à qual este filtro se aplica. source pode ser apenas uma das seguintes opções:
columnOffsetIndex

integer

O deslocamento da coluna de base do intervalo de origem.

dataSourceColumnReference

object (DataSourceColumnReference)

A referência à coluna da fonte de dados.

Valor dinâmico

A definição de como um valor em uma tabela dinâmica deve ser calculado.

Representação JSON
{
  "summarizeFunction": enum (PivotValueSummarizeFunction),
  "name": string,
  "calculatedDisplayType": enum (PivotValueCalculatedDisplayType),

  // Union field value can be only one of the following:
  "sourceColumnOffset": integer,
  "formula": string,
  "dataSourceColumnReference": {
    object (DataSourceColumnReference)
  }
  // End of list of possible types for union field value.
}
Campos
summarizeFunction

enum (PivotValueSummarizeFunction)

Uma função para resumir o valor. Se formula estiver definido, os únicos valores compatíveis serão SUM e CUSTOM. Se sourceColumnOffset estiver definido, CUSTOM não é compatível.

name

string

Um nome a ser usado para o valor.

calculatedDisplayType

enum (PivotValueCalculatedDisplayType)

Se especificado, indica que os valores dinâmicos devem ser exibidos como resultado de um cálculo com outro valor dinâmico. Por exemplo, se calculadoDisplayType for especificado como PERCENT_OF_GRAND_TOTAL, todos os valores dinâmicos serão exibidos como a porcentagem do total geral. No editor do Planilhas, isso é conhecido como "Mostrar como" na seção de valor de uma tabela dinâmica.

Campo de união value. Os dados a serem usados para os valores na tabela dinâmica. É preciso definir exatamente um valor. value pode ser apenas uma das seguintes opções:
sourceColumnOffset

integer

O deslocamento da coluna do intervalo de origem a partir do qual esse valor é lido.

Por exemplo, se a origem for C10:E15, um sourceColumnOffset de 0 significa que esse valor se refere à coluna C, enquanto o deslocamento 1 se refere à coluna D.

formula

string

Uma fórmula personalizada para calcular o valor. A fórmula precisa começar com um caractere =.

dataSourceColumnReference

object (DataSourceColumnReference)

A referência à coluna da fonte de dados em que esse valor é lido.

PivotValueSummarizeFunction

Uma função para resumir um valor dinâmico.

Enums
PIVOT_STANDARD_VALUE_FUNCTION_UNSPECIFIED O padrão, não use.
SUM Corresponde à função SUM.
COUNTA Corresponde à função COUNTA.
COUNT Corresponde à função COUNT.
COUNTUNIQUE Corresponde à função COUNTUNIQUE.
AVERAGE Corresponde à função AVERAGE.
MAX Corresponde à função MAX.
MIN Corresponde à função MIN.
MEDIAN Corresponde à função MEDIAN.
PRODUCT Corresponde à função PRODUCT.
STDEV Corresponde à função STDEV.
STDEVP Corresponde à função STDEVP.
VAR Corresponde à função VAR.
VARP Corresponde à função VARP.
CUSTOM Indica que a fórmula precisa ser usada no estado em que se encontra. Somente é válida se PivotValue.formula foi definida.

PivotValueCalculatedDisplayType

As possíveis formas de calcular os valores dinâmicos para exibição.

Enums
PIVOT_VALUE_CALCULATED_DISPLAY_TYPE_UNSPECIFIED Valor padrão, não use.
PERCENT_OF_ROW_TOTAL Mostra os valores dinâmicos como uma porcentagem dos valores totais da linha.
PERCENT_OF_COLUMN_TOTAL Mostra os valores dinâmicos como porcentagem dos valores totais da coluna.
PERCENT_OF_GRAND_TOTAL Mostra os valores dinâmicos como porcentagem dos valores totais gerais.

PivotValueLayout

O layout dos valores dinâmicos.

Enums
HORIZONTAL Os valores são apresentados horizontalmente (como colunas).
VERTICAL Os valores são apresentados verticalmente (como linhas).