Visão geral da API Google Analytics 4 Data

Você pode usar a API Data para acessar os dados do relatório do Google Analytics 4 (GA4) 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 4.

Confira alguns exemplos dos relatórios que você pode usar com 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.
  • O número de usuários ativos por país que 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.

Começar

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

Esta é 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 simples de relatório.
  • batchRunReports Essa é 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 seus 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 Essa é 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 das 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 do GA4 especificada.
  • checkCompatibility Esse método lista dimensões e métricas que podem ser adicionadas a uma solicitação de relatório e mantêm a compatibilidade.
  • runRealtimeReport Esse método retorna um relatório personalizado de dados de eventos em tempo real para sua propriedade. Os eventos aparecem em relatórios em tempo real segundos após serem enviados ao Google Analytics. Os Relatórios de tempo real mostram dados de uso e eventos de períodos que vão do momento atual até 30 minutos atrás (até 60 minutos para as propriedades do Google Analytics 360).
  • properties.audienceExports Um grupo de métodos que permite gerar exportações de público-alvo, que incluem um resumo dos usuários em um público-alvo.
  • properties.recurringAudienceLists (Pré-lançamento antecipado): um grupo de métodos que permite gerenciar exportações de públicos-alvo recorrentes. Uma exportação de público-alvo recorrente produz novas listas de público-alvo a cada dia.
  • runFunnelReport (Pré-lançamento antecipado): esse método retorna um relatório de funil personalizado com seus dados de eventos do Google Analytics. Com a análise detalhada de funil, é possível conferir as etapas que os usuários seguem para concluir uma tarefa e se estão tendo sucesso ou falhando em cada uma delas.

Dimensões e métricas compatíveis

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.