Perl 客户端库

Perl 客户端库托管在 GitHub 上，软件包可在 CPAN 上获取。

该库支持 Perl 5.28.1 或更高版本。

REST API 协议

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

从源代码构建并运行示例

如需运行捆绑的代码示例或从源代码构建库，请执行以下操作：

  1. 从 GitHub 克隆库：

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

  2. 切换到 google-ads-perl 目录：

    cd google-ads-perl

    您会看到一些文件和子目录：

    • Build.PL：Perl build 文件，其中包含此项目的依赖项和测试类型。
    • 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 易用性的实用程序类。请参阅以下指南了解详情：

微调应用性能

如需了解如何微调应用性能，请参阅性能指南。