Method: properties.runReport

Retorna um relatório personalizado de seus dados de evento do Google Analytics. Os relatórios contêm estatísticas derivadas dos dados coletados pelo código de acompanhamento do Google Analytics. Os dados mostrados pela API são como 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 ver 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 GA4 do Google Analytics cujos eventos são rastreados. Especificada no caminho do URL e não no corpo. Para saber mais, veja onde encontrar o ID da propriedade. Em uma solicitação em lote, essa propriedade não deve ser especificada nem 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
}
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 para leitura. Se vários períodos forem solicitados, cada linha de resposta conterá um índice de período com base em zero. Se dois períodos forem sobrepostos, os dados de eventos dos dias sobrepostos serão incluídos nas linhas das respostas dos dois períodos. Em uma solicitação de coorte, esse dateRanges não pode ser especificado.
dimensionFilter

object (FilterExpression)

Com os filtros de dimensão, você pode solicitar somente valores específicos de dimensão 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 de métricas. Aplicado após agregar as linhas do relatório, semelhante à cláusula SQL. Não é possível usar dimensões neste filtro.
offset

string (int64 format)

A contagem de linhas da linha de início. A primeira linha é contada como 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 o primeiro limit das linhas. A segunda solicitação define o deslocamento para a limit da primeira solicitação. A segunda solicitação retorna a segunda 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 um máximo de 250.000 linhas por solicitação, independentemente de quantas linhas 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 de country, não será possível ver 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étrica agregados serão exibidos nas linhas em que "dimensionValues" estiver definido como "RESERVED_(MetricAggregation)".
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" ou "JPY". Se o campo estiver vazio, o relatório 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 "coorte" deverá estar presente.
keepEmptyRows

boolean

Se for falso ou não especificado, cada linha com todas as métricas igual 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 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á uma linha eventName: "purchase" e eventCount: 0.
returnPropertyQuota

boolean

Define se deve retornar o estado atual da cota desta 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