API de gerenciamento - guia do desenvolvedor da propriedade da Web

Este documento explica como usar a API de gerenciamento para acessar os dados de propriedade da Web.

Introdução

Uma propriedade da Web do Google Analytics está no segundo nível na hierarquia de contas. Cada "WebProperty" tem um único recurso de conta como pai e pode ter um filho que seja um conjunto de um ou mais recursos de vista da propriedade (perfil).

Uma propriedade da Web do Google Analytics é importante porque toda a coleta de dados acontece nesse nível. Por exemplo, quando você adiciona um código de acompanhamento a um website ou aplicativo para dispositivos móveis, você precisa incluir um ID semelhante a UA-xxxxx-y. Esse ID é chamado de ID da propriedade da Web e diferencia a conta do Google Analytics na qual os dados são armazenados.

Antes de começar

Este guia mostra como acessar a Google Analytics API utilizando as seguintes linguagens de programação:
  • Java
  • Python
  • PHP

  • Leia a página de bibliotecas cliente para uma lista completa das bibliotecas cliente específicas de linguagens de programação que funcionam com a API de gerenciamento.
  • Leia o Guia de referência para acessar a API sem uma biblioteca cliente.

Cada biblioteca cliente fornece um único objeto de serviço Analytics para acessar todos os dados da API de gerenciamento. Para criar o objeto de serviço, normalmente é necessário seguir estas etapas:

  1. Registre seu aplicativo no Google Developers Console.
  2. Autorize o acesso aos dados do Google Analytics.
  3. Crie um objeto de serviço Analytics.

Se você não tiver concluído essas etapas, pare e leia o Tutorial de apresentação da Google Analytics API. Ele orienta você sobre as etapas iniciais de criação de um aplicativo da Google Analytics API. Depois de concluir as etapas, você poderá usar este guia para executar tarefas reais.

O snippet de código a seguir é a continuação da Etapa 3 (Criar um objeto de serviço "Analytics") e contém uma variável para armazenar um objeto de serviço autorizado.

Java

Analytics analytics = // Read Hello Analytics Tutorial for details.

Python

analytics = # Read Hello Analytics Tutorial for details.

PHP

$client = // Read Hello Analytics Tutorial for details.

// Return results as objects.
$client->setUseObjects(true);

$analytics = new apiAnalyticsService($client);

A biblioteca de PHP retorna todos os resultados da API como uma matriz associativa. Para retornar objetos reais, você pode chamar o método useObject cliente, conforme demonstrado no exemplo acima.

Depois de criar um objeto de serviço Analytics, você poderá fazer solicitações à API de gerenciamento.

Observação: o mesmo objeto de serviço Analytics também pode ser usado para acessar a API de relatórios principais.

Uso de uma conta de teste

Se você pretende usar a API de gerenciamento para criar e/ou configurar propriedades, é recomendável que implemente e verifique seu código com uma conta de teste. O uso de uma conta de teste ajudará a impedir que você faça alterações acidentais em uma propriedade ativa. Depois que você testou e confirmou que seu código está funcionando conforme o esperado utilizando a conta e propriedade de teste, comece a usar a implementação com suas contas reais.

Você pode criar uma conta de teste na seção "Administrador" da interface da Web do Google Analytics.

Exemplos de códigos

Com a API de gerenciamento, você pode listar, recuperar, inserir, corrigir e atualizar propriedades de um usuário autorizado. Para usar um desses métodos, primeiro você precisa criar um objeto de serviço Analytics, conforme descrito na seção Antes de começar.

Para exemplos de código que mostram como trabalhar com o recurso de propriedade da Web, acesse as referências de método a seguir:

  • list: lista as propriedades da Web às quais o usuário tem acesso.
  • get: recupera uma propriedade de Web à qual o usuário tem acesso.
  • insert: cria uma nova propriedade da Web.
  • patch: atualiza uma propriedade da Web existente. Esse método é compatível com a semântica de patch.
  • update: atualiza uma propriedade da Web existente.

Exemplo de aplicativo

Veja a amostra de referência da API de gerenciamento para um exemplo prático de como percorrer e acessar todos os dados na API de gerenciamento.

Java


Google Analytics API Amostra da biblioteca cliente de Java

Python


Google Analytics API Amostra da biblioteca cliente de Python

PHP


Google Analytics API Amostra da biblioteca cliente de PHP