Vamos começar

Recomendamos usar a biblioteca de cliente com o Apache Maven (ou o Gradle).

Criar um novo projeto Maven/Gradle

Crie um novo projeto do 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>22.0.0</version>
</dependency>

A dependência do Gradle é:

implementation 'com.google.api-ads:google-ads:22.0.0'

Também é possível criar a partir da fonte. Para este guia, presumiremos que você tem uma configuração de projeto com as dependências necessárias disponíveis.

Receber credenciais para autenticar com a API

O acesso à API Google Ads requer credenciais de OAuth e um token de desenvolvedor da API Google Ads. Nesta seção, explicamos o que são, como são usados e como são recebidos.

Token de desenvolvedor (para acesso à API)

O token de desenvolvedor é vinculado a uma conta de administrador e pode ser encontrado na IU do Google Ads. Veja mais detalhes neste guia.

Credenciais de OAuth (para acesso a contas do Google Ads)

Para autorizar como usuários da Conta do Google com acesso a contas do Google Ads, você precisa fornecer um conjunto de credenciais do OAuth.

Existem dois fluxos do OAuth geralmente usados: apps para computador (instalados) ou apps da Web. A principal diferença entre os dois é que os apps para computadores precisam abrir o navegador do sistema e fornecer um URI de redirecionamento local para processar as respostas do servidor de autorização do Google. Já 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 aceita o fluxo de conta de serviço menos usado.

Se você autorizar usando suas próprias credenciais (fluxo de apps para computador)
Consulte o fluxo de apps para computador OAuth. Isso inclui todos os detalhes necessários para a autorização com suas credenciais.
Se você autorizar como um usuário do Google de terceiros (fluxo da Web)
Consulte o fluxo de app da Web do OAuth. Veja 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 de conta de serviço do OAuth. Isso mostra um exemplo de como configurar a autorização OAuth para usuários do domínio do Google Apps.

Se você tem acesso à conta de cliente do Google Ads por meio de uma conta de administrador do Google Ads, também precisa especificar um ID de cliente de login conforme descrito abaixo.

ID de cliente de login (para acesso a contas do Google Ads por meio de uma conta de administrador)

Se quiser, especifique o ID de 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 de cliente, apenas o código de administrador principal que você está usando para as 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, usaremos a abordagem do arquivo de configuração e nos concentraremos nos fluxos da área de trabalho e da Web. Usar um arquivo de configuração geralmente é uma boa abordagem se você tem apenas um conjunto de credenciais (por exemplo, se você gerencia contas em um único administrador).

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 pelas credenciais recebidas na etapa anterior.

Além disso, se o token de atualização for de uma conta de administrador, você precisará especificar o ID de cliente dessa conta como o cliente de login:

api.googleads.loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE

Valide as credenciais

Para garantir que tudo esteja configurado corretamente, executaremos o exemplo GetCampaigns.

Primeiro, navegue até o diretório google-ads-examples.

$ cd google-ads-examples

Esse exemplo exige um parâmetro --customerId, em que o valor é o ID do 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"

Explorar 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 INSERT_XXXXX_HERE no código-fonte. Para ver uma instrução de uso de um exemplo, transmita --help como o único argumento.

Com o Gradle:

$ ./gradlew -q runExample --example="basicoperations.GetCampaigns --help"

Você também pode 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'