Bibliotecas de clientes

As bibliotecas de cliente da API Google Ads oferecem visualizaçõ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 tiver experiência com a API.

Biblioteca de cliente	Origem	Distribuição	Exemplos de código
Java	google-ads-java	Maven, tar.gz, zip	Ver no GitHub
.NET	google-ads-dotnet	NuGet, tar.gz, zip	Ver no GitHub
PHP	google-ads-php	Composer, tar.gz, zip	Ver no GitHub
Python	google-ads-python	PyPI, tar.gz, zip	Ver no GitHub
Ruby	google-ads-ruby	RubyGems, tar.gz, zip	Ver no GitHub
Perl	google-ads-perl	CPAN, tar.gz, zip	Ver no GitHub

Bibliotecas comunitárias

Conhecemos várias bibliotecas mantidas pela comunidade de código aberto. Mantemos essa lista para ajudar os desenvolvedores interessados a encontrá-las. Não testamos, contribuímos nem mantemos essas bibliotecas. Use-as por sua conta e risco. Quaisquer dúvidas devem ser direcionadas aos proprietários dos projetos de código aberto.

Se você conhece uma biblioteca que não está na lista, 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 versão principal da API Google Ads (como a v26). Para conferir a versão necessária da biblioteca de cliente para versões secundárias, consulte o registro de alterações vinculado.

Java

Registro de alterações

API Google Ads	Biblioteca de cliente para Java
v26	Min: 48.0.0 Max: -
v25	Min: 44.0.0 Max: -
v24	Min: 43.0.0 Max: -
v23	Min: 42.0.0 Max: -

C#

Registro de alterações

API Google Ads	Biblioteca de cliente para .NET
v26	Min: 27.5.0 Max: -
v25	Min: 26.1.0 Max: -
v24	Min: 25.3.0 Max: -
v23	Min: 25.1.0 Max: -

PHP

Registro de alterações

API Google Ads	Biblioteca de cliente para PHP
v26	Min: 35.2.0 Max: -
v25	Min: 33.6.0 Max: -
v24	Min: 33.3.0 Max: -
v23	Min: 32.2.0 Max: -

Python

Registro de alterações

API Google Ads	Biblioteca de cliente para Python
v26	Min: 34.0.0 Max: -
v25	Min: 31.2.0 Max: -
v24	Min: 30.1.0 Max: -
v23	Min: 29.2.0 Max: -

Ruby

Registro de alterações

API Google Ads	Biblioteca de cliente para Ruby
v26	Min: 46.0.0 Max: -
v25	Min: 43.0.0 Max: -
v24	Min: 40.0.0 Max: -
v23	Min: 38.0.0 Max: -

Perl

Registro de alterações

API Google Ads	Biblioteca de cliente para Perl
v26	Min: 36.0.0 Max: -
v25	Min: 33.0.0 Max: -
v24	Min: 32.0.0 Max: -
v23	Min: 31.0.0 Max: -

Configuração

Cada biblioteca de cliente da API Google Ads oferece configurações e métodos de carregamento diferentes 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); no .NET, carregue essa variável explicitamente usando config.TryLoadFromEnvironmentFilePath ou carregue arquivos de configuração usando LoadFromSettingsJson, LoadFromConfigurationSection, ou LoadFromConfigurationRoot).
• OAuth2
  • Modo de aplicativo
    • GOOGLE_ADS_CLIENT_ID: defina esse valor como o ID do cliente OAuth2.
    • GOOGLE_ADS_CLIENT_SECRET: defina esse valor como o segredo do cliente OAuth2.
    • GOOGLE_ADS_REFRESH_TOKEN: defina esse valor como um token de atualização OAuth2 pré-gerado se quiser reutilizar tokens 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 (no .NET, também defina 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, também defina [OAUTH2] scopes em google_ads_php.ini ou chame withScopes(), já que fromEnvironmentVariables() não lê escopos 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 fazer a autenticação 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 ou define UseApplicationDefaultCredentials = true em GoogleAdsConfig; no PHP, OAuth2TokenBuilder volta automaticamente para o ADC quando nenhuma credencial OAuth2 explícita é definida; o Perl não oferece suporte ao ADC).
• API Google Ads
  • GOOGLE_ADS_LOGIN_CUSTOMER_ID: Este é o ID de cliente autorizado a ser usado na solicitação, sem hifens (-).
  • GOOGLE_ADS_LINKED_CUSTOMER_ID: esse cabeçalho só é necessário para métodos que atualizam os recursos de uma entidade quando a permissão é concedida por meio de contas vinculadas na interface do Google Ads (recurso AccountLink na API Google Ads). Defina esse valor como o ID de cliente do provedor de dados que atualiza os recursos do ID de cliente especificado. Ele precisa ser definido sem hifens (-). Para saber mais sobre contas vinculadas, acesse a Central de Ajuda.

Observação: Para mais detalhes sobre como usá-las e outras variáveis de ambiente específicas da biblioteca de cliente, consulte os guias de configuração dedicados a cada biblioteca de cliente: Java, .NET, PHP, Python, Ruby, Perl.

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. Elas também podem ser definidas usando a linha de comando.

Observação: estas instruções pressupõem que você esteja usando o Bash. Se você estiver usando um shell diferente, consulte a documentação para comandos equivalentes.

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 geralmente é usado para buscar entidades, e os resultados são retornados como um fluxo de linhas. Como alternativa, você pode usar 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 tudo de uma vez.

Java

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
      

C#

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
      

PHP

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
      

Python

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
      

Ruby

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
      

Perl

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
      

curl

Observação:embora um exemplo de código REST direto para esta etapa não seja fornecido aqui, é possível fazer isso usando uma solicitação REST manual.

Consulte a documentação da interface REST da API Google Ads e as páginas de referência específicas do método. Você precisará criar o payload JSON com base nas definições do proto.

Recursos principais:

• Usar REST
• Estrutura da interface REST
• Mapeamentos de campo JSON
• Consulte a referência da API REST para o serviço e o método específicos.

Exemplos de código

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