Nos bibliothèques clientes fournissent des vues de haut niveau et des blocs de construction de base des fonctionnalités de l'API Google Ads, ce qui facilite le développement rapide d'applications. Si vous débutez avec l'API, nous vous recommandons de commencer par un seul.
Bibliothèque cliente | Source | Distribution | Exemples de code |
---|---|---|---|
Java | google-ads-java | Maven, tar.gz | Afficher sur GitHub |
.NET | google-ads-dotnet | nuget, tar.gz, zip | Afficher sur GitHub |
PHP | google-ads-php | tar.gz | Afficher sur GitHub |
Python | google-ads-python | tar.gz, zip | Afficher sur GitHub |
Ruby | google-ads-ruby | gem, tar.gz, zip | Afficher sur GitHub |
Perl | google-ads-perl | tar.gz, zip | Afficher sur GitHub |
Bibliothèques de la communauté
Nous connaissons plusieurs bibliothèques gérées par la communauté Open Source. Nous tenons à jour cette liste pour aider les développeurs intéressés à les trouver. Nous ne testons pas ces bibliothèques, n'y contribuons pas et ne les gérons pas. Utilisez-les à vos risques et périls. Toute question doit être adressée aux propriétaires des projets Open Source.
Si vous connaissez une bibliothèque que nous avons oubliée, cliquez sur Envoyer des commentaires en haut de la page pour nous en informer.
Versions d'API compatibles
Le tableau indique les bibliothèques clientes compatibles avec les différentes versions de l'API.
Java
API Google Ads |
Bibliothèque cliente pour Java |
v20 |
Min: 38.0.0 Max: - |
v19 |
Min: 36.0.0 Max: - |
v18 |
Min: 34.0.0 Max: - |
v17 |
Min: 31.0.0 Max: 36.1.0 |
C#
API Google Ads |
Bibliothèque cliente pour .NET |
v20 |
Min: 23.0.0 Max: - |
v19 |
Min: 22.1.0 Max: - |
v18 |
Min: 21.1.0 Max: - |
v17 |
Min: 20.1.0 Max: 22.2.0 |
PHP
API Google Ads |
Bibliothèque cliente pour PHP |
v20 |
Min: 28.0.0 Max: - |
v19 |
Min: 26.1.0 Max: - |
v18 |
Min: 25.0.0 Max: - |
v17 |
Min: 23.1.0 Max: 27.2.0
|
Python
API Google Ads |
Bibliothèque cliente pour Python |
v20 |
Min: 27.0.0 Max: - |
v19 |
Min: 25.2.0 Max: - |
v18 |
Min: 25.1.0 Max: - |
v17 |
Min: 24.1.0 Max: 26.1.0 |
Ruby
API Google Ads |
Bibliothèque cliente pour Ruby |
v20 |
Min: 34.0.0 Max: - |
v19 |
Min: 32.0.0 Max: - |
v18 |
Min: 31.0.0 Max: - |
Perl
API Google Ads |
Bibliothèque cliente pour Perl |
v20 |
Min: 27.0.0 Max: - |
v19 |
Min: 26.0.0 Max: - |
v18 |
Min: 25.0.1 Max: - |
Configuration
Chaque bibliothèque cliente de l'API Ads fournit différents paramètres de configuration et méthodes de chargement que vous pouvez utiliser pour personnaliser son comportement.
Voici les variables d'environnement qui sont communes à toutes les bibliothèques clientes et qui peuvent être chargées pour définir les paramètres de configuration :
- Bibliothèque cliente
GOOGLE_ADS_CONFIGURATION_FILE_PATH
: chemin d'accès au fichier de configuration.
- OAuth2
- Mode Application
GOOGLE_ADS_CLIENT_ID
: définissez cette valeur sur votre ID client OAuth2.GOOGLE_ADS_CLIENT_SECRET
: définissez cette valeur sur le code secret de votre client OAuth2.GOOGLE_ADS_REFRESH_TOKEN
: définissez cette valeur sur un jeton d'actualisation OAuth2 pré-généré si vous souhaitez réutiliser des jetons OAuth2. Ce paramètre est facultatif.
- Mode Compte de service
GOOGLE_ADS_JSON_KEY_FILE_PATH
: définissez cette valeur sur le chemin d'accès au fichier de configuration JSON OAuth2.GOOGLE_ADS_IMPERSONATED_EMAIL
: définissez cette valeur sur l'adresse e-mail du compte dont vous empruntez l'identité.
- Mode Application
- API Google Ads
GOOGLE_ADS_DEVELOPER_TOKEN
: définissez cette valeur sur votre jeton de développeur.GOOGLE_ADS_LOGIN_CUSTOMER_ID
: il s'agit de l'ID client du client autorisé à utiliser dans la requête, sans tirets (-
).GOOGLE_ADS_LINKED_CUSTOMER_ID
: cet en-tête n'est requis que pour les méthodes qui mettent à jour les ressources d'une entité lorsque l'autorisation est accordée via les comptes associés dans l'UI Google Ads (ressourceAccountLink
dans l'API Google Ads). Définissez cette valeur sur l'ID client du fournisseur de données qui met à jour les ressources de l'ID client spécifié. Il doit être défini sans tirets (-
). Pour en savoir plus sur les comptes associés, consultez le Centre d'aide.
Les variables d'environnement sont généralement définies dans un fichier de configuration bash tel qu'un fichier .bashrc
ou .bash_profile
situé dans le répertoire $HOME
. Ils peuvent également être définis à l'aide de la ligne de commande.
Voici quelques étapes de base pour définir une variable d'environnement à l'aide d'un fichier .bashrc
dans un 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
Vous pouvez également définir des variables d'environnement dans votre instance de terminal directement depuis la ligne de commande :
export GOOGLE_ADS_CLIENT_ID=1234567890
Vous pouvez également définir des variables d'environnement lorsque vous appelez la commande qui les utilise :
GOOGLE_ADS_CLIENT_ID=1234567890 php /path/to/script/that/uses/envvar.php
Extraire les entités
GoogleAdsService.SearchStream
est généralement utilisé pour extraire des entités, et les résultats sont renvoyés sous forme de flux de lignes. Vous pouvez également utiliser GoogleAdsService.Search
pour récupérer des entités avec une connexion Internet peu fiable. GoogleAdsService.Search
renvoie les résultats sous forme de pages de taille fixe (10 000 lignes par page).
Notre bibliothèque cliente implémente automatiquement la pagination lorsque vous parcourez les résultats. Vous pouvez ainsi les télécharger et les traiter tous en même temps.
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.V20.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::V20::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; }
Exemples de code
Consultez nos exemples de code pour découvrir quelques fonctions courantes de l'API Google Ads.