Visão geral da API Google Analytics Data

Use a API Data para acessar os dados dos relatórios do Google Analytics de maneira programática.

Saiba mais sobre as propriedades do Google Analytics.

Os dados retornados pela API são consistentes com os dados mostrados na interface do usuário do Google Analytics e respeitam totalmente as configurações de identidade de relatórios-- como mesclada, 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ório que a interface do Google Analytics. Os dados retornados pela API respeitam totalmente as configurações de identidade de relatórios configuradas para sua propriedade do Google Analytics. Assim, as contagens de usuários, a remoção de duplicação e a modelagem de dados são alinhadas ao espaço de identidade escolhido, como mesclado, observado ou baseado em dispositivo, nas configurações da propriedade.

Para saber mais sobre como diferentes espaços de identificação podem afetar seus relatórios, consulte Identidade do relatório.

Primeiros passos

Para começar a usar uma biblioteca de cliente em Java, Python, Node.js, PHP, C#, Go ou Ruby, consulte o guia de início rápido da biblioteca de cliente. Para saber como criar consultas, filtrar dimensões e ler respostas, consulte Criar um relatório ou testar consultas de forma interativa no Query Explorer.

Exemplo de solicitação e resposta runReport

Para consultar dados de eventos no REST, envie uma POST solicitação ao runReport endpoint com um RunReportRequest corpo JSON especificando dateRanges, dimensions, e metrics:

POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
{
  "dateRanges": [
    { "startDate": "7daysAgo", "endDate": "yesterday" }
  ],
  "dimensions": [
    { "name": "country" }
  ],
  "metrics": [
    { "name": "activeUsers" }
  ]
}

Ou execute o comando curl equivalente usando Credenciais padrão do aplicativo:

curl -X POST \
  "https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport" \
  -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
  -H "x-goog-user-project: PROJECT_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "dateRanges": [
      { "startDate": "7daysAgo", "endDate": "yesterday" }
    ],
    "dimensions": [
      { "name": "country" }
    ],
    "metrics": [
      { "name": "activeUsers" }
    ]
  }'

A API retorna um RunReportResponse que contém cabeçalhos de coluna e linhas de dados:

{
  "dimensionHeaders": [
    { "name": "country" }
  ],
  "metricHeaders": [
    { "name": "activeUsers", "type": "TYPE_INTEGER" }
  ],
  "rows": [
    {
      "dimensionValues": [{ "value": "United States" }],
      "metricValues": [{ "value": "4820" }]
    },
    {
      "dimensionValues": [{ "value": "Japan" }],
      "metricValues": [{ "value": "2541" }]
    }
  ],
  "rowCount": 2,
  "kind": "analyticsData#runReport"
}

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 : essa é uma versão em lote do método runReport que permite gerar vários relatórios usando uma única chamada de API.
  • runPivotReport Este 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 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 para 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 Google Analytics.
  • checkCompatibility : esse 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 da sua propriedade. Os eventos aparecem nos relatórios de tempo real segundos depois de serem enviados ao Google Analytics. Os relatórios em tempo real mostram eventos e dados de uso para os 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 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 de público-alvo recorrentes. Uma exportação de público-alvo recorrente 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. A análise detalhada de funil permite que você visualize as etapas que os usuários realizam até concluir uma tarefa e veja rapidamente o desempenho deles em cada etapa.
  • properties.chat (pré-lançamento) esse método oferece acesso conversacional programático a Ask Advisor no Google Analytics. Você pode fazer perguntas em linguagem natural sobre os dados de eventos, diagnosticar mudanças de desempenho e receber insights narrativos e tabulares estruturados.

Dimensões e métricas aceitas

Para uma lista de todas as dimensões e métricas aceitas pela API Data, consulte a documentação do esquema de API.