Method: properties.batchRunReports

Retorna vários relatórios em um lote. Todos os relatórios precisam ser da mesma propriedade do GA4.

Solicitação HTTP

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

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 com eventos rastreados. Especificado no caminho do URL, e não no corpo. Para saber mais, confira onde encontrar o ID da propriedade. Essa propriedade deve ser especificada para o lote. A propriedade em RunReportRequest 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 (RunReportRequest)
    }
  ]
}
Campos
requests[]

object (RunReportRequest)

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

Corpo da resposta

A resposta em lote contendo vários relatórios.

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

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

object (RunReportResponse)

Respostas individuais. Cada resposta tem uma solicitação de relatório diferente.

kind

string

Identifica o tipo de recurso da mensagem. Este kind é sempre a string fixa "analyticsData#batchRunReports". Útil para distinguir entre 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

RunReportRequest

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

Representação JSON
{
  "property": string,
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "offset": string,
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "returnPropertyQuota": boolean
}
Campos
property

string

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

Exemplo: properties/1234

dimensions[]

object (Dimension)

As dimensões solicitadas e exibidas.

metrics[]

object (Metric)

As métricas solicitadas e exibidas.

dateRanges[]

object (DateRange)

Períodos de dados a serem lidos. Se vários períodos forem solicitados, cada linha de resposta terá um índice de período baseado em zero. Se dois períodos se sobrepuserem, os dados de eventos dos dias sobrepostos serão incluídos nas linhas de resposta dos dois períodos. Em uma solicitação de coorte, esse dateRanges não pode ser especificado.

dimensionFilter

object (FilterExpression)

Com os filtros de dimensão, é possível solicitar somente valores de dimensão específicos no relatório. Para saber mais, consulte Princípios básicos dos filtros de dimensão para ver exemplos. Não é possível usar métricas neste filtro.

metricFilter

object (FilterExpression)

A cláusula de filtro das métricas. Aplicado após agregar as linhas do relatório, semelhante à cláusula SQL. Não é possível usar dimensões neste filtro.

offset

string (int64 format)

A contagem de linhas da primeira linha. A primeira linha é contada como a linha 0.

Na paginação, a primeira solicitação não especifica o deslocamento ou, de maneira equivalente, define o deslocamento como 0. A primeira solicitação retorna a primeira limit das linhas. A segunda solicitação define o deslocamento para o limit da primeira solicitação. A segunda solicitação retorna a segunda limit de linhas.

Consulte Paginação para saber mais sobre esse parâmetro.

limit

string (int64 format)

O número de linhas a serem retornadas. Se não for especificado, 10.000 linhas serão retornadas. A API retorna no máximo 250.000 linhas por solicitação, independentemente de quantas linhas você solicitar. limit precisa ser positivo.

A API também pode retornar menos linhas do que o limit solicitado, se não houver tantos valores de dimensão quanto o limit. Por exemplo, há menos de 300 valores possíveis para a dimensão country. Portanto, ao gerar um relatório somente para country, não será possível gerar mais de 300 linhas, mesmo que você defina limit como um valor mais alto.

Consulte Paginação para saber mais sobre esse parâmetro.

metricAggregations[]

enum (MetricAggregation)

Agregação de métricas. Os valores das métricas agregadas serão mostrados nas linhas em que "dimensionValues" estiver definido como "RESERVED_(Metric separadamente)".

orderBys[]

object (OrderBy)

Especifica como as linhas são ordenadas na resposta.

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 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" precisará 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.

Independentemente da configuração de keepEmptyRows, somente os 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 é necessário retornar o estado atual da cota dessa propriedade do Google Analytics. A cota é retornada em PropertyQuota.