Method: properties.runPivotReport

Retorna um relatório dinâmico personalizado dos seus dados de eventos do Google Analytics. Relatórios dinâmicos são formatos mais avançados e expressivos do que relatórios normais. Em um relatório dinâmico, as dimensões só estarão visíveis se estiverem incluídas em uma tabela dinâmica. É possível especificar várias tabelas dinâmicas para analisar melhor seus dados.

Solicitação HTTP

POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:runPivotReport

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

Parâmetros de caminho

Parâmetros
property

string

Um identificador de propriedade do GA4 do Google Analytics cujos eventos são rastreados. Especificada no caminho do URL e não no corpo. Para saber mais, veja onde encontrar o ID da propriedade. Em uma solicitação em lote, essa propriedade não deve ser especificada nem consistente com a propriedade no nível do lote.

Exemplo: properties/1234

Corpo da solicitação

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

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

object (Dimension)

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

object (Metric)

É necessário especificar pelo menos uma métrica solicitada. Todas as métricas definidas precisam ser usadas por uma das seguintes opções: metric_expression, metricFilter, orderBys.
dateRanges[]

object (DateRange)

O período para recuperar dados de evento para o relatório. Se vários períodos forem especificados, os dados de evento de cada período serão usados no relatório. Uma dimensão especial com o nome de campo "dateRange" pode ser incluída nos nomes de campo de uma tabela dinâmica. Se incluído, o relatório compara os períodos. Em uma solicitação de coorte, esse dateRanges não pode ser especificado.
pivots[]

object (Pivot)

Descreve o formato visual das dimensões do relatório em colunas ou linhas. A união de fieldNames (nomes de dimensão) em todas as tabelas dinâmicas precisa ser um subconjunto dos nomes de dimensão definidos em "Dimensões". Não é possível compartilhar uma dimensão com duas tabelas dinâmicas. Uma dimensão só será visível se aparecer em uma tabela dinâmica.
dimensionFilter

object (FilterExpression)

A cláusula de filtro de dimensões. As dimensões precisam ser solicitadas para serem usadas nesse filtro. Não é possível usar métricas neste filtro.
metricFilter

object (FilterExpression)

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

string

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

object (CohortSpec)

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

boolean

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

Independentemente dessa configuração de keepEmptyRows, somente dados registrados pela propriedade do Google Analytics (GA4) podem ser exibidos em um relatório.

Por exemplo, se uma propriedade nunca registrar um evento purchase, uma consulta para a dimensão eventName e a métrica eventCount não terá uma linha eventName: "purchase" e eventCount: 0.
returnPropertyQuota

boolean

Define se deve retornar o estado atual da cota desta propriedade do Google Analytics. 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 de OAuth:

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