Method: runReport

Retorna um relatório personalizado dos seus dados de eventos do Google Analytics. Os relatórios contêm estatísticas derivadas dos dados coletados pelo código de acompanhamento do Google Analytics. Os dados retornados da API são como uma tabela com colunas para as dimensões e métricas solicitadas. As métricas são medidas individuais das atividades dos usuários na sua propriedade, como usuários ativos ou contagem de eventos. As dimensões dividem as métricas de acordo com alguns critérios comuns, como país ou nome do evento.

Solicitação HTTP

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

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)
  },
  "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 rastreados. Em uma solicitação em lote, essa entidade deve ser não especificada ou consistente com a entidade no nível de lote.
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.
offset

string (int64 format)

A contagem de linhas da primeira linha. A primeira linha é contada como a linha 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ê solicitar.
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)".
dimensionFilter

object (FilterExpression)

A cláusula de filtro das dimensões. É preciso solicitar as dimensões para usar 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, semelhante à cláusula SQL. É preciso solicitar as métricas para usá-las 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, 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.
returnPropertyQuota

boolean

Define se é necessário retornar o estado atual da cota dessa 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 RunReportResponse.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

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