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 do Google Ads de um usuário sem precisar processar ou armazenar as informações de login dele.

Entender o modelo de acesso do Google Ads

Para trabalhar de maneira eficaz com a API Google Ads, é necessário entender como o modelo de acesso do Google Ads funciona. Recomendamos a leitura do guia do modelo de acesso do Google Ads.

Fluxos de trabalho do OAuth

Há 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 ele 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. A biblioteca é configurada da seguinte maneira:


// Initialize a GoogleAdsConfig class.
GoogleAdsConfig config = new GoogleAdsConfig()
{
    DeveloperToken = "******",
    OAuth2Mode = OAuth2Flow.SERVICE_ACCOUNT,
    OAuth2SecretsJsonPath = "PATH_TO_CREDENTIALS_JSON",
    LoginCustomerId = ******
};

// Initialize a GoogleAdsClient class.
GoogleAdsClient client = new GoogleAdsClient(config);

Consulte o guia do 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. Ele exige duas etapas de configuração:

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

A biblioteca pode ser inicializada usando as credenciais do OAuth 2.0 do usuário da seguinte maneira:

GoogleAdsConfig googleAdsConfig = new GoogleAdsConfig()
{
    DeveloperToken = DEVELOPER_TOKEN,
    LoginCustomerId = LOGIN_CUSTOMER_ID,
    OAuth2ClientId = OAUTH_CLIENT_ID,
    OAuth2ClientSecret = OAUTH_CLIENT_SECRET,
    OAuth2RefreshToken = REFRESH_TOKEN,
};

GoogleAdsClient googleAdsClient = new GoogleAdsClient(googleAdsConfig);

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 app cria e gerencia as credenciais de usuário do OAuth 2.0. A biblioteca pode ser inicializada usando as credenciais do usuário da seguinte maneira:

GoogleAdsConfig googleAdsConfig = new GoogleAdsConfig()
{
    DeveloperToken = DEVELOPER_TOKEN,
    LoginCustomerId = LOGIN_CUSTOMER_ID,
    OAuth2ClientId = OAUTH_CLIENT_ID,
    OAuth2ClientSecret = OAUTH_CLIENT_SECRET,
    OAuth2RefreshToken = REFRESH_TOKEN,
};

GoogleAdsClient googleAdsClient = new GoogleAdsClient(googleAdsConfig);

Consulte o guia do fluxo de trabalho de autenticação multiusuário para saber mais. A biblioteca de cliente do .NET inclui dois exemplos de código para referência:

  1. O AuthenticateInAspNetCoreApplication exemplo de código ilustra como criar um app da Web que recebe a autenticação do usuário no momento da execução para gerenciar as contas do Google Ads em nome dele. O app usa as credenciais do OAuth 2.0 do usuário para recuperar as campanhas na conta do Google Ads.

  2. O GenerateUserCredentials é um exemplo de código de linha de comando que ilustra como receber a autenticação do usuário no momento da execução para gerenciar as contas do Google Ads em nome dele. Você pode usar esse exemplo de código como referência para criar apps para computador que exigem autenticação do usuário.

E se o usuário gerenciar várias contas?

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

  1. O exemplo de código GetAccountHierarchy mostra como recuperar a lista de todas as contas em uma conta de administrador do Google Ads.
  2. 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 do .NET também oferece suporte à autenticação com Application Default Credentials.

Isso é particularmente útil para desenvolvimento local ou para desenvolvimento em diferentes APIs do Google, já que você pode reutilizar as mesmas credenciais, desde que elas possam acessar os escopos corretos 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 OAuth2.0.

Para usar as Application Default Credentials, defina a opção UseApplicationDefaultCredentials como true no GoogleAdsConfig. Isso pode ser feito da mesma forma que a definição de outras propriedades de configuração na biblioteca de cliente, seja no código, em um arquivo de configuração ou usando variáveis de ambiente.

Consulte a página de configuração para mais detalhes sobre as opções disponíveis para configurar a biblioteca de cliente do .NET.