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 é o critério dessa 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.

O uso desse campo foi descontinuado e substituído por filterSpecs.

filterSpecs[]

object (PivotFilterSpec)

Os filtros aplicados às colunas de origem antes de agregar dados para a tabela dinâmica.

Tanto criteria quanto filterSpecs são preenchidos nas respostas. Se os dois 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 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 de um dos tipos a seguir:
source

object (GridRange)

O intervalo de leitura dos dados da tabela dinâmica.

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 tiver que incluir os totais do 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 a ser classificado. Se não for especificado, a classificação será ordenada em ordem alfabética pelos valores deste grupo.

repeatHeadings

boolean

Verdadeiro se os títulos neste grupo dinâmico forem repetidos. Isso só é válido 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ível superior onde são iguais. Por exemplo, mesmo que a terceira linha abaixo corresponda a "T1 mar", "Q1" não é mostrado porque é redundante com as linhas anteriores. Definir repeatTítulos como verdadeiro faria com que "Q1" fosse repetido para "Fev" 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 de linha é Region (que pode ser renomeado como State) e o rótulo da coluna é Product (que pode ser renomeado como Item). 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, em seguida, 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 que será aplicada ao grupo de linhas/colunas.

groupLimit

object (PivotGroupLimit)

É o limite de contagem de linhas ou colunas que será aplicado a este grupo dinâmico.

Campo de união source. A fonte de dados do grupo dinâmico. source pode ser apenas de um dos tipos a seguir:
sourceColumnOffset

integer

O deslocamento da coluna do intervalo de origem em que esse agrupamento é baseado.

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 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 lista PivotTable.values pelo qual os valores desse agrupamento serão 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 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, ele corresponde ao uso do "Total" desse 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. Somente um PivotGroup com uma regra de grupo pode ser adicionado para cada coluna nos dados de origem. No entanto, em qualquer coluna, é possível adicionar um PivotGroup que tem uma regra e um 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 ao PivotGroup. rule pode ser apenas de um dos tipos a seguir:
manualRule

object (ManualRule)

ManualRule

histogramRule

object (HistogramRule)

HistogramRule

dateTimeRule

object (DateTimeRule)

DateTimeRule

ManualRule

Permite organizar manualmente os valores de 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 adicionando uma coluna de fuso horário aos dados de origem e ajustando 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 cada nome de 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 em uma determinada ManualRule. Os itens que não aparecem em nenhum grupo aparecem individualmente.

HistogramRule

Permite organizar 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. Somente 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 de compra por idade com mais de 50 linhas:

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

poderia ser transformada em uma tabela dinâmica semelhante à mostrada abaixo, aplicando uma regra de grupo de histograma com HistogramRule.start de 25, um HistogramRule.interval de 20 e um 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 intervalos 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 intervalos de tamanho constante. Os valores acima da extremidade são agrupados em um único grupo. Este campo é opcional.

DateTimeRule

Permite organizar os valores de data e hora em uma coluna de dados de origem em buckets com base nas partes selecionadas dos valores de data ou hora. Por exemplo, considere uma tabela dinâmica que mostra 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 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 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 Agrupar datas por minuto, de 0 a 59.
HOUR Agrupe as datas por hora usando um sistema de 24 horas, de 0 a 23.
HOUR_MINUTE Agrupe as datas por hora e minuto usando um sistema de 24 horas, por exemplo, 19h45.
HOUR_MINUTE_AMPM Agrupe as 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, por exemplo, domingo. Os dias da semana serão traduzidos com base na localidade da planilha.
DAY_OF_YEAR Agrupe as datas por dia do ano, de 1 a 366. As datas posteriores a 29 de fevereiro têm intervalos diferentes em anos bissextos do que em anos não bissextos.
DAY_OF_MONTH Agrupe as datas por dia do mês, de 1 a 31.
DAY_MONTH Agrupe as datas por dia e mês, por exemplo, 22-nov. O mês é traduzido com base na localidade da planilha.
MONTH Agrupe as datas por mês, como novembro. O mês é traduzido com base na localidade da planilha.
QUARTER Agrupe as datas por trimestre, por exemplo, Q1 (que representa janeiro a março).
YEAR Agrupar datas por ano, como 2008.
YEAR_MONTH Agrupe as datas por ano e mês, por exemplo, de 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 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 dos grupos dinâmicos são aplicados do número do pedido menor para o maior. Números de ordem são normalizados para números inteiros consecutivos a partir de 0.

Para solicitações de gravação, para personalizar totalmente os pedidos aplicados, todos os limites de grupos dinâmicos precisam ter esse 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.

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 precisam ser incluídos. 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, 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 absolutamente e, por isso, não são preenchidas na tabela dinâmica. Por exemplo, o valor de condição =A1 na "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

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

PivotFilterSpec

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

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 a que este filtro se aplica. source pode ser apenas de um dos tipos a seguir:
columnOffsetIndex

integer

O deslocamento da coluna com base 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 estiver definido, os únicos valores compatíveis serão SUM e CUSTOM. Se sourceColumnOffset estiver definido, CUSTOM não será aceito.

name

string

Um nome a ser usado como 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 mostrados 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 deve ser definido. value pode ser apenas de um dos tipos a seguir:
sourceColumnOffset

integer

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

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 que esse valor lê.

PivotValueSummarizeFunction

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

Enums
PIVOT_STANDARD_VALUE_FUNCTION_UNSPECIFIED O padrão, não usar.
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. Válida apenas se PivotValue.formula estiver definido.
NONE Indica que o valor já está resumido e que a função de resumo não está especificada explicitamente. Usado para tabelas dinâmicas de fonte de dados do Looker em que o valor já está resumido.

PivotValueCalculatedDisplayType

As possíveis 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 dos valores dinâmicos.

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