Esta página foi traduzida pela API Cloud Translation.

Como começar

Recomendamos o uso da biblioteca de cliente com o Apache Maven (ou 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 Maven central repositório.

A dependência do Maven é:

<dependency>
  <groupId>com.google.api-ads</groupId>
  <artifactId>google-ads</artifactId>
  <version>33.0.0</version>
</dependency>

A dependência do Gradle é:

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

Você também pode criar a partir da origem. Para este supõe-se que você tenha 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 desenvolvedor da API Google Ads com base no token correto anterior. Esta seção explica o que são eles, como são usados e como obtidos.

Token de desenvolvedor (para acesso à API)

O token de desenvolvedor está vinculado a um administrador. do Google Ads e pode ser encontrada na interface do Google Ads na Web.

Embora o token de desenvolvedor esteja vinculado a uma conta de administrador, ele não fornece acesso a ela. Em vez disso, o token de desenvolvedor concede acesso a a 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 como usuários de Contas do Google com acesso a contas do Google Ads, precisa fornecer um conjunto de credenciais OAuth.

Há dois fluxos OAuth que costumam ser usados: aplicativo para computador (instalado) ou aplicativo da Web. A principal diferença entre os dois é que os aplicativos para computador precisam abra o navegador do sistema e forneça um URI de redirecionamento local para lidar com as respostas o servidor de autorização do Google, enquanto os apps da Web podem redirecionar navegador de terceiros para concluir a autorização e enviar as credenciais de volta para seu servidor. A biblioteca também oferece suporte à conta de serviço menos usada fluxo

Se você autorizar o uso das suas próprias credenciais (fluxo do app para computador): Consulte o App OAuth para computador fluxo. Isso inclui todos os detalhes que você necessário para autorização com suas próprias credenciais.
Se você autorizar como usuário terceirizado do Google (fluxo da Web): Consulte o fluxo do app da Web OAuth. Isso fornece um exemplo de como configurar a autorização OAuth para aplicativos de terceiros arbitrários usuários.
Se você autorizar como usuário do domínio do Google Apps (fluxo da conta de serviço): Consultar a conta de serviço OAuth fluxo. Isso dá um exemplo de como configurar a autorização OAuth para usuários do domínio do Google Apps.

Se você acessa a conta de cliente do Google Ads por meio de um administrador do Google Ads , especifique também um ID de cliente de login, conforme descrito abaixo.

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

Você também pode especificar o ID de cliente de uma conta de administrador que dá acesso a a conta de veiculação. Deve ser especificado se seu acesso ao cliente é usando uma conta de administrador. Não é necessário especificar todos os contas no caminho para o ID de cliente, apenas o ID de administrador superior que você estão usando para as permissões de acesso. Para mais detalhes, consulte a documentação Documentação.

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. Para este guia, usaremos o do arquivo de configuração do Terraform e concentre-se nos fluxos de computador e da Web. Ao usar um de configuração do Terraform normalmente é uma boa abordagem se você tem apenas um conjunto de credenciais (por exemplo, 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 de posição pelas credenciais recebidas na etapa anterior.

Além disso, se o token de atualização for para uma conta de administrador, você precisará especifique 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 experimento GetCampaigns exemplo.

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

$ cd google-ads-examples

Este exemplo requer um parâmetro --customerId em que o valor é seu ID de cliente da 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 requer parâmetros. É possível transmitir os parâmetros como argumentos (recomendado) ou edite os valores INSERT_XXXXX_HERE no código-fonte. Para ver uma declaração de uso Para ver 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 uma pesquisa termo.

# 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'