O Google usa tecnologia de IA na tradução de conteúdos para seu idioma de preferência. As traduções com IA podem ter erros.

Autenticação e autorização

Assim como outras APIs do Google, a API Google Ads usa o protocolo OAuth 2.0 para autenticação e autorização. O OAuth 2.0 permite que o app cliente da API Google Ads acesse a conta de um usuário sem precisar processar ou armazenar as informações de login dele.

Este guia explica como configurar a biblioteca de cliente Java para autenticação da API Google Ads usando os três fluxos do OAuth 2.0 mais comuns, além de explicar as credenciais necessárias.

Para saber mais sobre o modelo de acesso da API Google Ads, leia o guia do modelo de acesso do Google Ads.

Credenciais

O acesso à API Google Ads exige credenciais do OAuth 2.0 e, em alguns casos, um ID do cliente de login.

Credenciais do OAuth 2.0

Para autorizar como usuários da Conta do Google com acesso a contas do Google Ads, forneça um conjunto de credenciais do OAuth 2.0. O tipo de credenciais necessárias varia de acordo com o fluxo do OAuth 2.0 usado.

A biblioteca oferece suporte a três fluxos:

Fluxo da conta de serviço
Fluxo de autenticação de usuário único
Fluxo de autenticação multiusuário

Consulte a visão geral do OAuth para detalhes sobre os fluxos do OAuth da API Google Ads e siga as instruções do fluxo que melhor atende às suas necessidades para receber as credenciais necessárias.

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 ID do administrador principal que você está usando para permissões de acesso. Para mais detalhes, consulte a documentação relacionada.

Na biblioteca de cliente, o ID do cliente de login é especificado pela chave api.googleads.loginCustomerId no arquivo ads.properties.

Configuração

É possível configurar a biblioteca de cliente com um arquivo ads.properties, variáveis de ambiente ou de maneira programática. Este guia se concentra no uso de um arquivo ads.properties. Consulte o guia de configuração para detalhes sobre todas as opções.

Se você estiver usando um arquivo ads.properties, coloque-o no diretório principal: ~/ads.properties.

Fluxos de trabalho do OAuth

Existem três fluxos de trabalho comuns usados ao trabalhar com a API Google Ads.

Fluxo da conta de serviço

Esse é o fluxo de trabalho recomendado se o seu não exigir interação humana. Esse fluxo de trabalho exige uma etapa de configuração em que o usuário adiciona uma conta de serviço à conta do Google Ads. Em seguida, o app pode usar as credenciais da conta de serviço para gerenciar a conta do Google Ads do usuário.

Depois de ter o arquivo JSON da chave privada, adicione o seguinte ao arquivo ads.properties:

api.googleads.serviceAccountSecretsPath=INSERT_PATH_TO_JSON_HERE
# Only add this key if you are using Google Workspace domain-wide delegation
# to impersonate a user who has access to the Google Ads account.
# api.googleads.serviceAccountUser=USER_EMAIL_TO_IMPERSONATE

Consulte o guia de fluxo de trabalho da conta de serviço para saber mais.

Fluxo de autenticação de usuário único

Esse fluxo de trabalho pode ser usado se você não puder usar contas de serviço. Esse fluxo de trabalho exige duas etapas de configuração:

Dê a um único usuário acesso a todas as contas que serão gerenciadas usando a API Google Ads. Uma abordagem comum é conceder ao usuário acesso a uma conta de administrador da API Google Ads e vincular todas as contas de destino do Google Ads a essa conta de administrador.
O usuário executa uma ferramenta de linha de comando, como a CLI gcloud ou o exemplo de código GenerateUserCredentials, para autorizar seu app a gerenciar todas as contas do Google Ads em nome dele.

Depois de ter essas credenciais, adicione o seguinte ao arquivo ads.properties:

api.googleads.clientId=INSERT_CLIENT_ID_HERE
api.googleads.clientSecret=INSERT_CLIENT_SECRET_HERE
api.googleads.refreshToken=INSERT_REFRESH_TOKEN_HERE

Consulte o guia do fluxo de trabalho de autenticação de usuário único para saber mais.

Fluxo de autenticação multiusuário

Esse é o fluxo de trabalho recomendado se o app permitir que os usuários façam login e autorizem o app a gerenciar as contas do Google Ads em nome deles. O exemplo de código GenerateUserCredentials é uma ferramenta de linha de comando que ilustra como obter a autenticação do usuário em tempo de execução para gerenciar as contas do Google Ads em nome dele. Use este exemplo de código como referência para criar apps da Web ou para computador que exigem autenticação do usuário.

Para aplicativos multiusuário, armazene o ID do cliente e a chave secreta do OAuth 2.0 do aplicativo em ads.properties (ou outro armazenamento de configuração), além de armazenar o token de atualização de cada usuário final com segurança no banco de dados do aplicativo e transmiti-lo de maneira programática no tempo de execução ao criar UserCredentials e GoogleAdsClient:

api.googleads.clientId=INSERT_CLIENT_ID_HERE
api.googleads.clientSecret=INSERT_CLIENT_SECRET_HERE

Consulte o guia do fluxo de trabalho de autenticação multiusuário para saber mais.

Gerenciar várias contas

É comum um usuário gerenciar mais de uma conta do Google Ads, seja por acesso direto a elas ou por uma conta de administrador do Google Ads. A biblioteca de cliente Java fornece os exemplos de código a seguir que ilustram como lidar com esses casos:

O exemplo de código GetAccountHierarchy mostra como recuperar a lista de todas as contas em uma conta de administrador do Google Ads.
O exemplo de código ListAccessibleCustomers mostra como recuperar a lista de todas as contas a que um usuário tem acesso direto. Essas contas podem ser usadas como valores válidos para a configuração loginCustomerId.

Application Default Credentials

A biblioteca de cliente Java também oferece suporte à autenticação com Application Default Credentials.

Isso é útil principalmente para desenvolvimento local ou com diferentes APIs do Google, já que é possível reutilizar as mesmas credenciais, desde que elas acessem os escopos necessários do OAuth 2.0.

Para a API Google Ads, verifique se as Application Default Credentials podem acessar o escopo https://www.googleapis.com/auth/adwords do OAuth 2.0.

Para usar o Application Default Credentials, defina a opção api.googleads.useApplicationDefaultCredentials como true no arquivo ads.properties ou chame .enableApplicationDefaultCredentials() em GoogleAdsClient.newBuilder(). Ao usar o Application Default Credentials, o ID do cliente, o segredo do cliente e o token de atualização não devem ser definidos.