Bibliotecas de clientes

As bibliotecas de cliente da API Google Ads oferecem visões de alto nível e blocos de construção básicos da funcionalidade da API Google Ads, facilitando o desenvolvimento rápido de apps. Comece com uma biblioteca de cliente se você não conhece a API.

Bibliotecas comunitárias

Conhecemos várias bibliotecas mantidas pela comunidade de código aberto. Mantemos essa lista para ajudar os desenvolvedores interessados a encontrá-los. Não testamos, contribuímos nem fazemos a manutenção dessas bibliotecas. Use-as por sua conta e risco. Se tiver dúvidas, entre em contato com os proprietários dos projetos de código aberto.

Se você souber de alguma biblioteca que não incluímos, clique em Enviar feedback na parte de cima da página e nos informe.

• Node.js: google-ads-api no npm
• Go: google-ads-pb no GitHub

Versões da API compatíveis

A tabela mostra quais bibliotecas de cliente funcionam com quais versões da API.

A versão mínima da biblioteca de cliente listada é suficiente para a principal versão da API Google Ads (como v25). Para conferir a versão necessária da biblioteca de cliente para lançamentos secundários, consulte o changelog vinculado.

Configuração

Cada biblioteca de cliente da API Google Ads oferece diferentes configurações de configuração e métodos de carregamento que podem ser usados para personalizar o comportamento dela.

Confira as variáveis de ambiente padrão que podem ser usadas para configurar as bibliotecas de cliente:

• Biblioteca de cliente
  • GOOGLE_ADS_CONFIGURATION_FILE_PATH: caminho para o arquivo de configuração (lido automaticamente ao carregar de um arquivo de configuração sem um argumento de caminho explícito em Java (fromPropertiesFile()), Perl (Client->new()), PHP (fromFile()), Python (load_from_storage(), e também verificado por load_from_env()) e Ruby (GoogleAdsClient.new); em .NET, carregue essa variável explicitamente usando config.TryLoadFromEnvironmentFilePath ou carregue arquivos de configuração usando LoadFromSettingsJson, LoadFromConfigurationSection ou LoadFromConfigurationRoot).
• OAuth2
  • Modo de aplicação
    • GOOGLE_ADS_CLIENT_ID: defina esse valor como seu ID do cliente OAuth2.
    • GOOGLE_ADS_CLIENT_SECRET: defina esse valor como a chave secreta do cliente OAuth2.
    • GOOGLE_ADS_REFRESH_TOKEN: defina esse valor como um token de atualização do OAuth2 pré-gerado se quiser reutilizar tokens do OAuth2. Essa configuração é opcional.
  • Modo de conta de serviço
    • GOOGLE_ADS_JSON_KEY_FILE_PATH: defina esse valor como o caminho do arquivo de chave JSON do OAuth2 (em .NET, defina também GOOGLE_ADS_OAUTH2_MODE como SERVICE_ACCOUNT, já que OAuth2Mode é definido como APPLICATION por padrão. Em versões do PHP anteriores a v32.1.0 ou ao usar escopos personalizados, defina também [OAUTH2] scopes em google_ads_php.ini ou chame withScopes(), já que fromEnvironmentVariables() não lê escopos do OAuth2 de uma variável de ambiente).
    • GOOGLE_ADS_IMPERSONATED_EMAIL: defina esse valor como o endereço de e-mail da conta que você está representando ao usar a delegação em todo o domínio do Google Workspace. Essa configuração é opcional.
  • Modo Application Default Credentials
    • GOOGLE_ADS_USE_APPLICATION_DEFAULT_CREDENTIALS: defina esse valor como true para autenticar usando o Application Default Credentials (ADC). Compatível com Java v41.1.0 e versões mais recentes, Python v28.3.0 e versões mais recentes e Ruby v36.1.0 e versões mais recentes. No .NET v24.1.0 e versões mais recentes, LoadFromEnvironmentVariables() lê a variável USE_APPLICATION_DEFAULT_CREDENTIALS sem prefixo. Também é possível definir UseApplicationDefaultCredentials = true em GoogleAdsConfig. Em PHP, OAuth2TokenBuilder faz fallback automático para o ADC quando não há credenciais OAuth2 explícitas definidas. O Perl não é compatível com o ADC.
• API Google Ads
  • GOOGLE_ADS_DEVELOPER_TOKEN: opcional nas versões mais recentes (Java v46.0.0 e mais recente, .NET v27.3.0 e mais recente, PHP v35.0.0 e mais recente, Python v32.0.0 e mais recente, Ruby v45.0.0 e mais recente e Perl v35.0.0 e mais recente). Os tokens de desenvolvedor foram desativados em 9 de setembro de 2026, e os servidores de API ignoram o cabeçalho developer-token, seja qual for a versão da biblioteca de cliente (até que uma versão principal futura da API Google Ads o rejeite). As versões anteriores da biblioteca de cliente ainda exigem um valor não vazio para a validação local do lado do cliente. Consulte o guia de configuração de cada biblioteca para detalhes específicos da versão.
  • GOOGLE_ADS_LOGIN_CUSTOMER_ID: o ID do cliente autorizado a usar na solicitação, sem hífens (-).
  • GOOGLE_ADS_LINKED_CUSTOMER_ID: esse cabeçalho só é obrigatório para métodos que atualizam os recursos de uma entidade quando têm permissão pelas contas vinculadas na interface do Google Ads (recurso AccountLink na API Google Ads). Defina esse valor como o ID do cliente do provedor de dados que atualiza os recursos do ID do cliente especificado. Ele precisa ser definido sem hifens (-). Para saber mais sobre contas vinculadas, acesse a Central de Ajuda.

As variáveis de ambiente são definidas em um arquivo de configuração do bash, como um arquivo .bashrc ou .bash_profile localizado no diretório $HOME. Eles também podem ser definidos usando a linha de comando.

Confira algumas etapas básicas para definir uma variável de ambiente usando um arquivo .bashrc em um terminal:

# Append the line "export GOOGLE_ADS_CLIENT_ID=1234567890" to
# the bottom of your .bashrc file.
echo "export GOOGLE_ADS_CLIENT_ID=1234567890" >> ~/.bashrc

# Update your bash environment to use the most recently updated
# version of your .bashrc file.
source ~/.bashrc

As variáveis de ambiente também podem ser definidas na instância do terminal diretamente na linha de comando:

export GOOGLE_ADS_CLIENT_ID=1234567890

Outra alternativa é definir variáveis de ambiente ao chamar o comando que as usa:

GOOGLE_ADS_CLIENT_ID=1234567890 php /path/to/script/that/uses/envvar.php

Buscar entidades

GoogleAdsService.SearchStream é usado normalmente para buscar entidades, e os resultados são retornados como um fluxo de linhas. Como alternativa, use GoogleAdsService.Search para buscar entidades em uma conexão de Internet não confiável. GoogleAdsService.Search retorna resultados como tamanhos de página fixos de 10.000 linhas por página.

As bibliotecas de cliente implementam a paginação automaticamente quando você itera os resultados para que seja possível fazer o download e processar todos eles de uma só vez.

private void runExample(GoogleAdsClient googleAdsClient, long customerId) {
  try (GoogleAdsServiceClient googleAdsServiceClient =
      googleAdsClient.getLatestVersion().createGoogleAdsServiceClient()) {
    String query = "SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id";
    // Constructs the SearchGoogleAdsStreamRequest.
    SearchGoogleAdsStreamRequest request =
        SearchGoogleAdsStreamRequest.newBuilder()
            .setCustomerId(Long.toString(customerId))
            .setQuery(query)
            .build();

    // Creates and issues a search Google Ads stream request that will retrieve all campaigns.
    ServerStream<SearchGoogleAdsStreamResponse> stream =
        googleAdsServiceClient.searchStreamCallable().call(request);

    // Iterates through and prints all of the results in the stream response.
    for (SearchGoogleAdsStreamResponse response : stream) {
      for (GoogleAdsRow googleAdsRow : response.getResultsList()) {
        System.out.printf(
            "Campaign with ID %d and name '%s' was found.%n",
            googleAdsRow.getCampaign().getId(), googleAdsRow.getCampaign().getName());
      }
    }
  }
}
GetCampaigns.java
      

public void Run(GoogleAdsClient client, long customerId)
{
    // Get the GoogleAdsService.
    GoogleAdsServiceClient googleAdsService = client.GetService(
        Services.V25.GoogleAdsService);

    // Create a query that will retrieve all campaigns.
    string query = @"SELECT
                    campaign.id,
                    campaign.name,
                    campaign.network_settings.target_content_network
                FROM campaign
                ORDER BY campaign.id";

    try
    {
        // Issue a search request.
        googleAdsService.SearchStream(customerId.ToString(), query,
            delegate (SearchGoogleAdsStreamResponse resp)
            {
                foreach (GoogleAdsRow googleAdsRow in resp.Results)
                {
                    Console.WriteLine("Campaign with ID {0} and name '{1}' was found.",
                        googleAdsRow.Campaign.Id, googleAdsRow.Campaign.Name);
                }
            }
        );
    }
    catch (GoogleAdsException e)
    {
        Console.WriteLine("Failure:");
        Console.WriteLine($"Message: {e.Message}");
        Console.WriteLine($"Failure: {e.Failure}");
        Console.WriteLine($"Request ID: {e.RequestId}");
        throw;
    }
}
GetCampaigns.cs
      

public static function runExample(GoogleAdsClient $googleAdsClient, int $customerId)
{
    $googleAdsServiceClient = $googleAdsClient->getGoogleAdsServiceClient();
    // Creates a query that retrieves all campaigns.
    $query = 'SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id';
    // Issues a search stream request.
    /** @var GoogleAdsServerStreamDecorator $stream */
    $stream = $googleAdsServiceClient->searchStream(
        SearchGoogleAdsStreamRequest::build($customerId, $query)
    );

    // Iterates over all rows in all messages and prints the requested field values for
    // the campaign in each row.
    foreach ($stream->iterateAllElements() as $googleAdsRow) {
        /** @var GoogleAdsRow $googleAdsRow */
        printf(
            "Campaign with ID %d and name '%s' was found.%s",
            $googleAdsRow->getCampaign()->getId(),
            $googleAdsRow->getCampaign()->getName(),
            PHP_EOL
        );
    }
}
GetCampaigns.php
      

def main(client: GoogleAdsClient, customer_id: str) -> None:
    ga_service: GoogleAdsServiceClient = client.get_service("GoogleAdsService")

    query: str = """
        SELECT
          campaign.id,
          campaign.name
        FROM campaign
        ORDER BY campaign.id"""

    # Issues a search request using streaming.
    stream: Iterator[SearchGoogleAdsStreamResponse] = ga_service.search_stream(
        customer_id=customer_id, query=query
    )

    for batch in stream:
        rows: List[GoogleAdsRow] = batch.results
        for row in rows:
            print(
                f"Campaign with ID {row.campaign.id} and name "
                f'"{row.campaign.name}" was found.'
            )
get_campaigns.py
      

def get_campaigns(customer_id)
  # GoogleAdsClient will read a config file from
  # ENV['HOME']/google_ads_config.rb when called without parameters
  client = Google::Ads::GoogleAds::GoogleAdsClient.new

  responses = client.service.google_ads.search_stream(
    customer_id: customer_id,
    query: 'SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id',
  )

  responses.each do |response|
    response.results.each do |row|
      puts "Campaign with ID #{row.campaign.id} and name '#{row.campaign.name}' was found."
    end
  end
end
get_campaigns.rb
      

sub get_campaigns {
  my ($api_client, $customer_id) = @_;

  # Create a search Google Ads stream request that will retrieve all campaigns.
  my $search_stream_request =
    Google::Ads::GoogleAds::V25::Services::GoogleAdsService::SearchGoogleAdsStreamRequest
    ->new({
      customerId => $customer_id,
      query      =>
        "SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id"
    });

  # Get the GoogleAdsService.
  my $google_ads_service = $api_client->GoogleAdsService();

  my $search_stream_handler =
    Google::Ads::GoogleAds::Utils::SearchStreamHandler->new({
      service => $google_ads_service,
      request => $search_stream_request
    });

  # Issue a search request and process the stream response to print the requested
  # field values for the campaign in each row.
  $search_stream_handler->process_contents(
    sub {
      my $google_ads_row = shift;
      printf "Campaign with ID %d and name '%s' was found.\n",
        $google_ads_row->{campaign}{id}, $google_ads_row->{campaign}{name};
    });

  return 1;
}
get_campaigns.pl
      

Exemplos de código

Confira nossos exemplos de código de algumas funções comuns na API Google Ads.