Perl クライアント ライブラリ

Perl クライアント ライブラリは GitHub でホストされており、パッケージは CPAN で入手できます。

このライブラリは、Perl バージョン 5.28.1 以降をサポートしています。

REST API プロトコル

注: Google Ads API は、標準の JSON REST エンドポイントと、高パフォーマンスの gRPC インターフェースの両方を公開しています。Perl は gRPC スタックでサポートされている言語ではないため、このクライアント ライブラリは HTTP 1.1 経由の JSON REST プロトコルに実装されています。

Perl クライアント ライブラリのクラス エンティティ（サービス、リソース、列挙型、エラーなど）は、プロトコル バッファ定義を解析して生成されます。構造化データのシリアル化方法の詳細については、プロトコル バッファのドキュメントをご覧ください。

Google Ads API に接続するために、クライアント ライブラリは JSON で HTTP リクエストを作成し、HTTP 1.1 経由で REST エンドポイントに送信します。レスポンスを JSON オブジェクトとしてデシリアライズし、結果を解釈します。

ライブラリをインストールする

Perl クライアント ライブラリは GitHub でホストされ、CPAN を使用して配布されます。

CPAN からインストールする

cpanm（または cpan）を使用して、CPAN から Google::Ads::GoogleAds::Client ディストリビューションを直接インストールします。

cpanm Google::Ads::GoogleAds::Client

注: 各 Google::Ads::GoogleAds::Client リリースには、lib/Google/Ads/GoogleAds/ の下に特定の Google Ads API バージョン モジュールがバンドルされています（v25.1 などのマイナー API リリースは、メジャー バージョン モジュール V25 の下に含まれています）。バージョンの互換性については、サポートされている API バージョンの表をご覧ください。

ソースからビルドしてサンプルを実行する

バンドルされたコードサンプルを実行する場合、またはソースからライブラリをビルドする場合は、次の手順を行います。

1. GitHub からライブラリのクローンを作成します。

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

2. google-ads-perl ディレクトリに移動します。

   cd google-ads-perl
   

   いくつかのファイルとサブディレクトリが表示されます。

   • Build.PL: Perl ビルドファイル。このプロジェクトの依存関係とテストタイプを保持します。
   • lib: ライブラリのソースコード。
   • t: ライブラリ コードのテストケース。
   • examples: Google Ads API を使用して一般的なユースケースを実行する方法を示す多くの例。
   • googleads.properties: ライブラリのサンプル構成ファイル。
   • log4perl.conf: サンプル ロギング構成ファイル。

3. 必要な依存関係をインストールし、ライブラリをビルドします。Build.PL ファイルには、ライブラリに必要なすべての依存関係がリストされています。これらをインストールするには、次のコマンドを実行します。

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

最初の API 呼び出しを実行する

Google Ads API を使用するには、いくつかの手順に沿って API へのアクセス権を取得し、Google 広告アカウントを設定する必要があります。クイック スタート ガイドに沿って、Google 広告アカウントの設定など、重要な手順をすべて行います。

基本的な使用方法

Google::Ads::GoogleAds::Client を初期化し（デフォルトでは ~/googleads.properties または GOOGLE_ADS_CONFIGURATION_FILE_PATH から認証情報を読み込みます）、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};
  });

Perl クライアント ライブラリの使用方法について詳しくは、基本的な使用方法のガイドをご覧ください。

認証と認可

Perl クライアント ライブラリは、認証と認可の複数のアプローチをサポートしています。詳細については、認証と認可のガイドをご覧ください。

構成とロギング

Perl クライアント ライブラリは、構成に googleads.properties を、ロギングに log4perl.conf を使用します。これらのファイルを変更して、ライブラリの動作をカスタマイズできます。詳細については、構成ガイドとロギングガイドをご覧ください。

ユーティリティ

Perl クライアント ライブラリには、API の使いやすさを向上させるユーティリティ クラスが含まれています。詳細については、次のガイドをご覧ください。

• フィールド マスク
• リソース名

アプリケーションのパフォーマンスを微調整する

アプリケーションのパフォーマンスを微調整する方法については、パフォーマンス ガイドをご覧ください。