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 Ads 帳戶。請按照快速入門指南操作，逐步完成所有重要步驟，包括設定 Google Ads 帳戶。

基本用法

初始化 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 可用性。請參閱下列指南，瞭解更多資訊：

• 欄位遮罩
• 資源名稱

微調應用程式效能

請參閱效能指南，瞭解如何微調應用程式效能。