Recomendamos usar a biblioteca de cliente com o Apache Maven (ou o Gradle).
Criar um novo projeto Maven/Gradle
Crie um novo projeto Maven/Gradle no ambiente de desenvolvimento integrado de sua escolha. Nossos artefatos são publicados no repositório central do Maven.
A dependência do Maven é:
<dependency>
<groupId>com.google.api-ads</groupId>
<artifactId>google-ads</artifactId>
<version>35.0.0</version>
</dependency>
A dependência do Gradle é:
implementation 'com.google.api-ads:google-ads:35.0.0'
Também é possível criar a partir da origem. Para os fins deste guia, presumimos que você tenha uma configuração de projeto com as dependências necessárias disponíveis.
Receber credenciais para autenticação com a API
O acesso à API Google Ads requer credenciais OAuth e um token de desenvolvedor da API Google Ads. Esta seção explica o que são, como são usados e como são obtidos.
Token de desenvolvedor (para acesso à API)
O token de desenvolvedor está vinculado a uma conta de administrador e pode ser encontrado na interface da Web do Google Ads.
Embora o token de desenvolvedor esteja vinculado a uma conta de administrador, ele não oferece acesso a essa conta. Em vez disso, o token de desenvolvedor concede acesso à API em geral, e o acesso no nível da conta é configurado pelo OAuth.
Credenciais OAuth (para acesso às contas do Google Ads)
Para autorizar usuários de Contas do Google com acesso às contas do Google Ads, você precisa fornecer um conjunto de credenciais do OAuth.
Geralmente, são usados dois fluxos OAuth: app para computador (instalado) ou app da Web. A principal diferença entre os dois é que os apps para computador precisam abrir o navegador do sistema e fornecer um URI de redirecionamento local para processar as respostas do servidor de autorização do Google, enquanto os apps da Web podem redirecionar um navegador de terceiros arbitrário para concluir a autorização e enviar as credenciais de volta ao servidor. A biblioteca também oferece suporte ao fluxo de conta de serviço menos usado.
- Se você autorizar usando suas próprias credenciais (fluxo de app para computador)
- Consulte o fluxo do app para computador OAuth. Isso inclui todos os detalhes necessários para a autorização com suas próprias credenciais.
- Se você autorizar como um usuário externo do Google (fluxo da Web)
- Consulte o fluxo do app da Web do OAuth. Confira um exemplo de como configurar a autorização OAuth para usuários arbitrários de terceiros.
- Se você autorizar como um usuário do domínio do Google Apps (fluxo de conta de serviço)
- Consulte o fluxo da conta de serviço do OAuth. Confira um exemplo de como configurar a autorização OAuth para usuários de domínios do Google Apps.
Se você tiver acesso à conta de cliente do Google Ads por uma conta de administrador do Google Ads, também precisará especificar um ID de cliente de login, conforme descrito abaixo.
ID de cliente de login (para acessar contas do Google Ads por uma conta de administrador)
Opcionalmente, especifique o ID do cliente de uma conta de administrador que dá acesso à conta de veiculação. Isso precisa ser especificado se o acesso à conta do cliente for feito por uma conta de administrador. Não é necessário especificar todas as contas de administrador no caminho para o ID do cliente, apenas o ID de administrador mais alto que você está usando para permissões de acesso. Para mais detalhes, consulte a documentação relacionada.
Configurar a biblioteca de cliente com suas credenciais
É possível configurar a biblioteca de cliente com um arquivo de configuração, variáveis de ambiente ou programaticamente. Neste guia, vamos usar a abordagem de arquivo de configuração e nos concentrar nos fluxos da Web e para computadores. Usar um arquivo de configuração geralmente é uma boa abordagem se você tiver apenas um conjunto de credenciais (por exemplo, se você gerenciar contas em um único gerenciador).
Crie um arquivo ~/ads.properties com o seguinte conteúdo.
api.googleads.clientId=INSERT_CLIENT_ID_HERE
api.googleads.clientSecret=INSERT_CLIENT_SECRET_HERE
api.googleads.refreshToken=INSERT_REFRESH_TOKEN_HERE
api.googleads.developerToken=INSERT_DEVELOPER_TOKEN_HERE
Substitua os marcadores de posição pelas credenciais obtidas na etapa anterior.
Além disso, se o token de atualização for de uma conta de administrador, especifique o ID de cliente dessa conta como o cliente de login:
api.googleads.loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE
Validar as credenciais
Para garantir que tudo esteja configurado corretamente, vamos executar o exemplo GetCampaigns.
Primeiro, navegue até o diretório google-ads-examples.
$ cd google-ads-examples
Esse exemplo requer um parâmetro --customerId em que o valor é o ID de cliente da sua conta do Google Ads sem traços.
Para executar com o Gradle:
$ ./gradlew -q runExample --example="basicoperations.GetCampaigns --customerId INSERT_CUSTOMER_ID_HERE"
Confira outros exemplos
O pacote examples em google-ads-examples
contém vários exemplos úteis. A maioria dos exemplos exige
parâmetros. É possível transmitir os parâmetros como argumentos (recomendado) ou
editar os valores de INSERT_XXXXX_HERE no código-fonte. Para conferir um exemplo de declaração de uso, transmita --help como o único argumento.
Com o Gradle:
$ ./gradlew -q runExample --example="basicoperations.GetCampaigns --help"
Também é possível usar a tarefa listExamples no Gradle para listar todos os exemplos,
exemplos em um subdiretório ou exemplos em que a descrição inclui um termo de
pesquisa.
# List all examples:
$ ./gradlew -q listExamples
# List examples in the 'basicoperations' subdirectory:
$ ./gradlew -q listExamples --subdirectory='basicoperations'
# Search for examples where the description includes 'Performance Max':
$ ./gradlew -q listExamples --searchTerm='Performance Max'