Visão geral da API Google Analytics Data

Você pode usar a API Data para acessar de maneira programática os dados de relatórios do Google Analytics (GA). Essa API não é compatível com as 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 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 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 Google Analytics Data v1 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.

Primeiros passos

Para começar, consulte o 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 simples de relatórios.
  • 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 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 comuns. Cada tabela dinâmica 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 geração 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 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 em tempo real segundos depois de serem enviados ao Google Analytics. Os relatórios em 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évia antecipada): um grupo de métodos que permite gerenciar exportações recorrentes de públicos-alvo. Uma exportação recorrente de público-alvo gera novas listas de público-alvo todos os dias.
  • runFunnelReport (Prévia antecipada): 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 ver as etapas que os usuários realizam até concluir uma tarefa e quais delas conseguem mantê-los no funil.

Dimensões e métricas aceitas

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