Cấu hình

Thư viện ứng dụng Perl của Google Ads API cung cấp một số chế độ cài đặt cấu hình mà bạn có thể dùng để tuỳ chỉnh hành vi của thư viện.

Tệp cấu hình

Bạn có thể chỉ định một tệp googleads.properties để sử dụng khi tạo thực thể cho ứng dụng.

Nếu bạn không sử dụng đối số nào khi tạo thực thể:

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

thì thư viện sẽ tìm tệp trong thư mục HOME hoặc tại đường dẫn được chỉ định trong biến môi trường GOOGLE_ADS_CONFIGURATION_FILE_PATH nếu biến này được đặt.

Ngoài ra, bạn có thể chỉ định rõ ràng một đường dẫn:

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

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

trong trường hợp đó, ứng dụng sẽ tìm tệp tại đường dẫn đó.

Cách dễ nhất để tạo tệp này là sao chép googleads.properties từ kho lưu trữ GitHub rồi sửa đổi tệp đó để thêm mã ứng dụng khách, khoá bí mật của ứng dụng khách và mã làm mới.

Cấu hình động

Bạn có thể thiết lập cấu hình một cách linh động khi tạo thực thể cho thư viện hoặc sau khi tạo thực thể:

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

Bạn cũng có thể sửa đổi cấu hình sau khi tạo thực thể:

$api_client->set_login_customer_id("INSERT_LOGIN_CUSTOMER_ID_HERE");

Bạn cũng có thể lấy đối tượng OAuth2ApplicationsHandler từ thực thể Client, rồi thay đổi mã ứng dụng khách, khoá bí mật của ứng dụng khách và mã làm mới trong thời gian chạy:

my $oauth2_applications_handler =
  $api_client->get_oauth2_applications_handler();
$oauth2_applications_handler->set_client_id("INSERT_CLIENT_ID_HERE");
$oauth2_applications_handler->set_client_secret("INSERT_CLIENT_SECRET_HERE");
$oauth2_applications_handler->set_refresh_token("INSERT_REFRESH_TOKEN_HERE");

Lưu ý: Bạn không nên lưu trữ thông tin bí mật được mã hoá cứng trong mã nguồn. Sử dụng biến môi trường hoặc tệp thuộc tính bảo mật cho môi trường thực tế.

Biến môi trường cấu hình

Bạn có thể đặt một số chế độ cài đặt cấu hình từ các biến môi trường khi tạo thực thể cho ứng dụng (xem biến môi trường tiêu chuẩn).

Mô-đun Client cung cấp hàm configure_from_environment_variables để tải các giá trị từ biến môi trường.

Lưu ý: Các biến môi trường chưa đặt sẽ không được tính đến.

# Get the Google Ads API Client. By default, any credentials are 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();

Trường cấu hình

Lưu ý rằng các khoá googleads.properties sử dụng camelCase (chẳng hạn như loginCustomerId và linkedCustomerId), trong khi các đối số hàm khởi tạo Client->new({...}) và phương thức trình xử lý sử dụng snake_case (chẳng hạn như login_customer_id và linked_customer_id).

Các trường được lưu trữ trong OAuth2ApplicationsHandler:

• client_id (clientId trong googleads.properties, GOOGLE_ADS_CLIENT_ID): Mã ứng dụng khách OAuth2 của bạn.
• client_secret (clientSecret trong googleads.properties, GOOGLE_ADS_CLIENT_SECRET): Khoá bí mật của ứng dụng OAuth2.
• refresh_token (refreshToken trong googleads.properties, GOOGLE_ADS_REFRESH_TOKEN): Mã làm mới OAuth2 của bạn.
• additional_scopes (additionalScopes trong googleads.properties): Các phạm vi OAuth2 khác cần yêu cầu.

Các trường được lưu trữ trong OAuth2ServiceAccountsHandler:

• json_key_file_path (jsonKeyFilePath trong googleads.properties, GOOGLE_ADS_JSON_KEY_FILE_PATH): Đường dẫn đến tệp khoá JSON của tài khoản dịch vụ.
• impersonated_email (impersonatedEmail trong googleads.properties, GOOGLE_ADS_IMPERSONATED_EMAIL): Địa chỉ email cần mạo danh khi sử dụng tính năng uỷ quyền trên toàn miền của Google Workspace.
• additional_scopes (additionalScopes trong googleads.properties): Các phạm vi OAuth2 khác cần yêu cầu.

Các trường được lưu trữ trong Client:

• login_customer_id (loginCustomerId trong googleads.properties, GOOGLE_ADS_LOGIN_CUSTOMER_ID): Mã của tài khoản người quản lý dùng để truy cập vào tài khoản khách hàng. Hãy xem tài liệu về mã khách hàng đăng nhập.
• linked_customer_id (linkedCustomerId trong googleads.properties, GOOGLE_ADS_LINKED_CUSTOMER_ID): Mã khách hàng được liên kết.
• service_address (serviceAddress trong googleads.properties, GOOGLE_ADS_ENDPOINT): URL địa chỉ dịch vụ Google Ads API (mặc định là "https://googleads.googleapis.com").
• user_agent (userAgent trong googleads.properties, GOOGLE_ADS_PERL_USER_AGENT): Tiền tố tiêu đề tác nhân người dùng tuỳ chỉnh có trong các yêu cầu HTTP.
• proxy (proxy trong googleads.properties, GOOGLE_ADS_PERL_PROXY): URL của máy chủ proxy dùng để kết nối Internet.
• version (Client->new hoặc set_version): Mô-đun phiên bản Google Ads API cần sử dụng (mặc định là "V26").
• die_on_faults (Client->new hoặc set_die_on_faults): Đặt thành 1 để các lệnh gọi phương thức dịch vụ gọi die() bằng tải trọng phản hồi thô khi có lỗi API thay vì trả về đối tượng Google::Ads::GoogleAds::GoogleAdsException (mặc định là 0).
• http_timeout (Client->new hoặc set_http_timeout): Thời gian chờ HTTP tính bằng giây (mặc định là 3600).
• http_retry_timing (Client->new hoặc set_http_retry_timing): Khoảng thời gian tạm dừng thử lại tính bằng giây đối với lỗi HTTP 503 và 504 tạm thời (mặc định là "5,10,15").