Bibliotecas de cliente

Nossas bibliotecas cliente fornecem visualizações de alto nível e elementos básicos de funcionalidade da API Google Ads, facilitando o desenvolvimento rápido de aplicativos. Recomendamos e comece com um, se você ainda não tem muita experiência na API.

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

Versões da API compatíveis

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

Java

API Google Ads	Biblioteca de cliente para Java
v18	Min: 34.0.0 Max: -
v17	Min: 32.0.0 Max: -
v16	30.0.0 Min: Max: –

C#

API Google Ads	Biblioteca de cliente para .NET
v18	21.1.0 Min: Max: –
v17	20.1.0 Min: Max: –
v16	18.1.0 Min: Max: –

PHP

API Google Ads	Biblioteca de cliente para PHP
v18	25.0.0 Min: Max: –
v17	23.1.0 Min: Max: –
v16	Min: 22.1.0 Max: -

Python

API Google Ads	Biblioteca de cliente para Python
v18	25.1.0 Min: Max: –
v17	Min: 24.1.0 Max: -
v16	Min: 23.1.0 Max: -

Ruby

API Google Ads	Biblioteca de cliente para Ruby
v18	31.0.0 Min: Max: –
v17	Min: 29.0.0 Max: -
v16	27.0.0 Min: Max: –

Perl

API Google Ads	Biblioteca de cliente para Perl
v18	Min: 25.0.0 Max: -
v17	23.0.0 Min: Max: –
v16	Min: 21.0.0 Max: -

Configuração

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

Aqui estão as variáveis de ambiente que são comuns a todas as bibliotecas de cliente e que pode ser carregado para definir as configurações:

• Biblioteca de cliente
  • GOOGLE_ADS_CONFIGURATION_FILE_PATH: caminho para o arquivo de configuração.
• OAuth2
  • Modo do aplicativo
    • GOOGLE_ADS_CLIENT_ID: defina esse valor como o ID do cliente OAuth2.
    • GOOGLE_ADS_CLIENT_SECRET : defina esse valor como a chave secreta do cliente do OAuth2.
    • GOOGLE_ADS_REFRESH_TOKEN : defina esse valor como um token de atualização do 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 a configuração JSON do OAuth2 caminho do arquivo.
    • GOOGLE_ADS_IMPERSONATED_EMAIL: defina esse valor como o endereço de e-mail da conta que você está personificando.
• API Google Ads
  • GOOGLE_ADS_DEVELOPER_TOKEN: defina como o token do desenvolvedor.
  • GOOGLE_ADS_LOGIN_CUSTOMER_ID : este é o ID do cliente autorizado a usar na solicitação, sem hifens (-).
  • GOOGLE_ADS_LINKED_CUSTOMER_ID: esse cabeçalho é necessário apenas para métodos que atualizam os recursos de uma entidade quando autorizados por 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 hifen (-). Para saber mais sobre as 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 geralmente 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.

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 conferir os 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.
src ~/.bashrc

Variáveis de ambiente também podem ser definidas na instância do terminal diretamente do a 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

Paginação da pesquisa

GoogleAdsService.Search geralmente é usado em apps interativos que mostram páginas de resultados. O tamanho da página é fixado em 10.000 resultados por página.

Nossa biblioteca cliente implementa automaticamente Paging quando você iterar os resultados para poder em sequência, fazer o download e processar todos de uma só vez, por exemplo:

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.V18.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, customer_id):
    ga_service = client.get_service("GoogleAdsService")

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

    # Issues a search request using streaming.
    stream = ga_service.search_stream(customer_id=customer_id, query=query)

    for batch in stream:
        for row in batch.results:
            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::V18::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.