Клиентская библиотека Perl

Клиентская библиотека Perl размещена на GitHub, а пакет доступен в CPAN.

Библиотека поддерживает Perl версии 5.28.1 и выше.

Протокол REST API

Объекты классов, такие как сервис, ресурс, перечисление и ошибка, в клиентской библиотеке Perl генерируются путем синтаксического анализа определений буфера протокола. Подробнее о том, как сериализуются структурированные данные, рассказывается в документации по буферам протокола.

Чтобы подключиться к Google Ads API, клиентская библиотека создает HTTP-запрос в формате JSON, отправляет его конечной точке REST по протоколу HTTP 1.1, десериализует ответ как объект JSON и интерпретирует результаты.

Установка библиотеки

Клиентская библиотека Perl размещена на GitHub и распространяется через CPAN.

Установка из CPAN

Установите дистрибутив Google::Ads::GoogleAds::Client непосредственно из CPAN с помощью cpanm (или cpan):

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, в котором содержатся зависимости и типы тестов этого проекта.
    • 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. Дополнительную информацию можно найти в следующих руководствах:

Тонкая настройка производительности приложения

Рекомендации по настройке производительности приложения приведены в руководстве по производительности.