A API de gerenciamento do Google Analytics permite acesso programático a contas, propriedades e vistas da propriedade. Este documento descreve como usar vários recursos da API para definir a configuração da sua conta do Google Analytics.
Introdução
Há dois casos de uso comuns que a API de gerenciamento abrange com relação à configuração da sua conta do Google Analytics. O primeiro é a necessidade de ver um rápido resumo da conta com a árvore hierárquica completa de contas, propriedades e vistas da propriedade. O segundo é fazer mudanças específicas na configuração.
.Resumos da conta
A extremidade dos Resumos da conta fornece uma forma fácil de listar informações simples sobre as contas, propriedades e vistas da propriedade do Google Analytics para um usuário autorizado com uma única e rápida solicitação.
É possível usar resumos da conta para criar um índice da hierarquia da conta. É comum os aplicativos se integrarem ao Google Analytics para fornecer uma interface para os usuários selecionarem uma conta, propriedade e vista da propriedade. Com uma única solicitação à API, você pode recuperar todas as informações relevantes para criar tal seletor. Para ver um exemplo, consulte o Explorador de consultas e os exemplos de código no GitHub (link em inglês).
Consulte a Referência de recursos e a referência de métodos de lista de resumos da conta para mais detalhes e exemplos de código.
Configuração da conta
Ao contrário dos resumos da conta quando você usa o método de lista dos recursos Account, Property e View, a API retorna detalhes completos de cada recurso.
Contas
Como são entidades de nível superior, as contas são importantes porque cada solicitação de API de nível inferior requer um ID de conta. A API de gerenciamento só permite a operação listar em contas. Na resposta da API está a propriedade childlink, que fornece a solicitação de API para todas as propriedades da Web filhas.
Propriedades
Também chamadas de propriedades da Web, as entidades de segundo nível são importantes porque todas as coletas de dados ocorrem nesse nível. Por exemplo, quando você adiciona um código de acompanhamento a um site ou aplicativo para dispositivos móveis, é necessário incluir um ID semelhante a UA-XXXXX-Y. Esse ID é chamado de ID da propriedade ou ID de acompanhamento e diferencia a conta do Google Analytics em que os dados são armazenados. Você pode usar a API para criar ou atualizar propriedades. Consulte o recurso de propriedade para ver detalhes e exemplos de código.
Visualizações
Como o terceiro nível na hierarquia da conta, as vistas da propriedade (perfis) são importantes porque os relatórios são gerados no nível delas. A API Core Reporting usa o ID da vista (perfil) como um parâmetro principal para especificar de qual vista recuperar dados. Além de ser o nível dos relatórios, muitos outros recursos estão vinculados ou são filhos desse recurso, por exemplo, metas, experimentos, relatórios sem dados de amostra e links de filtro. Você pode usar a API para criar ou atualizar vistas da propriedade. Consulte o recurso vista da propriedade (perfil) para ver detalhes e exemplos de código.
Próximas etapas
Depois de ler este guia, você deverá saber como usar a API de gerenciamento para transferir e manipular as diversas entidades de configuração da conta. O próximo guia explica como usar a API para gerenciar usuários.