Penggunaan dasar

Panduan ini menjelaskan dasar-dasar penggunaan library klien Perl untuk Google Ads API.

Lakukan inisialisasi klien

Untuk mulai menggunakan library, buat instance Google::Ads::GoogleAds::Client. Klien dapat dikonfigurasi dengan beberapa cara, seperti yang dijelaskan dalam Panduan konfigurasi. Pendekatan umum adalah dengan menggunakan file googleads.properties:

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

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

Membuat service

Setelah klien diinisialisasi, Anda dapat membuat instance berbagai layanan API. Misalnya, untuk berinteraksi dengan kampanye, Anda akan membuat instance CampaignService:

use strict;
use warnings;

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

Secara default, $api_client memuat layanan untuk DEFAULT_API_VERSION dari rilis library yang diinstal (V25 dalam rilis terbaru; rilis minor seperti v25.1 menggunakan modul versi utamanya, V25). Untuk menargetkan versi API tertentu yang didukung, teruskan version => "V25" ke Client->new({...}) atau panggil $api_client->set_version("V25").

Melakukan panggilan API

Berikut adalah contoh cara melakukan panggilan API untuk mendapatkan kampanye. Cuplikan ini menunjukkan cara menginisialisasi klien, membuat layanan, dan memanggil metode.

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};
}

Menangani error

Panggilan API dapat menyebabkan error. Secara default, die_on_faults adalah 0 (false), yang menyebabkan metode layanan memunculkan peringatan dan menampilkan objek Google::Ads::GoogleAds::GoogleAdsException saat terjadi error API. Anda dapat memeriksa apakah respons yang ditampilkan adalah GoogleAdsException dan memanggil get_google_ads_failure() untuk memeriksa entri GoogleAdsError satu per satu.

Atau, jika Anda menetapkan die_on_faults => 1 pada Client->new({...}) (atau memanggil $api_client->set_die_on_faults(1)), metode layanan akan memanggil die() dengan respons error JSON mentah saat terjadi kesalahan API, yang dapat Anda tangkap dalam blok 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};
  }
}

Mempelajari contoh lainnya

Anda dapat menemukan beberapa contoh kode yang berguna di direktori examples. Sebagian besar contoh memerlukan parameter. Anda dapat meneruskan parameter sebagai argumen (direkomendasikan) atau mengedit nilai INSERT_XXXXX_HERE dalam kode sumber. Untuk melihat pernyataan penggunaan contoh, teruskan -help sebagai argumen command line.

perl examples/basic_operations/get_campaigns.pl -help