Vamos começar

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

Criar um novo projeto do 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>21.0.0</version>
</dependency>

A dependência do Gradle é:

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

Você também pode criar a partir da fonte. Para este guia, vamos supor que você tenha uma configuração de projeto com as dependências necessárias disponíveis.

Conseguir credenciais para autenticar 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 esses recursos, como eles são usados e como são recebidos.

Token de desenvolvedor (para acesso à API)

O token de desenvolvedor está vinculado a uma conta de administrador e pode ser encontrado na IU do Google Ads. Para mais detalhes, consulte este guia.

Credenciais OAuth (para acesso a contas do Google Ads)

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

Existem dois fluxos do OAuth geralmente usados: app da Web (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ários para concluir a autorização e enviar as credenciais de volta ao servidor. A biblioteca também oferece suporte ao fluxo de contas de serviço menos usado.

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

Se o acesso à conta de cliente do Google Ads for feito por uma conta de administrador do Google Ads, você também precisará especificar um ID de cliente de login conforme descrito abaixo.

ID de cliente de login (para acesso a contas do Google Ads com 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 por uma conta de administrador. Não é necessário especificar todas as contas de administrador no caminho para o ID do cliente, apenas o código de administrador superior que você está usando para as permissões de acesso. Para mais detalhes, consulte a documentação relacionada.

Configure a biblioteca de cliente com suas credenciais

Você pode configurar a biblioteca de cliente com um arquivo de configuração, variáveis de ambiente ou de maneira programática. Para este guia, usaremos a abordagem de arquivo de configuração e nos concentraremos nos fluxos da área de trabalho e da Web. Geralmente, usar um arquivo de configuração é uma boa abordagem se você tem apenas um conjunto de credenciais (por exemplo, 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 para uma conta de administrador, você precisará especificar o ID de cliente dessa conta como cliente de login:

api.googleads.loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE

Validar as credenciais

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

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

$ cd google-ads-examples

Este 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"

Veja outros exemplos

O pacote examples no google-ads-examples contém vários exemplos úteis. A maioria dos exemplos requer 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 para um exemplo, transmita --help como o único argumento.

Com o Gradle:

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