Method: runPivotReport

Retorna um relatório dinâmico personalizado dos seus dados de eventos do Google Analytics. Os relatórios dinâmicos são formatos mais avançados e expressivos do que os relatórios regulares. Em um relatório dinâmico, as dimensões serão visíveis somente se estiverem incluídas em uma tabela dinâmica. Várias tabelas dinâmicas podem ser especificadas para analisar melhor seus dados.

Solicitação HTTP

POST https://analyticsdata.googleapis.com/v1alpha:runPivotReport

O URL usa a sintaxe de transcodificação gRPC.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "entity": {
    object (Entity)
  },
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "pivots": [
    {
      object (Pivot)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "returnPropertyQuota": boolean
}
Campos
entity

object (Entity)

Uma propriedade com eventos que são acompanhados. Em uma solicitação em lote, essa entidade deve ser não especificada ou consistente com a entidade no nível do lote.
dimensions[]

object (Dimension)

As dimensões solicitadas. Todas as dimensões definidas precisam ser usadas por uma das seguintes opções: dimensionExpression, dimensionFilter, pivots, orderBys.
metrics[]

object (Metric)

As métricas solicitadas. Pelo menos uma métrica precisa ser especificada. Todas as métricas definidas precisam ser usadas por uma das seguintes opções: metric_expression, metricFilter, orderBys.
dimensionFilter

object (FilterExpression)

A cláusula de filtro das dimensões. É necessário solicitar as dimensões para serem usadas nesse filtro. Não é possível usar métricas neste filtro.
metricFilter

object (FilterExpression)

A cláusula de filtro das métricas. Aplicado na fase pós-agregação, de forma semelhante à cláusula do SQL. As métricas precisam ser solicitadas para uso nesse filtro. Não é possível usar dimensões neste filtro.
pivots[]

object (Pivot)

Descreve o formato visual das dimensões do relatório em colunas ou linhas. A união dos fieldNames (nomes de dimensão) em todas as tabelas dinâmicas precisa ser um subconjunto dos nomes de dimensão definidos em "Dimensões". Duas tabelas dinâmicas não podem compartilhar uma dimensão. Uma dimensão só é visível quando aparece em uma tabela dinâmica.
dateRanges[]

object (DateRange)

O período em que os dados de eventos serão recuperados para o relatório. Se vários períodos forem especificados, os dados de eventos de cada período serão usados no relatório. Uma dimensão especial com o nome de campo "dateRange" podem ser incluídas nos nomes de campos de uma tabela dinâmica; se incluído, o relatório faz a comparação entre os períodos. Em uma solicitação de coorte, esse dateRanges precisa não ser especificado.
currencyCode

string

Um código de moeda no formato ISO4217, como "AED", "USD", "JPY". Se o campo estiver vazio, o relatório usará a moeda padrão da entidade.
cohortSpec

object (CohortSpec)

Grupo de coorte associado a esta solicitação. Se houver um grupo de coorte na solicitação, o campo "coort" a dimensão deve estar presente.
keepEmptyRows

boolean

Se for falso ou não especificado, cada linha com todas as métricas iguais a 0 não será retornada. Se verdadeiro, essas linhas serão retornadas se não forem removidas separadamente por um filtro.
returnPropertyQuota

boolean

Alterna se o estado atual da cota dessa propriedade do Google Analytics será retornado. A cota é retornada em PropertyQuota.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de RunPivotReportResponse.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics