Method: properties.runReport

Retorna um relatório personalizado dos dados de eventos do Google Analytics. Os relatórios contêm estatísticas derivadas de dados coletados pelo código de acompanhamento do Google Analytics. Os dados retornados da API estão em uma tabela com colunas para as dimensões e métricas solicitadas. As métricas são medidas individuais da atividade do usuário 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.

Para orientações sobre como criar solicitações 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 GA4 do Google Analytics com eventos que são acompanhados. Especificado no caminho do URL e não no corpo. Para saber mais, veja onde encontrar seu 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: propriedades/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 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.
dimensionFilter

object (FilterExpression)

Com os filtros de dimensão, você pode 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 do SQL. Não é possível usar dimensões neste filtro.
offset

string (int64 format)

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

Durante a paginação, a primeira solicitação não especifica o deslocamento. ou equivalente, define o deslocamento para 0; a primeira solicitação retorna o primeiro limit das 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 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ê pedir. limit precisa ser positivo.

A API também poderá 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 somente sobre country, não é possível gerar mais de 300 linhas, mesmo que você defina limit como um valor mais alto.

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

Independentemente dessa 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ão uma linha eventName: "purchase" e eventCount: 0.
returnPropertyQuota

boolean

Alterna se o estado atual da cota dessa 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 requer apenas um campo de comparações 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