Method: properties.batchRunPivotReports

Retorna vários relatórios dinâmicos em lote. Todos os relatórios precisam ser da mesma propriedade do Google Analytics.

Solicitação HTTP

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

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

Parâmetros de caminho

Parâmetros
property

string

Um identificador de propriedade do Google Analytics cujos eventos são rastreados. Especificado no caminho do URL e não no corpo. Para saber mais, consulte Onde encontrar o ID da propriedade. Essa propriedade precisa ser especificada para o lote. A propriedade em RunPivotReportRequest pode não ser especificada ou ser consistente com essa propriedade.

Exemplo: properties/1234

Corpo da solicitação

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

Representação JSON 
{
  "requests": [
    {
      object (RunPivotReportRequest)
    }
  ]
}
Campos
requests[]

object (RunPivotReportRequest)

Solicitações individuais. Cada solicitação tem uma resposta de relatório dinâmico separada. Cada solicitação em lote pode ter até cinco solicitações.

Corpo da resposta

A resposta em lote que contém vários relatórios dinâmicos.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "pivotReports": [
    {
      object (RunPivotReportResponse)
    }
  ],
  "kind": string
}
Campos
pivotReports[]

object (RunPivotReportResponse)

Respostas individuais. Cada resposta tem uma solicitação de relatório dinâmico separada.
kind

string

Identifica o tipo de recurso da mensagem. Esse kind é sempre a string fixa "analyticsData#batchRunPivotReports". Útil para distinguir entre tipos de resposta em JSON.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

RunPivotReportRequest

A solicitação para gerar um relatório dinâmico.

Representação JSON 
{
  "property": string,
  "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,
  "comparisons": [
    {
      object (Comparison)
    }
  ]
}
Campos
property

string

Um identificador de propriedade do Google Analytics cujos eventos são rastreados. Especificado no caminho do URL e não no corpo. Para saber mais, consulte Onde encontrar o ID da propriedade. Em uma solicitação em lote, essa propriedade precisa não ser especificada ou ser consistente com a propriedade no nível do lote.

Exemplo: properties/1234
dimensions[]

object (Dimension)

As dimensões solicitadas. Todas as dimensões definidas precisam ser usadas por um dos seguintes: 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 um dos seguintes: metric_expression, metricFilter, orderBys.
dateRanges[]

object (DateRange)

O período para recuperar dados de eventos do 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" pode ser incluída nos nomes de campo de um pivô. Se incluída, 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 dos fieldNames (nomes de dimensões) em todos os pivôs precisa ser um subconjunto de nomes de dimensões definidos em Dimensões. Dois pivôs não podem compartilhar uma dimensão. Uma dimensão só fica visível se aparecer em um pivô.
dimensionFilter

object (FilterExpression)

A cláusula de filtro de dimensões. As dimensões precisam ser solicitadas para serem usadas nesse filtro. As métricas não podem ser usadas nesse filtro.
metricFilter

object (FilterExpression)

A cláusula de filtro de métricas. Aplicada na fase de pós-agregação, semelhante à cláusula "having" do SQL. As métricas precisam ser solicitadas para serem usadas nesse filtro. As dimensões não podem ser usadas nesse filtro.
currencyCode

string

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

object (CohortSpec)

Grupo de coortes associado a essa solicitação. Se houver um grupo de coortes na solicitação, a dimensão "coorte" precisa 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 for verdadeiro, essas linhas serão retornadas se não forem removidas separadamente por um filtro.

Independente dessa configuração keepEmptyRows, apenas os dados registrados pela propriedade do Google Analytics podem ser mostrados 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á um evento de linha eventName: "purchase" e eventCount: 0.
returnPropertyQuota

boolean

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

object (Comparison)

Opcional. A configuração das comparações solicitadas e mostradas. A solicitação exige um campo de comparações e uma dimensão de comparações para receber uma coluna de comparação na resposta.