Podstawowe użycie

Z tego przewodnika dowiesz się, jak korzystać z biblioteki klienta Perl do interfejsu Google Ads API.

Inicjowanie klienta

Aby zacząć korzystać z biblioteki, utwórz instancję Google::Ads::GoogleAds::Client. Klienta można skonfigurować na kilka sposobów, zgodnie z opisem w przewodniku po konfiguracji. Często stosowanym rozwiązaniem jest użycie pliku googleads.properties:

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

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

Utwórz usługę

Po zainicjowaniu klienta możesz utworzyć instancje różnych usług API. Aby na przykład wchodzić w interakcje z kampaniami, utwórz instancję CampaignService:

use strict;
use warnings;

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

Domyślnie $api_client wczytuje usługi dla DEFAULT_API_VERSION zainstalowanej wersji biblioteki (V25 w najnowszej wersji; wersje podrzędne, takie jak v25.1, używają modułu wersji głównej, V25). Aby kierować reklamy na konkretną obsługiwaną wersję interfejsu API, przekaż version => "V25" do Client->new({...}) lub wywołaj $api_client->set_version("V25").

Wywoływanie interfejsu API

Oto przykład wywołania interfejsu API w celu uzyskania kampanii. Ten fragment kodu pokazuje, jak zainicjować klienta, utworzyć usługę i wywołać metodę.

use strict;
use warnings;
use Google::Ads::GoogleAds::Client;
use Google::Ads::GoogleAds::V25::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::V25::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};
}

Obsługuj błędy

Wywołania interfejsu API mogą powodować błędy. Domyślnie wartość die_on_faults to 0 (false), co powoduje, że metody usługi emitują ostrzeżenie i zwracają obiekt Google::Ads::GoogleAds::GoogleAdsException, gdy wystąpi błąd interfejsu API. Możesz sprawdzić, czy zwrócona odpowiedź jest GoogleAdsException, i wywołać get_google_ads_failure(), aby sprawdzić poszczególne wpisy GoogleAdsError.

Jeśli ustawisz die_on_faults => 1 na Client->new({...}) (lub wywołasz $api_client->set_die_on_faults(1)), metody usługi wywołają die() z nieprzetworzoną odpowiedzią JSON o błędzie, gdy wystąpi błąd interfejsu API. Możesz go przechwycić w bloku eval (if ($@)).

use strict;
use warnings;
use Scalar::Util qw(blessed);
use Google::Ads::GoogleAds::Client;
use Google::Ads::GoogleAds::V25::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::V25::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};
  }
}

Zobacz inne przykłady

W katalogu examples znajdziesz kilka przydatnych przykładów kodu. Większość przykładów wymaga parametrów. Parametry możesz przekazywać jako argumenty (zalecane) lub edytować wartości INSERT_XXXXX_HERE w kodzie źródłowym. Aby wyświetlić instrukcję użycia przykładu, przekaż -help jako argument wiersza poleceń.

perl examples/basic_operations/get_campaigns.pl -help