Nossas bibliotecas de cliente oferecem visualizações de alto nível e blocos básicos de construção da funcionalidade da API Google Ads, facilitando o desenvolvimento rápido de apps. Recomendamos começar com um se você for iniciante 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 |
Bibliotecas comunitárias
Sabemos de 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 ou mantemos essas bibliotecas. Use-as por sua conta e risco. Em caso de dúvidas, entre em contato com os proprietários dos projetos de código aberto.
Se você souber de uma biblioteca que não foi incluída, clique em Enviar feedback na parte de cima da página e nos informe.
Versões da API com suporte
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 |
Min: 30.0.0 Max: - |
C#
API Google Ads |
Biblioteca de cliente para .NET |
v18 |
Min: 21.1.0 Max: - |
v17 |
Min: 20.1.0 Max: - |
v16 |
Min: 18.1.0 Max: - |
PHP
API Google Ads |
Biblioteca de cliente para PHP |
v18 |
Min: 25.0.0 Max: - |
v17 |
Min: 23.1.0 Max: - |
v16 |
Min: 22.1.0 Max: - |
Python
API Google Ads |
Biblioteca de cliente para Python |
v18 |
Min: 25.1.0 Max: - |
v17 |
Min: 24.1.0 Max: - |
v16 |
Min: 23.1.0 Max: - |
Ruby
API Google Ads |
Biblioteca de cliente para Ruby |
v18 |
Min: 31.0.0 Max: - |
v17 |
Min: 29.0.0 Max: - |
v16 |
Min: 27.0.0 Max: - |
Perl
API Google Ads |
Biblioteca de cliente para Perl |
v18 |
Min: 25.0.1 Max: - |
v17 |
Min: 23.0.0 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.
Confira as variáveis de ambiente que são comuns a todas as bibliotecas de cliente e que podem ser carregadas para definir as configurações:
- Biblioteca de cliente
GOOGLE_ADS_CONFIGURATION_FILE_PATH
: caminho para o arquivo de configuração.
- 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 a chave secreta do cliente OAuth2.GOOGLE_ADS_REFRESH_TOKEN
: defina esse valor como um token de atualização OAuth2 pré-gerado se você 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 configuração JSON do OAuth2.GOOGLE_ADS_IMPERSONATED_EMAIL
: defina esse valor como o endereço de e-mail da conta que você está personificando.
- Modo de aplicativo
- API Google Ads
GOOGLE_ADS_DEVELOPER_TOKEN
: defina como o token do desenvolvedor.GOOGLE_ADS_LOGIN_CUSTOMER_ID
: é o ID do cliente autorizado a ser usado na solicitação, sem hifen (-
).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 (recursoAccountLink
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 as contas vinculadas, acesse a Central de Ajuda.
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.
Confira algumas etapas básicas para definir uma variável de ambiente usando um arquivo .bashrc
com 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
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
é normalmente usado 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.
Nossa biblioteca de cliente implementa a paginação automaticamente quando você itera os resultados para que possa fazer o download e o processamento sequenciais de todos eles de uma só 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()); } } } }
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; } }
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 ); } }
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.' )
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
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; }
Exemplos de código
Confira nossos exemplos de código de algumas funções comuns na API Google Ads.