Visão geral

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Este documento descreve a API de relatórios em tempo real do Google Analytics. Para ver uma referência detalhada da API, leia a Referência da API.

Introdução

Com a API de relatórios em tempo real, você pode solicitar dados em tempo real, por exemplo, atividades em tempo real na sua propriedade, para um usuário autenticado.

Você pode usar a API de relatórios em tempo real para:

  • Exibir os usuários ativos em uma página e criar um senso de urgência para os usuários que estão visualizando um item com inventário finito.
  • Exibir o conteúdo mais conhecido, como as 10 principais páginas ativas.
  • Criar e exibir um painel em tempo real.

SuperProxy do Google Analytics

Use o superProxy do Google Analytics para gerenciar muitos dos detalhes da implementação do trabalho com as APIs do Google Analytics sobre autenticação, armazenamento em cache e transformação de respostas da API em formatos usados diretamente com bibliotecas de gráficos e visualização.

Visão geral conceitual

Os conceitos fundamentais subjacentes à API de relatórios em tempo realsão:

  • Como os relatórios estão relacionados aos usuários e às vistas da propriedade (perfis).
  • A estrutura de um relatório e como criar consultas.
  • Trabalho com a resposta da API.

Relatórios, usuários e Vistas (perfis)

Para que os usuários possam usar seu aplicativo com a finalidade de solicitar os dados de relatórios deles de uma Vista (perfil), é necessário:

  1. Ativar a Google Analytics API.
  2. Criar credenciais para que seu aplicativo acesse a API.
  3. Inserir as credenciais no seu aplicativo.

Ao usar seu aplicativo para solicitar seus respectivos dados de relatórios, os usuários precisam autorizá-lo a acessar os dados em nome deles.

Uma Vista (perfil) é identificada por um ID de Vista (perfil). As Vistas (perfis), entre outras entidades, fazem parte da hierarquia de contas, usuários, propriedades e Vistas do Google Analytics. Seu aplicativo pode usar a API de gerenciamento para navegar nessa hierarquia e obter uma Vista (perfil).

Consulta de dimensões e métricas

Você consulta a API para encontrar dados de relatório do Google Analytics, que consistem em dimensões e métricas. Métricas são medidas individuais da atividade de usuários, como o número de usuários ativos na propriedade no momento. As dimensões dividem as métricas de acordo com alguns critérios comuns, como origens de tráfego, localização geográfica, informações da página etc.

Use o Guia de referência de dimensões e métricas para explorar todas as dimensões e métricas [expostas pela] disponíveis para a API. Além disso, leia o Guia de referência da API de relatórios em tempo real para saber como especificar dimensões e métricas em uma consulta da API.

Trabalho com relatórios

Os dados retornados da API podem ser considerados como uma tabela com um cabeçalho e diversas linhas. Cada resposta de API consiste em um cabeçalho que descreve o nome e o tipo dos dados de cada coluna. A resposta também inclui uma lista de linhas, em que cada linha é uma lista de células com dados na mesma ordem que os cabeçalhos. Leia o Guia de referência da API de relatórios em tempo real para mais informações sobre a resposta da API.

Política de cotas

A API de relatórios em tempo real gerencia milhões de operações de consulta de dados. Empregamos um sistema de cotas para impedir que o sistema receba mais operações do que pode processar e garantir uma distribuição equitativa dos recursos do sistema. Consulte o guia Limites e cota para mais detalhes.

Próximas etapas

Agora que você já sabe como a API funciona, para dar os primeiros passos: