Visão geral da API Google Analytics Data

Você pode usar a API Data para acessar os dados de relatórios do Google Analytics de maneira programática. Essa API não é compatível com propriedades legadas do Universal Analytics.

Saiba mais sobre as propriedades 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.

Também é possível usar a API Data do Google Analytics 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.

Primeiros passos

Para começar, consulte o Guia inicial da biblioteca de cliente. Há bibliotecas de cliente em Java, Python, Node.js e outras linguagens para simplificar a 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: esse método 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: esse método retorna um relatório dinâmico personalizado dos dados de eventos do Google Analytics. Os relatórios de pivote são formatos mais avançados e expressivos do que os relatórios normais. Cada uma delas descreve as colunas e linhas de dimensões 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 do Google Analytics especificada.
  • checkCompatibility Este 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 para sua propriedade. Os eventos aparecem nos relatórios em tempo real segundos depois de serem enviados ao Google Analytics. Os relatórios de tempo real mostram eventos e dados de uso para períodos que variam 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 permitem gerar exportações de público-alvo, que incluem um resumo 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): 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ê pode conferir as etapas que os usuários seguem até concluir uma tarefa e saber se eles estão tendo sucesso ou falhando em cada uma delas.

Dimensões e métricas compatíveis

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