Bibliothèque cliente Perl

La bibliothèque cliente Perl est hébergée sur GitHub, et le package est disponible sur CPAN.

La bibliothèque est compatible avec Perl 5.28.1 ou version ultérieure.

Protocole de l'API REST

Les entités de classe (telles que les services, les ressources, les énumérations et les erreurs) de la bibliothèque cliente Perl sont générées en analysant les définitions de tampon de protocole. Pour en savoir plus sur la sérialisation des données structurées, consultez la documentation sur les tampons de protocole.

Pour se connecter à l'API Google Ads, la bibliothèque cliente crée une requête HTTP au format JSON, l'envoie au point de terminaison REST via HTTP 1.1, désérialise la réponse en tant qu'objet JSON et interprète les résultats.

Installer la bibliothèque

La bibliothèque cliente Perl est hébergée sur GitHub et distribuée à l'aide de CPAN.

Installer à partir de CPAN

Installez la distribution Google::Ads::GoogleAds::Client directement à partir de CPAN à l'aide de cpanm (ou cpan) :

cpanm Google::Ads::GoogleAds::Client

Compiler à partir de la source et exécuter des exemples

Pour exécuter les exemples de code groupés ou compiler la bibliothèque à partir de la source :

  1. Clonez la bibliothèque depuis GitHub :

    git clone https://github.com/googleads/google-ads-perl.git

  2. Accédez donc à ce répertoire google-ads-perl :

    cd google-ads-perl

    Vous verrez des fichiers et des sous-répertoires :

    • Build.PL : fichier de compilation Perl, qui contient les dépendances et les types de tests de ce projet.
    • lib : code source de la bibliothèque.
    • t : scénarios de test du code de la bibliothèque.
    • examples : de nombreux exemples illustrant comment utiliser la bibliothèque pour exécuter des cas d'utilisation courants à l'aide de l'API Google Ads.
    • googleads.properties : exemple de fichier de configuration pour la bibliothèque.
    • log4perl.conf : exemple de fichier de configuration de journalisation.

  3. Installez les dépendances requises et compilez la bibliothèque. Le fichier Build.PL liste toutes les dépendances requises pour la bibliothèque. Vous pouvez les installer en exécutant les commandes suivantes :

    cpan install Module::Build
perl Build.PL
./Build installdeps
./Build
./Build install

Effectuer votre premier appel d'API

Pour utiliser l'API Google Ads, vous devez suivre plusieurs étapes afin d'accéder à l'API et de configurer vos comptes Google Ads. Suivez le guide de démarrage rapide, qui vous guide à travers toutes les étapes importantes, y compris la configuration de vos comptes Google Ads.

Utilisation de base

Initialisez Google::Ads::GoogleAds::Client (qui charge par défaut les identifiants depuis ~/googleads.properties ou GOOGLE_ADS_CONFIGURATION_FILE_PATH) et diffusez les lignes de la campagne en flux continu à l'aide de SearchStreamHandler :

use strict;
use warnings;
use Google::Ads::GoogleAds::Client;
use Google::Ads::GoogleAds::Utils::SearchStreamHandler;
use Google::Ads::GoogleAds::V26::Services::GoogleAdsService::SearchGoogleAdsStreamRequest;

my $api_client = Google::Ads::GoogleAds::Client->new();
my $google_ads_service = $api_client->GoogleAdsService();

my $search_stream_request =
  Google::Ads::GoogleAds::V26::Services::GoogleAdsService::SearchGoogleAdsStreamRequest
  ->new({
    customerId => "INSERT_CUSTOMER_ID_HERE",
    query      =>
      "SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id"
  });

my $search_stream_handler =
  Google::Ads::GoogleAds::Utils::SearchStreamHandler->new({
    service => $google_ads_service,
    request => $search_stream_request
  });

$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};
  });

Consultez le guide d'utilisation de base pour en savoir plus sur l'utilisation de la bibliothèque cliente Perl.

Authentification et autorisation

La bibliothèque cliente Perl est compatible avec plusieurs approches d'authentification et d'autorisation. Pour en savoir plus, consultez le guide Authentification et autorisation.

Configuration et journalisation

La bibliothèque cliente Perl utilise googleads.properties pour la configuration et log4perl.conf pour la journalisation. Vous pouvez modifier ces fichiers pour personnaliser le comportement de la bibliothèque. Pour en savoir plus, consultez les guides Configuration et Journalisation.

Utilitaires

La bibliothèque cliente Perl inclut des classes d'utilitaires pour améliorer l'utilisation de l'API. Pour en savoir plus, consultez les guides suivants :

Affiner les performances de votre application

Consultez le guide des performances pour obtenir des recommandations sur la façon d'ajuster les performances de votre application.