Method: properties.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 pela API são uma tabela com colunas para as dimensões e métricas solicitadas. As métricas são medições individuais da atividade do usuário na sua propriedade, como usuários ativos ou contagem de eventos. As dimensões detalham as métricas em alguns critérios comuns, como país ou nome do evento.

Para um guia sobre como criar solicitações e entender as respostas, consulte Como criar um relatório.

Solicitação HTTP

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

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 acompanhados. 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 ser não especificada ou consistente com a propriedade no nível do lote.

Exemplo: properties/1234

Corpo da solicitação

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

Representação JSON 
{
  "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,
  "comparisons": [
    {
      object (Comparison)
    }
  ]
}
Campos
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 vai conter um índice de período com base em zero. Se dois períodos se sobrepõem, os dados de eventos dos dias em que há sobreposição são incluídos nas linhas de resposta de ambos os períodos. Em uma solicitação de coorte, esse dateRanges precisa ser não especificado.
dimensionFilter

object (FilterExpression)

Com os filtros de dimensão, você pode solicitar apenas valores específicos de dimensão no relatório. Para saber mais, consulte Noções básicas sobre filtros de dimensão e confira exemplos. Não é possível usar métricas neste filtro.
metricFilter

object (FilterExpression)

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

string (int64 format)

O número de linhas da linha inicial. A primeira linha é contada como linha 0.

Ao paginar, a primeira solicitação não especifica o deslocamento ou, de forma equivalente, define o deslocamento como 0. A primeira solicitação retorna a primeira limit de linhas. A segunda solicitação define o deslocamento para o limit da primeira solicitação. A segunda solicitação retorna o segundo limit das linhas.

Para saber mais sobre esse parâmetro de paginação, consulte Paginação.
limit

string (int64 format)

O número de linhas que serão retornadas. Se não for especificado, 10.000 linhas serão retornadas. A API retorna um máximo de 250.000 linhas por solicitação, não importa quantas 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 relatórios apenas com country, não é possível receber mais de 300 linhas, mesmo que você defina limit como um valor maior.

Para saber mais sobre esse parâmetro de paginação, consulte Paginação.
metricAggregations[]

enum (MetricAggregation)

Agregação de métricas. Os valores de métrica agregados vão aparecer em linhas em que os valores de dimensão estão definidos como "RESERVED_(MetricAggregation)". Os agregados que incluem comparações e vários períodos serão agregados com base nos períodos.
orderBys[]

object (OrderBy)

Especifica como as linhas são ordenadas na resposta. As solicitações que incluem comparações e vários períodos terão ordenações aplicadas às comparações.
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 coorte associado a esta solicitação. Se houver um grupo de coorte na solicitação, a dimensão "cohort" vai 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 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á uma linha eventName: "purchase" e eventCount: 0.
returnPropertyQuota

boolean

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

object (Comparison)

Opcional. A configuração das comparações solicitadas e exibidas. A solicitação só requer um campo de comparação para receber uma coluna de comparação na resposta.

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 do OAuth:

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