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 da 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.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
property

string

Obrigatório. Um identificador de propriedade do Google Analytics cujos eventos são rastreados. Especificado no caminho do URL, não no corpo. Para saber mais, consulte onde encontrar o ID da propriedade. Em uma solicitação em lote, essa propriedade não deve ser especificada ou precisa ser 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)
    }
  ],
  "conversionSpec": {
    object (ConversionSpec)
  }
}
Campos
dimensions[]

object (Dimension)

Opcional. As dimensões solicitadas e mostradas.
metrics[]

object (Metric)

Opcional. As métricas solicitadas e mostradas.
dateRanges[]

object (DateRange)

Opcional. Períodos dos dados a serem lidos. Se vários períodos forem solicitados, cada linha de resposta vai conter um índice de período com base zero. Se dois períodos se sobrepuserem, os dados de eventos dos dias em comum serão incluídos nas linhas de resposta dos dois períodos. Em uma solicitação de coorte, esse dateRanges precisa ser não especificado.
dimensionFilter

object (FilterExpression)

Opcional. Com os filtros de dimensão, é possível solicitar apenas valores específicos de dimensão no relatório. Para saber mais, consulte Fundamentos dos filtros de dimensão e confira exemplos. Não é possível usar métricas nesse filtro.
metricFilter

object (FilterExpression)

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

string (int64 format)

Opcional. A contagem 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 maneira equivalente, define o deslocamento como 0. A primeira solicitação retorna as primeiras limit linhas. A segunda solicitação define o deslocamento como o limit da primeira solicitação, e retorna o segundo limit de linhas.

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

string (int64 format)

Opcional. O número máximo 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, não importa quantas você peça. 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 sobre country, não é possível ter mais de 300 linhas, mesmo que você defina limit com um valor maior.

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

enum (MetricAggregation)

Opcional. Agregação de métricas. Os valores agregados das métricas vão aparecer em linhas em que "dimensionValues" está definido como "RESERVED_(MetricAggregation)". As agregações que incluem comparações e vários períodos são agregadas com base nos períodos.
orderBys[]

object (OrderBy)

Opcional. Especifica como as linhas são ordenadas na resposta. As solicitações que incluem comparações e vários períodos terão cláusulas "order by" aplicadas às comparações.
currencyCode

string

Opcional. 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)

Opcional. 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

Opcional. Se for "false" ou não especificado, cada linha com todas as métricas iguais a 0 não será retornada. Se for "true", essas linhas serão retornadas se não forem removidas separadamente por um filtro.

Independente dessa configuração de 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

Opcional. Alterna se o estado atual da cota dessa propriedade do Google Analytics deve ser retornado. A cota é retornada em PropertyQuota.
comparisons[]

object (Comparison)

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

object (ConversionSpec)

Opcional. Controla os relatórios de conversão. Este campo é opcional. Se esse campo estiver definido ou se alguma métrica de conversão for solicitada, o relatório será de conversão.

Corpo da resposta

A tabela de relatório de resposta correspondente a uma solicitação.

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

Representação JSON 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "totals": [
    {
      object (Row)
    }
  ],
  "maximums": [
    {
      object (Row)
    }
  ],
  "minimums": [
    {
      object (Row)
    }
  ],
  "rowCount": integer,
  "metadata": {
    object (ResponseMetaData)
  },
  "propertyQuota": {
    object (PropertyQuota)
  },
  "kind": string,
  "nextPageToken": string
}
Campos
dimensionHeaders[]

object (DimensionHeader)

Descreve as colunas de dimensão. O número de DimensionHeaders e a ordenação deles correspondem às dimensões presentes nas linhas.
metricHeaders[]

object (MetricHeader)

Descreve as colunas de métricas. O número de MetricHeaders e a ordenação deles correspondem às métricas presentes nas linhas.
rows[]

object (Row)

Linhas de combinações de valores de dimensão e valores de métricas no relatório.
totals[]

object (Row)

Se solicitado, os valores totais das métricas.
maximums[]

object (Row)

Se solicitado, os valores máximos das métricas.
minimums[]

object (Row)

Se solicitado, os valores mínimos das métricas.
rowCount

integer

O número total de linhas no resultado da consulta, independente do número de linhas retornadas na resposta. Por exemplo, se uma consulta retornar 175 linhas e incluir "limit = 50" na solicitação de API, a resposta vai conter "rowCount = 175", mas apenas 50 linhas.

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

object (ResponseMetaData)

Metadados do relatório.
propertyQuota

object (PropertyQuota)

O estado da cota da propriedade do Google Analytics, incluindo esta solicitação.
kind

string

Identifica o tipo de recurso da mensagem. Esse kind é sempre a string fixa "analyticsData#runReport". Útil para distinguir entre tipos de resposta em JSON.
nextPageToken

string

Um token, que pode ser enviado como pageToken para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Comparação

Define uma comparação individual. A maioria das solicitações inclui várias comparações para que o relatório compare entre elas.

Representação JSON 
{
  "name": string,

  // Union field one_comparison can be only one of the following:
  "dimensionFilter": {
    object (FilterExpression)
  },
  "comparison": string
  // End of list of possible types for union field one_comparison.
}
Campos
name

string

Cada comparação produz linhas separadas na resposta. Na resposta, essa comparação é identificada por esse nome. Se o nome não for especificado, vamos usar o nome de exibição das comparações salvas.

Campo de união one_comparison.

one_comparison pode ser apenas de um dos tipos a seguir:
dimensionFilter

object (FilterExpression)

Uma comparação básica.
comparison

string

Uma comparação salva identificada pelo nome do recurso dela. Por exemplo, "comparisons/1234".

ConversionSpec

Controla os relatórios de conversão.

Representação JSON 
{
  "conversionActions": [
    string
  ],
  "attributionModel": enum (AttributionModel)
}
Campos
conversionActions[]

string

Os IDs das ações de conversão a serem incluídos no relatório. Se estiver vazio, todas as conversões serão incluídas. Os IDs de ação de conversão válidos podem ser extraídos do campo conversionAction na lista conversions da resposta do método properties.getMetadata. Por exemplo, "conversionActions/1234".
attributionModel

enum (AttributionModel)

O modelo de atribuição a ser usado no Relatório de conversão. Se não for especificado, DATA_DRIVEN será usado.

AttributionModel

Modelo de atribuição a ser usado no Relatório de conversão

Tipos enumerados
ATTRIBUTION_MODEL_UNSPECIFIED Modelo de atribuição não especificado.
DATA_DRIVEN A atribuição foi baseada no modelo baseado em dados pagos e orgânicos.
LAST_CLICK A atribuição foi baseada no modelo de último clique pago e orgânico