پیکربندی

کتابخانه Ads API Client چندین تنظیمات پیکربندی ارائه می‌دهد که می‌توانید برای سفارشی‌سازی رفتار کتابخانه از آنها استفاده کنید.

فایل پیکربندی

می‌توانید هنگام نمونه‌سازی کلاینت، یک فایل googleads.properties را برای استفاده مشخص کنید.

اگر هنگام نمونه‌سازی از هیچ آرگومانی استفاده نکنید:

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

سپس کتابخانه در دایرکتوری HOME شما به دنبال فایل می‌گردد.

به عنوان یک جایگزین، می‌توانید مسیر را مشخص کنید:

my $properties_file = "/path/to/googleads.properties";

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

در این صورت، کلاینت در آن مسیر به دنبال فایل می‌گردد.

ساده‌ترین راه برای تولید این فایل، کپی کردن googleads.properties از مخزن GitHub و تغییر آن برای گنجاندن شناسه کلاینت، رمز کلاینت و توکن refresh شما است.

پیکربندی پویا

می‌توانید پیکربندی را به صورت پویا هنگام نمونه‌سازی کتابخانه یا حتی پس از آن تنظیم کنید:

my $api_client = Google::Ads::GoogleAds::Client->new({
  login_customer_id => "INSERT_LOGIN_CUSTOMER_ID_HERE"
});

شما حتی می‌توانید پیکربندی را پس از نمونه‌سازی تغییر دهید:

$api_client->set_login_customer_id("INSERT_LOGIN_CUSTOMER_ID_HERE");

همچنین می‌توانید یک شیء OAuth2ApplicationsHandler را از API Client دریافت کنید و شناسه کلاینت، رمز کلاینت و توکن refresh را در زمان اجرا تغییر دهید:

my $oauth2_applications_handler = $api_client->get_oauth2_applications_handler();
$oauth2_applications_handler->set_client_id("INSERT_CLIENT_ID");
$oauth2_applications_handler->set_client_secret("INSERT_CLIENT_SECRET");
$oauth2_applications_handler->set_refresh_token("INSERT_REFRESH_TOKEN");

متغیرهای محیطی پیکربندی

می‌توانید برخی از تنظیمات پیکربندی را از متغیرهای محیطی هنگام نمونه‌سازی کلاینت‌ها تنظیم کنید (به فهرست جامع مراجعه کنید).

ماژول کلاینت تابع configure_from_environment_variables را برای بارگذاری مقادیر از متغیرهای محیطی ارائه می‌دهد:

# Get the Google Ads Client. By default, any credentials will be read from
# ~/googleads.properties, or, if set, from the file specified in the
# GOOGLE_ADS_CONFIGURATION_FILE_PATH environment variable.
my $api_client = Google::Ads::GoogleAds::Client->new();

# Load the configuration from any set environment variables.
$api_client->configure_from_environment_variables();

فیلدهای پیکربندی

ویژگی‌های پیکربندی از فیلدهای زیر پشتیبانی می‌کنند:

فیلدها در OAuth2ApplicationsHandler باقی ماندند:

  • client_id : شناسه کلاینت OAuth2 شما.
  • client_secret : رمز کلاینت OAuth2 شما.
  • refresh_token : توکن به‌روزرسانی OAuth2 شما.

فیلدها در API Client باقی ماندند:

  • login_customer_id : به مستندات login-customer-id مراجعه کنید.
  • proxy : آدرس اینترنتی سرور پروکسی که برای اتصال به اینترنت استفاده می‌شود.