Method: properties.batchRunPivotReports

Retorna vários relatórios dinâmicos em um lote. Todos os relatórios precisam ser relacionados à mesma propriedade do GA4.

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 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. Essa propriedade deve ser especificada para o lote. A propriedade em RunPivotReportRequest pode não ser especificada ou consistente com ela.

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

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

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

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 diferente.
kind

string

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

Escopos de autorização

Requer um dos seguintes escopos de 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
}
Campos
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
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.