API de gerenciamento - guia do desenvolvedor da vista da propriedade (perfil)

Este documento explica como usar a API de gerenciamento para acessFar dados da vista da propriedade (perfil).

Introdução

Um recurso de vista da propriedade (perfil) do Google Analytics está no terceiro nível na hierarquia. Cada vista da propriedade (perfil) possui um único recurso de propriedade da Web como seu pai na hierarquia e pode ter um conjunto de zero ou mais recursos de meta como filhos.

  • Leia a visão geral da entidade no guia de visão geral da API de gerenciamento para compreender a relação das vistas da propriedade (perfis) com outras entidades da API de gerenciamento.
  • Leia o guia conceitual Contas e vistas da propriedade (perfis) para informações gerais sobre vistas da propriedade (perfis).

Uma vista da propriedade (perfil) do Google Analytics é importante porque todos os relatórios são gerados nesse nível. Quando você consulta a API de relatórios principais, precisa especificar um parâmetro de ID da tabela em cada consulta de ids para identificar de qual vista da propriedade (perfil) os dados serão acessados. O parâmetro de ID da tabela é retornado em cada recurso de vista da propriedade (perfil).

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 vistas da propriedade (perfis), recomendamos implementar e verificar seu código com uma conta de teste. Ao usar uma conta de teste, você evita a implementação de alterações acidentais em uma vista da propriedade (perfil) ativa. Depois de testar e confirmar que seu código está funcionando conforme o esperado com uma conta de teste e vista da propriedade (perfil), você pode começar a usar a implementação com contas reais.

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

Limites e comportamento da vista da propriedade (perfil)

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

  • Há um limite superior de 25 vistas por propriedade por padrão. Você pode entrar em contato com o gerente da sua Conta do Google e aumentar esse limite para 200 em propriedades que não são premium e 400 em propriedades premium. Depois que uma conta atingir o limite, vistas da propriedade (perfis) adicionais não poderão ser criadas pela API, a não ser que uma ou mais das vistas da propriedade (perfis) existentes sejam excluídas. Além disso, as vistas da propriedade existentes (perfis) podem ser atualizadas e reutilizadas. Consulte Limites e cotas para conhecer os limites gerais.

Exemplos de códigos

Com a API de gerenciamento, você pode listar, recuperar, inserir, atualizar, corrigir e excluir vistas da propriedade (perfis) 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ódigo que mostram como trabalhar com o recurso de perfil, acesse estas referências de método:

  • list: lista as vistas da propriedade (perfis) a que o usuário tem acesso.
  • get: recupera uma vista da propriedade (perfil) a que o usuário tem acesso.
  • insert: cria uma nova vista da propriedade (perfil).
  • patch: atualiza uma vista da propriedade existente (perfil). Esse método é compatível com a semântica de patch.
  • update: atualiza uma vista da propriedade existente (perfil).
  • delete: exclui uma vista da propriedade (perfil).

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