Visão geral da API Analytics Data

A API Google Analytics Data v1 oferece acesso programático aos dados dos relatórios do Google Analytics 4 (GA4). O Google Analytics 4 ajuda a entender como as pessoas usam seu app da Web, iOS ou Android. Saiba mais sobre as propriedades do Google Analytics 4.

Com a API Data v1 do Google Analytics, você pode criar relatórios para responder a perguntas como:

  • Quantos usuários ativos por dia meu app Android teve na última semana?
  • Quantas visualizações de página cada um dos 10 principais URLs de página do meu site recebeu nos últimos 28 dias?
  • Quantos usuários ativos por país meu app iOS teve nos últimos 30 minutos?

A API Data v1 do Google Analytics também pode ser usada 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.

Guia de início rápido

Você só precisa de algumas linhas de código para chamar a API para criar seu primeiro relatório. Consulte o guia de início rápido para usar bibliotecas de cliente para começar. Há bibliotecas de cliente em Java, Python, Node.js e outras linguagens para simplificar a implementação.

Métodos disponíveis

  • runReport: retorna um relatório personalizado dos seus dados de eventos do Google Analytics e é o método preferido para consultas de relatório 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 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 de 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 GA4.
  • checkCompatibility: este 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 são exibidos nos relatórios em tempo real alguns segundos depois de serem enviados ao Google Analytics. Os Relatórios em tempo real mostram dados de uso e eventos de períodos que variam de 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, incluindo 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 todos os dias.
  • runFunnelReport (Prévia antecipada) Esse método retorna um relatório de funil personalizado dos seus 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 se eles estão tendo sucesso ou falhando em cada uma delas.

Dimensões e métricas compatíveis

A documentação do esquema da API lista as dimensões e métricas atualmente compatíveis com a API Analytics Data.