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.

Saiba mais sobre as propriedades do Google Analytics.

Os dados retornados pela API são consistentes com os mostrados na interface do usuário do Google Analytics e respeitam totalmente as configurações de identidade do relatório (como combinada, observada ou baseada em dispositivo) configuradas para sua propriedade 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.

Consistência de dados e identidade do relatório

A API Data v1 do Google Analytics acessa os mesmos dados de relatórios 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 se alinham ao espaço de identificação escolhido (como combinada, observada ou baseada em dispositivo) nas configurações da propriedade.

Para saber 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 Esse método retorna um relatório personalizado dos dados de eventos do Google Analytics e é o método preferido para consultas de relatórios simples.
  • batchRunReports Esta é 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 dinâmicos são formatos mais avançados e expressivos do que os relatórios comuns. Cada coluna descreve as colunas e linhas de dimensão visíveis na resposta do relatório.
  • batchRunPivotReports Esta é 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 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 de tempo real mostram eventos e dados de uso para 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úblicos-alvo. Uma exportação recorrente de público-alvo gera 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ê vê as etapas que os usuários realizam até concluir uma tarefa e em quais delas eles permanecem no funil.
  • properties.chat (Pré-lançamento) Esse método oferece acesso programático por conversa ao Ask Advisor no Google Analytics. Você pode fazer perguntas em linguagem natural sobre seus dados de eventos, diagnosticar mudanças de performance e receber insights estruturados em formato de narrativa e tabela.

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 de API.