API de gerenciamento - guia do desenvolvedor de metas

Este documento explica como usar a API de gerenciamento para acessar dados da meta.

Introdução

Uma meta do Google Analytics está no quarto e mais baixo nível na hierarquia de contas. As metas não têm entidades filhas. Cada recurso de meta tem um único recurso de vista da propriedade (perfil) como pai na hierarquia.

Os dados de meta fornecidos pela API de gerenciamento descrevem como uma meta é configurada: nome, valor, tipo e se está ativa ou não.

Para saber mais sobre os diferentes tipos de metas que podem ser criados, leia Configuração de metas (Central de Ajuda).

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 metas, é recomendável implementar e verificar seu código com uma conta de teste. O uso de uma conta de teste ajudará a evitar que você faça alterações acidentais em uma meta ativa. Depois que você testar e confirmar que seu código está funcionando conforme o esperado usando a meta e a conta de teste, poderá começar 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.

Limites e comportamento da meta

Os limites e comportamentos a seguir se aplicam ao recurso de meta:

  • Há um limite superior de 20 metas por vista da propriedade (perfil). Quando uma vista da propriedade (perfil) atinge esse limite, não é possível criar metas adicionais por meio da API para tal vista da propriedade (perfil). No entanto, as metas existentes podem ser atualizadas e reutilizadas. Consulte Limites e cotas para conhecer os limites gerais.
  • Goals cannot be deleted but they can be marked as inactive by setting the Goal active property to False. Nenhum dado é registrado quando uma meta está inativa, mas os dados do histórico ficam disponíveis.

Exemplos de códigos

Com a API de gerenciamento, você pode listar, receber, inserir, corrigir e atualizar metas para 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ódigos que mostram como trabalhar com o recurso de meta, acesse estas referências de método:

  • list: lista as metas às quais o usuário tem acesso.
  • get: recebe uma meta à qual o usuário tem acesso.
  • insert: cria uma nova meta.
  • patch: atualiza uma meta existente. Esse método é compatível com a semântica de patch.
  • update: atualiza uma meta 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