Utilisation de base

Voici comment utiliser la bibliothèque cliente :

Installation

Nous vous recommandons d'installer la bibliothèque à l'aide de Bundler. Ajoutez une ligne à votre fichier Gemfile (en remplaçant x.y.z par le numéro de version que vous souhaitez utiliser) :

gem 'google-ads-googleads', '~> x.y.z'

Exécutez ensuite la commande ci-dessous :

bundle install

Cette commande utilise Bundler pour mettre à jour votre fichier Gemfile.lock, en le verrouillant sur la version exacte du gem et de toutes les dépendances du gem qui ont été installées. L'opérateur de version pessimiste "~> x.y.z" garantit que bundle install ou bundle update n'installe que les nouvelles versions de correctif de la série x.y.*. Vous devez donc activer manuellement les nouvelles versions mineures ou majeures en mettant à jour votre Gemfile.

Autres options d'installation

Si vous n'utilisez pas Bundler, vous pouvez utiliser l'une des options suivantes :

  1. Installez cette bibliothèque à l'aide de RubyGems :

    gem install google-ads-googleads
    
  2. Téléchargez le gem depuis la page des versions et installez-le à partir du fichier local :

    gem install google-ads-googleads-[version].gem
    

Configurer l'authentification

Pour authentifier vos appels d'API, configurez votre fichier google_ads_config.rb et suivez les instructions de la page Authentification et autorisation.

Utilisation

À partir de la version 41.1.0 de google-ads-googleads, le gem est compatible avec l'autorequire de Bundler (Bundler.require). Dans les versions antérieures à la version 41.1.0 (ou lorsque vous n'utilisez pas Bundler.require), exigez explicitement le gem dans votre code :

require 'google/ads/google_ads'

Initialisez le client (qui charge la configuration depuis ~/google_ads_config.rb par défaut) et récupérez un service spécifique, tel que CampaignService :

# Initialize the client using ~/google_ads_config.rb.
client = Google::Ads::GoogleAds::GoogleAdsClient.new

# Fetch the CampaignService client.
campaign_service = client.service.campaign

Consultez les exemples sur GitHub pour obtenir des démonstrations plus détaillées de l'utilisation de la bibliothèque.

Une fois que vous vous serez familiarisé avec les exemples, explorez les fabriques, qui fournissent un ensemble de méthodes pratiques de haut niveau pour utiliser l'API Google Ads.

Gestion des exceptions

Tous les appels d'API ne réussissent pas. Le serveur génère des exceptions si vos appels d'API échouent. Il est important de capturer les erreurs d'API et de les gérer de manière appropriée.

Une instance Google::Ads::GoogleAds::Errors::GoogleAdsError est générée lorsqu'une erreur d'API se produit. Il contient des détails pour vous aider à déterminer ce qui s'est mal passé, et vous pouvez configurer une fonction d'assistance pour gérer les erreurs. Consultez un exemple de gestionnaire d'erreurs sur GitHub.