Visão geral da API Google Analytics Data

Use a API Data para acessar de forma programática os dados de relatórios do Google Analytics.

Saiba mais sobre as propriedades do Google Analytics.

Os dados retornados pela API são consistentes com os mostrados na interface do usuário do Google Analytics e respeitam totalmente as configurações de identidade do relatório (como mista, observada ou baseada no dispositivo) definidas para sua propriedade do Google Analytics.

Confira alguns exemplos de relatórios que você pode gerar usando a API Google Analytics Data v1:

  • Quantos usuários ativos por dia seu app Android teve na última semana.
  • Quantas visualizações de página as 10 páginas mais acessadas do seu site tiveram nos últimos 28 dias.
  • Quantos usuários ativos por país seu app iOS teve nos últimos 30 minutos.

Também é possível usar a API Google Analytics Data v1 para:

  • criar painéis personalizados para exibir os dados do Google Analytics;
  • automatizar tarefas de relatórios complexas para economizar tempo;
  • integrar seus dados do Google Analytics a outros aplicativos de negócios.

Consistência de dados e identidade do relatório

A API Google Analytics Data v1 acessa os mesmos dados de relatórios que a interface do Google Analytics. Os dados retornados pela API respeitam totalmente as configurações de identidade do relatório definidas para sua propriedade do Google Analytics. Assim, as contagens de usuários, a eliminação de duplicação e a modelagem de dados se alinham ao espaço de identidade escolhido (como "Combinada", "Observada" ou "Por dispositivo") nas configurações da propriedade.

Para saber como os diferentes espaços de identidade podem afetar seus relatórios, consulte Identidade do relatório.

Primeiros passos

Para começar a usar uma biblioteca de cliente em Java, Python, Node.js, PHP, C#, Go ou Ruby, consulte o guia de início rápido da biblioteca de cliente. Para saber como criar consultas, filtrar dimensões e ler respostas, consulte Criar um relatório ou teste as consultas de forma interativa no Explorador de consultas.

Exemplo de solicitação e resposta de runReport

Para consultar dados de eventos por REST, envie uma solicitação POST ao endpoint runReport com um corpo JSON RunReportRequest especificando dateRanges, dimensions e metrics:

POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
{
  "dateRanges": [
    { "startDate": "7daysAgo", "endDate": "yesterday" }
  ],
  "dimensions": [
    { "name": "country" }
  ],
  "metrics": [
    { "name": "activeUsers" }
  ]
}

Ou execute o comando curl equivalente usando o Application Default Credentials:

curl -X POST \
  "https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport" \
  -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
  -H "x-goog-user-project: PROJECT_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "dateRanges": [
      { "startDate": "7daysAgo", "endDate": "yesterday" }
    ],
    "dimensions": [
      { "name": "country" }
    ],
    "metrics": [
      { "name": "activeUsers" }
    ]
  }'

A API retorna um RunReportResponse que contém cabeçalhos de coluna e linhas de dados:

{
  "dimensionHeaders": [
    { "name": "country" }
  ],
  "metricHeaders": [
    { "name": "activeUsers", "type": "TYPE_INTEGER" }
  ],
  "rows": [
    {
      "dimensionValues": [{ "value": "United States" }],
      "metricValues": [{ "value": "4820" }]
    },
    {
      "dimensionValues": [{ "value": "Japan" }],
      "metricValues": [{ "value": "2541" }]
    }
  ],
  "rowCount": 2,
  "kind": "analyticsData#runReport"
}

Métodos disponíveis

Confira uma lista dos métodos da API Data. Para mais detalhes, consulte a documentação de referência.

  • runReport Esse método retorna um relatório personalizado dos dados de eventos do Google Analytics e é o método preferencial para consultas de relatórios simples.
  • batchRunReports: é uma versão em lote do método runReport que permite gerar vários relatórios usando uma única chamada de API.
  • runPivotReport Esse método retorna um relatório dinâmico personalizado dos dados de eventos do Google Analytics. Os relatórios dinâmicos são formatos mais avançados e expressivos do que os relatórios comuns. Cada tabela dinâmica descreve as colunas e linhas de dimensão visíveis na resposta do relatório.
  • batchRunPivotReports É uma versão em lote do método runPivotReport que permite gerar vários relatórios usando uma única chamada de API.
  • getMetadata Esse método retorna metadados para dimensões e métricas disponíveis nos métodos de relatórios. Usado para analisar as dimensões e métricas. A resposta desse método também inclui as dimensões e métricas personalizadas disponíveis para a propriedade especificada do Google Analytics.
  • checkCompatibility Esse método lista as dimensões e métricas que podem ser adicionadas a uma solicitação de relatório e manter a compatibilidade.
  • runRealtimeReport Esse método retorna um relatório personalizado de dados de eventos em tempo real da sua propriedade. Os eventos aparecem nos relatórios de tempo real segundos depois de serem enviados ao Google Analytics. Os Relatórios de tempo real mostram eventos e dados de uso dos períodos que vão do momento atual até 30 minutos atrás (até 60 minutos para propriedades do Google Analytics 360).
  • properties.audienceExports Um grupo de métodos que permite gerar exportações de público-alvo, que incluem um snapshot dos usuários em um público-alvo.
  • properties.recurringAudienceLists (Pré-lançamento) Um grupo de métodos que permite gerenciar exportações de público-alvo recorrentes. Uma exportação recorrente de público-alvo produz novas listas de público-alvo todos os dias.
  • runFunnelReport (Pré-lançamento) Esse método retorna um relatório de funil personalizado dos dados de eventos do Google Analytics. Com a análise detalhada de funil, você vê as etapas que os usuários realizam até concluir uma tarefa e quais delas conseguem manter as pessoas no funil.
  • properties.chat (Pré-lançamento) Esse método oferece acesso programático de conversação ao Ask Advisor no Google Analytics. Você pode fazer perguntas em linguagem natural sobre seus dados de eventos, diagnosticar mudanças de desempenho e receber insights narrativos e tabulares estruturados.

Dimensões e métricas disponíveis

Para ver uma lista de todas as dimensões e métricas compatíveis com a API Data, consulte a documentação do esquema de API.