Method: batchRunReports

Retorna vários relatórios em um lote. Todos os relatórios precisam ser sobre a mesma Entidade.

Solicitação HTTP

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

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)
  },
  "requests": [
    {
      object (RunReportRequest)
    }
  ]
}
Campos
entity

object (Entity)

Uma propriedade com eventos que são acompanhados. Essa entidade deve ser especificada para o lote. A entidade em RunReportRequest pode ser não especificada ou consistente com essa entidade.
requests[]

object (RunReportRequest)

Solicitações individuais. Cada solicitação tem uma resposta de relatório 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.

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

object (RunReportResponse)

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

Escopos de autorização

Requer um dos seguintes escopos do 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 
{
  "entity": {
    object (Entity)
  },
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "offset": string,
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "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 e exibidas.
metrics[]

object (Metric)

As métricas solicitadas e exibidas.
dateRanges[]

object (DateRange)

Períodos dos dados a serem lidos. Se vários períodos forem solicitados, cada linha da resposta conterá 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 precisa não ser especificado.
offset

string (int64 format)

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

string (int64 format)

O número de linhas a serem retornadas. Se o parâmetro limit não for especificado, 10.000 linhas serão retornadas. A API retorna no máximo 100.000 linhas por solicitação, independentemente de quantas linhas você pedir.
metricAggregations[]

enum (MetricAggregation)

Agregação de métricas. Os valores de métricas agregados serão mostrados nas linhas em que dimensionValues estiverem definidos como "RESERVED_(MetricAggregate)".
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.
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 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.