API de gerenciamento - guia do desenvolvedor de links do Google AdWords

Este documento descreve como usar a API de gerenciamento para gerenciar a vinculação de contas do Google AdWords e do Google Analytics de um usuário autorizado.

Introdução

Os links do Google AdWords na API de gerenciamento permitem ver, listar, criar, atualizar e excluir links entre contas do Google AdWords e propriedades do Google Analytics e gerenciar quais vistas da propriedade (perfis) devem ser preenchidas com dados do Google AdWords.

Para saber mais sobre como funciona a vinculação do Google AdWords e conhecer suas vantagens, consulte Vincular o Google Analytics e o Google AdWords (Central de Ajuda do Google AdWords) e Vincular/desvincular o Google Analytics e o Google AdWords (Central de Ajuda do Google Analytics).

Antes de começar

Todas as Google Analytics APIs são acessadas de maneira semelhante. Antes de começar a usar a API de gerenciamento:

  • Leia a página Bibliotecas cliente para ver uma lista completa de bibliotecas cliente específicas de linguagens de programação que funcionam com a API.
  • Leia o Guia de referência para saber mais sobre a interface da API e sobre como acessar dados sem uma biblioteca cliente.

Cada biblioteca cliente fornece um único objeto de serviço de análise 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 concluí-lo, você saberá como acessar Google Analytics APIs para realizar tarefas reais.

Casos de uso

A vinculação do Google AdWords na API de gerenciamento pode ser usada para automatizar os seguintes casos de uso:

Listar todos os links do Google Analytics e do Google AdWords de uma propriedade

Para listar todos os links ativos do Google Analytics/Google AdWords de uma propriedade:

  1. Use a API de gerenciamento ou a interface da Web para recuperar o ID da conta e o ID da propriedade.
  2. Execute o método list do recurso entityAdWordsLinks.

Consulte a Referência da API para ver detalhes sobre o método list do recurso entityAdWordsLinks.

Criar um novo link entre o Google Analytics e o Google AdWords

Para criar um link entre uma propriedade do Google Analytics e uma conta do Google AdWords:

  1. Use a Google AdWords API ou a interface da Web para recuperar o ID de cliente.
  2. Use a interface da Web ou a API de gerenciamento do Google Analytics para recuperar o ID da conta e a propriedade à qual vincular a conta do Google AdWords.
  3. Para criar o link entre o Google AdWords e o Google Analytics, execute o método insert do recurso entityAdWordsLinks.

Consulte a Referência da API para ver detalhes sobre o método insert do recurso entityAdWordsLinks.

Para remover um link entre uma propriedade do Google Analytics e uma conta do Google AdWords:

  1. Use a interface da Web ou a API de gerenciamento do Google Analytics para recuperar o ID da conta e a propriedade com o link para remoção.
  2. Use a API de gerenciamento para recuperar o ID do link do Google AdWords.
  3. Para remover o link, execute o método delete do recurso entityAdWordsLinks.

Consulte a Referência da API para ver detalhes sobre o método delete do recurso entityAdWordsLinks.

Adicionar uma vista da propriedade (perfil) a um link existente do Google Analytics/Google AdWords

Para ativar os dados do Google AdWords nos relatórios de uma vista da propriedade (perfil):

  1. Use a interface da Web ou a API de gerenciamento do Google Analytics para recuperar o ID da conta, a propriedade e a vista da propriedade (perfil).
  2. Use a API de gerenciamento para recuperar o ID do link do Google AdWords ao qual a vista da propriedade (perfil) será vinculada.
  3. Para adicionar a vista da propriedade (perfil), execute o método patch do recurso entityAdWordsLinks.

Consulte a Referência da API para ver detalhes sobre o método patch do recurso entityAdWordsLinks.

Remover uma vista da propriedade (perfil) de um link do Google Analytics/Google AdWords

Para desvincular e remover os dados do Google AdWords dos relatórios de uma vista da propriedade (perfil):

  1. Use a interface da Web ou a API de gerenciamento do Google Analytics para recuperar o ID da conta, a propriedade e a vista da propriedade (perfil).
  2. Use a API de gerenciamento para recuperar o ID do link do Google AdWords ao qual a vista da propriedade (perfil) a ser removida está vinculada.
  3. Execute o método get do recurso entityAdWordsLinks e recupere a lista de IDs de perfil do link do Google AdWords.
  4. Remova o ID do perfil da lista recuperada na etapa 3.
  5. Para remover a vista da propriedade (perfil), execute o método patch do recurso entityAdWordsLinks usando a lista da etapa 4.

Consulte a Referência da API para ver detalhes sobre o método get do recurso entityAdWordsLinks.

Exemplos de códigos

O recurso AdWords Links permite que um usuário autorizado liste, recupere, exclua, atualize, corrija e insira links do Google AdWords. 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 os links do Google AdWords, acesse estas referências de método:

Gerenciamento de links do Google AdWords

  • list: lista os links do Google AdWords aos quais o usuário tem acesso.
  • get: recupera um link do Google AdWords ao qual o usuário tem acesso.
  • insert: cria um novo link do Google AdWords.
  • patch: corrige um link existente do Google AdWords.
  • update: atualiza um link existente do Google AdWords.
  • delete: exclui um link existente do Google AdWords.