Gerenciamento da conta

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 é a realização de alterações 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 amostras de código no GitHub.

Consulte a referência de recursos e a referência de métodos de lista dos resumos da conta para ver detalhes e exemplos de código.

Configuração da conta

Em contraste com os resumos da conta, quando você usa o método de lista dos recursos Conta, Propriedade e Vista, a API retorna os detalhes completos de cada recurso.

Contas

Como são as entidades de nível mais alto, as contas são importantes porque toda solicitação da API de nível mais baixo precisa de um ID de conta. A API de gerenciamento só permite a operação list nas contas. Na resposta da API está incluída a propriedade childlink, que fornece a solicitação da API para todas as propriedades da Web secundárias.

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 website ou aplicativo para dispositivos móveis, precisa incluir um ID semelhante a UA-XXXXX-Y. Esse ID se chama "ID da propriedade" ou "ID de acompanhamento" e determina em que conta do Google Analytics 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.

Vistas da propriedade

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 de relatórios principais, 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 a esse recurso ou são secundários a ele, por exemplo, metas, experiências, 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.