Visão geral da API Google Analytics Data

Use a API Data para acessar os dados dos relatórios do Google Analytics (Google Analytics) de maneira programática. Essa API não é compatível com as propriedades legadas do Universal Analytics.

Saiba mais sobre as propriedades do Google Analytics.

Os dados retornados pela API são consistentes com os dados mostrados na interface do Google Analytics e respeitam totalmente as configurações de identidade de relatórios-- como mesclada, observada ou baseada em dispositivos--configuradas para sua propriedade do Google Analytics.

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

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

Você também pode usar a API Data v1 do Google Analytics para fazer o seguinte:

  • 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 Data v1 do Google Analytics acessa os mesmos dados de relatório que a interface do Google Analytics. Os dados retornados pela API respeitam totalmente as configurações de identidade do relatório configuradas para sua propriedade do Google Analytics. Assim, as contagens de usuários, a eliminação de duplicação e a modelagem de dados são alinhadas ao espaço de identificação escolhido, como mesclado, observado ou baseado em dispositivos, nas configurações da propriedade.

Para saber mais sobre como diferentes espaços de identificação podem afetar seus relatórios, consulte Identidade do relatório.

Primeiros passos

Para começar, consulte o guia de início rápido da biblioteca de cliente. Há bibliotecas de cliente em Java, Python, Node.js e outras linguagens para simplificar sua implementação.

Métodos disponíveis

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

  • runReport: retorna um relatório personalizado dos seus dados de eventos do Google Analytics e é o método preferido 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 Este método retorna um relatório dinâmico personalizado com os dados de eventos do Google Analytics. Os relatórios dinâmicos são formatos mais avançados e expressivos do que os relatórios normais. 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 : retorna metadados para dimensões e métricas disponíveis nos métodos de relatórios. Usado para explorar 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 : lista as dimensões e métricas que podem ser adicionadas a uma solicitação de relatório e manter a compatibilidade.
  • runRealtimeReport Este método retorna um relatório personalizado dos dados de eventos em tempo real da sua propriedade. Os eventos aparecem nos relatórios em tempo real segundos depois de serem enviados ao Google Analytics. Os relatórios em tempo real mostram eventos e dados de uso para os 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 recorrentes de público-alvo. Uma exportação recorrente de público-alvo produz novas listas de público-alvo todos os dias.
  • runFunnelReport (pré-lançamento): retorna um relatório de funil personalizado dos dados de eventos do Google Analytics. A análise detalhada de funil permite que você visualize as etapas que seus usuários realizam até concluir uma tarefa e veja rapidamente o quão bem-sucedidos ou mal-sucedidos eles são em cada etapa.

Dimensões e métricas aceitas

Para uma lista de todas as dimensões e métricas aceitas pela API Data, consulte a documentação do esquema da API.