Pivot Tables

PivotTable

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 de agregar os dados na tabela dinâmica. A chave do mapa é o deslocamento da coluna do intervalo de origem que você quer filtrar, e o valor são os critérios dessa coluna.

Por exemplo, se a fonte era C10:E15, uma chave de 0 terão o filtro para a coluna, C, enquanto a chave 1 é 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 de agregar os dados à tabela dinâmica.

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

values[]

object (PivotValue)

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

valueLayout

enum (PivotValueLayout)

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

dataExecutionStatus

object (DataExecutionStatus)

Apenas saída. O status de execução dos dados das tabelas dinâmicas da 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 os dados.

dataSourceId

string

O ID da fonte de dados da qual a tabela dinâmica está lendo os dados.

PivotGroup

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 desse agrupamento.

valueMetadata[]

object (PivotGroupValueMetadata)

Metadados sobre valores no agrupamento.

sortOrder

enum (SortOrder)

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

valueBucket

object (PivotGroupSortValueBucket)

O bucket do grupo dinâmico oposto para classificação. Se não for especificada, a classificação será em ordem alfabética pelos valores desse grupo.

repeatHeadings

boolean

Verdadeiro se os títulos deste grupo dinâmico precisarem ser repetidos. Isso é válido apenas para agrupamentos de linhas e é ignorado pelas colunas.

Por padrão, minimizamos a repetição de títulos ao não mostrar cabeçalhos de níveis superiores onde são iguais. Por exemplo, embora a terceira linha abaixo corresponda a "T1 Mar", "T1" não é mostrado porque é redundante com as linhas anteriores. Definir "repeatHeadings" como "true" causaria "Q1" a ser repetido para "fevereiro" e "Mar". 

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

string

Os rótulos a serem usados para os 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 renomeada como State) e o rótulo da coluna é Product (que pode ser renomeada 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 a este grupo de linhas/colunas.

groupLimit

object (PivotGroupLimit)

O limite de contagem em linhas ou colunas que serão aplicadas a este 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 de coluna do intervalo de origem em que esse agrupamento se baseia.

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

dataSourceColumnReference

object (DataSourceColumnReference)

A referência à coluna da fonte de dados na qual esse agrupamento se baseia.

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 ao qual 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 PivotTable.values lista pelos quais os valores nesse agrupamento devem ser classificados.

buckets[]

object (ExtendedValue)

Determina o bucket a partir do qual os valores são escolhidos para classificação.

Por exemplo, em uma tabela dinâmica com um grupo de linhas & 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" sobre os grupos de colunas. Se um único valor for listado, isso corresponderia ao uso do atributo "Total" do bucket.

PivotGroupRule

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. Só um PivotGroup com uma regra de grupo pode ser adicionada para cada coluna nos dados de origem, embora em qualquer coluna você possa adicionar uma PivotGroup que tem uma regra PivotGroup que não tem.

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 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:

ManualRule

Permite organizar 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 transformada em uma tabela dinâmica que agrega a população por fuso horário, fornecendo uma lista de grupos (por exemplo, groupName = 'Central', itens = ['AL', 'AR', 'IA', ...]) para uma regra de grupo manual. Um efeito semelhante pode ser alcançado ao adicionar uma coluna de fuso horário aos dados de origem e ajustar 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 de nomes de grupos e os itens correspondentes dos dados de origem que mapeiam para o nome de cada grupo.

ManualRuleGroup

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 nesse grupo. Cada item pode ser uma string, um número ou um booleano. Os itens podem aparecer em, no máximo, um grupo de um determinado grupo ManualRule: Os itens que não aparecem em nenhum grupo aparecem por conta própria.

HistogramRule

Permite organizar os valores numéricos de uma coluna de dados de origem em intervalos de tamanho constante. Todos os valores de HistogramRule.start para HistogramRule.end são colocados em grupos de tamanhos HistogramRule.interval Além disso, todos os valores abaixo HistogramRule.start são colocados em um grupo, e todos os valores acima HistogramRule.end são colocados em outra. Somente HistogramRule.interval é obrigatório, mas se HistogramRule.start e HistogramRule.end forem fornecidos, HistogramRule.start deve ser menor que HistogramRule.end. Por exemplo, uma tabela dinâmica que mostra o valor médio de compra por idade com mais de 50 linhas: 

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

em uma tabela dinâmica, semelhante à mostrada abaixo, aplicando uma regra de grupo de histogramas com HistogramRule.start de 25, um HistogramRule.interval de 20, e uma 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 buckets de tamanho constante. Os valores abaixo de start 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 de end são agrupados em um único bucket. Este campo é opcional.

DateTimeRule

Permite organizar 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-hora com um DateTimeRuleType de YEAR_MONTH resultados na seguinte tabela dinâmica. 

+--------------+--------------+
| 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 presume 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 regras.

Enums
DATE_TIME_RULE_TYPE_UNSPECIFIED O tipo padrão, não usar.
SECOND Agrupar datas por segundo, de 0 a 59.
MINUTE Agrupe as datas por minuto, de 0 a 59.
HOUR Agrupe datas por hora usando um sistema de 24 horas, de 0 a 23.
HOUR_MINUTE Agrupar datas por hora e minuto usando um sistema de 24 horas, por exemplo, 19h45.
HOUR_MINUTE_AMPM Agrupe datas 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 Agrupe as datas por dia da semana, como domingo. Os dias da semana são traduzidos com base na localidade da planilha.
DAY_OF_YEAR Agrupe as datas por dia do ano, de 1 a 366. Observe que as datas posteriores a 29 de fevereiro caem em intervalos diferentes em anos bissextos e em anos não bissextos.
DAY_OF_MONTH Agrupe as datas por dia do mês, de 1 a 31.
DAY_MONTH Agrupar datas por dia e mês, por exemplo, 22 a novembro. O mês é traduzido com base na localidade da planilha.
MONTH Agrupar datas por mês, por exemplo, novembro. O mês é traduzido com base na localidade da planilha.
QUARTER Agrupe as datas por trimestre, por exemplo, no 1o trimestre (que representa de janeiro a março).
YEAR Agrupar datas por ano, por exemplo, 2008.
YEAR_MONTH Agrupe as datas por ano e mês, por exemplo, 2008 a novembro. O mês é traduzido com base na localidade da planilha.
YEAR_QUARTER Agrupe as datas por ano e trimestre, por exemplo, 4o trimestre de 2008.
YEAR_MONTH_DAY Agrupe as datas por ano, mês e dia, por exemplo, 2008-11-22.

PivotGroupLimit

O limite de contagem em 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 dos grupos dinâmicos são aplicados do número de ordem menor para o maior. Números de ordem são normalizados para números inteiros consecutivos a partir de 0.

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

PivotFilterCriteria

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 que os valores sejam mostrados. ( visibleValues não substitui isso. Mesmo que um valor esteja listado lá, ele ainda ficará 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, um valor de condição de =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 com o nome "Receita" e "Custo" e uma condição é aplicada ao campo "Receita" coluna com tipo NUMBER_GREATER e valor =Cost, então apenas as colunas em que "Receita" &gt; "Custo" estão incluídas.

visibleByDefault

boolean

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

PivotFilterSpec

Os critérios de filtro da tabela dinâmica associados a um deslocamento da 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 de coluna baseado em zero do intervalo de origem.

dataSourceColumnReference

object (DataSourceColumnReference)

A referência à coluna da fonte de dados.

PivotValue

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 for definido, os únicos valores compatíveis serão SUM e CUSTOM Se sourceColumnOffset estiver definido, CUSTOM não tem suporte.

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 computeDisplayType 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 é chamado de "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. Exatamente um valor precisa ser definido. value pode ser apenas uma das seguintes opções:
sourceColumnOffset

integer

O deslocamento da coluna do intervalo de origem que esse valor lê.

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

formula

string

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

dataSourceColumnReference

object (DataSourceColumnReference)

A referência à coluna da fonte de dados usada para a leitura desse valor.

PivotValueSummarizeFunction

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

Enums
PIVOT_STANDARD_VALUE_FUNCTION_UNSPECIFIED O padrão, não usar.
SUM Corresponde ao SUM função.
COUNTA Corresponde ao COUNTA função.
COUNT Corresponde ao COUNT função.
COUNTUNIQUE Corresponde ao COUNTUNIQUE função.
AVERAGE Corresponde ao AVERAGE função.
MAX Corresponde ao MAX função.
MIN Corresponde ao MIN função.
MEDIAN Corresponde ao MEDIAN função.
PRODUCT Corresponde ao PRODUCT função.
STDEV Corresponde ao STDEV função.
STDEVP Corresponde ao STDEVP função.
VAR Corresponde ao VAR função.
VARP Corresponde ao VARP função.
CUSTOM Indica que a fórmula deve ser usada no estado em que se encontra. Válido apenas se PivotValue.formula foi definido.
NONE Indica que o valor já foi resumido e que a função de resumo não está explicitamente especificada. Usado para tabelas dinâmicas de fonte de dados do Looker em que o valor já está resumido.

PivotValueCalculatedDisplayType

As maneiras como os valores dinâmicos podem ser calculados para exibição.

Enums
PIVOT_VALUE_CALCULATED_DISPLAY_TYPE_UNSPECIFIED Valor padrão, não usar.
PERCENT_OF_ROW_TOTAL Mostra os valores dinâmicos como porcentagem dos valores totais das linhas.
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 de valores dinâmicos.

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