Как пользоваться отчетом

В этом руководстве рассказывается, как использовать клиентскую библиотеку Perl для Google Ads API.

Инициализируйте клиент

Чтобы начать работу с библиотекой, создайте экземпляр Google::Ads::GoogleAds::Client. Клиент можно настроить несколькими способами, как описано в руководстве по настройке. Обычно для этого используется файл googleads.properties:

use strict;
use warnings;
use Google::Ads::GoogleAds::Client;

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

Создание сервиса

После инициализации клиента вы можете создавать экземпляры различных сервисов API. Например, для взаимодействия с кампаниями нужно создать экземпляр CampaignService:

use strict;
use warnings;

my $campaign_service = $api_client->CampaignService();

По умолчанию $api_client загружает сервисы для DEFAULT_API_VERSION установленной версии библиотеки (V26 в последней версии; в минорных версиях, например v25.1, используется модуль основной версии V25). Чтобы указать определенную поддерживаемую версию API, передайте version => "V26" в Client->new({...}) или вызовите $api_client->set_version("V26").

Выполнение вызова API

Ниже приведен пример вызова API для получения кампаний. В этом фрагменте показано, как инициализировать клиент, создать сервис и вызвать метод.

use strict;
use warnings;
use Google::Ads::GoogleAds::Client;
use Google::Ads::GoogleAds::V26::Services::GoogleAdsService::SearchGoogleAdsRequest;

# Initialize the Google Ads client. See the Configuration guide for options.
my $api_client = Google::Ads::GoogleAds::Client->new();

# Get the GoogleAdsService.
my $google_ads_service = $api_client->GoogleAdsService();

# Specify the customer ID and query.
my $customer_id = "INSERT_CUSTOMER_ID_HERE";
my $query = "SELECT campaign.name, campaign.status FROM campaign";

# Create a search request.
my $search_request =
  Google::Ads::GoogleAds::V26::Services::GoogleAdsService::SearchGoogleAdsRequest
  ->new({
    customerId => $customer_id,
    query      => $query,
  });

# Execute the search request.
my $search_response = $google_ads_service->search($search_request);

# Iterate over the results and print campaign names.
foreach my $google_ads_row (@{$search_response->{results} || []}) {
  printf "Campaign with resource name '%s' and name '%s'.\n",
    $google_ads_row->{campaign}->{resourceName},
    $google_ads_row->{campaign}->{name};
}

Обработка ошибок

Вызовы API могут приводить к ошибкам. По умолчанию для параметра die_on_faults задано значение 0 (false), поэтому при возникновении ошибки API методы сервиса выдают предупреждение и возвращают объект Google::Ads::GoogleAds::GoogleAdsException. Вы можете проверить, является ли возвращенный ответ объектом GoogleAdsException, и вызвать метод get_google_ads_failure(), чтобы проверить отдельные записи GoogleAdsError.

Если вы зададите die_on_faults => 1 в Client->new({...}) (или вызовете $api_client->set_die_on_faults(1)), то при возникновении ошибки API методы сервиса вызовут die() с необработанным ответом об ошибке JSON, который можно перехватить в блоке eval (if ($@)).

use strict;
use warnings;
use Scalar::Util qw(blessed);
use Google::Ads::GoogleAds::Client;
use Google::Ads::GoogleAds::V26::Services::GoogleAdsService::SearchGoogleAdsRequest;

my $api_client = Google::Ads::GoogleAds::Client->new();
my $google_ads_service = $api_client->GoogleAdsService();
my $customer_id = "INSERT_CUSTOMER_ID_HERE";
my $query = "SELECT campaign.name, campaign.status FROM campaign";
my $search_request =
  Google::Ads::GoogleAds::V26::Services::GoogleAdsService::SearchGoogleAdsRequest
  ->new({
    customerId => $customer_id,
    query      => $query,
  });

my $search_response = $google_ads_service->search($search_request);

if (blessed($search_response)
  && $search_response->isa("Google::Ads::GoogleAds::GoogleAdsException"))
{
  printf "An API exception occurred (HTTP %s, status '%s'): %s\n",
    $search_response->get_code(),
    $search_response->get_status(),
    $search_response->get_message();

  my $google_ads_failure = $search_response->get_google_ads_failure();
  if ($google_ads_failure) {
    foreach my $error (@{$google_ads_failure->{errors} || []}) {
      my ($error_type, $error_value) = %{$error->{errorCode} || {}};
      printf "  Error code (%s): %s\n",
        $error_type  || "unknown",
        $error_value || "UNKNOWN";
      printf "  Message: %s\n", $error->{message};
    }
  }
} else {
  foreach my $google_ads_row (@{$search_response->{results} || []}) {
    printf "Campaign name: %s\n", $google_ads_row->{campaign}->{name};
  }
}

Другие примеры

В каталоге примеров вы найдете несколько полезных примеров кода. Для большинства примеров требуются параметры. Вы можете передать параметры в качестве аргументов (рекомендуется) или изменить значения INSERT_XXXXX_HERE в исходном коде. Чтобы посмотреть пример инструкции по использованию, передайте -help в качестве аргумента командной строки.

perl examples/basic_operations/get_campaigns.pl -help