Thư viện tìm tệp cấu hình trong System.getProperty("user.home") + "/ads.properties"
. Bạn có thể ghi đè đường dẫn và tên tệp này trong thời gian chạy khi tạo GoogleAdsClient
bằng một trong hai cơ chế sau:
- Gọi
fromPropertiesFile(PATH_TO_CONFIG_FILE)
, trong đóPATH_TO_CONFIG_FILE
là đường dẫn và tên tệp của tệp cấu hình. - Đặt biến môi trường
GOOGLE_ADS_CONFIGURATION_FILE_PATH
thành đường dẫn và tên tệp của tệp cấu hình, sau đó gọifromPropertiesFile()
.
Định dạng của tệp cấu hình là định dạng của tệp Thuộc tính Java chứa các cặp khoá-giá trị. Các khoá được hỗ trợ sẽ khác nhau tuỳ thuộc vào quy trình xác thực được chọn.
Các khoá được hỗ trợ cho luồng ứng dụng trên máy tính và web
Nếu bạn đang sử dụng quy trình ứng dụng máy tính hoặc web, thì các phím được hỗ trợ là như sau:
# Credential for accessing Google's OAuth servers.
# Provided by console.cloud.google.com.
api.googleads.clientId=INSERT_CLIENT_ID_HERE
# Credential for accessing Google's OAuth servers.
# Provided by console.cloud.google.com.
api.googleads.clientSecret=INSERT_CLIENT_SECRET_HERE
# Renewable OAuth credential associated with 1 or more Google Ads accounts.
api.googleads.refreshToken=INSERT_REFRESH_TOKEN_HERE
# Token which provides access to the Google Ads API in general. It does not
# grant access to any particular ad account (OAuth is used for this purpose).
api.googleads.developerToken=INSERT_DEVELOPER_TOKEN_HERE
# Required for manager accounts only: Specify the login customer ID used to
# authenticate API calls. This will be the customer ID of the authenticated
# manager account. You can also specify this later in code if your application
# uses multiple manager account + OAuth pairs.
#
# api.googleads.loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE
# Only required if explicitly instructed by the service documentation.
# api.googleads.linkedCustomerId=INSERT_LINKED_CUSTOMER_ID_HERE
# Maximum allowed response payload size, in bytes.
# Customize this to allow response sizes for GoogleAdsService.search and
# GoogleAdsService.searchStream API calls to exceed the default limit of 64MB.
# api.googleads.maxInboundMessageBytes=INSERT_MAX_INBOUND_MESSAGE_BYTES_HERE
Các khoá được hỗ trợ cho tài khoản dịch vụ
Nếu bạn đang sử dụng luồng tài khoản dịch vụ, thì các khoá được hỗ trợ như sau:
# Path to the service account secrets file in JSON format.
# Provided by console.cloud.google.com.
api.googleads.serviceAccountSecretsPath=INSERT_PATH_TO_JSON_HERE
# Email address of the user to impersonate.
# This should be a user who has access to your Google Ads account and is in the same
# Google Apps Domain as the service account.
api.googleads.serviceAccountUser=INSERT_USER_EMAIL_ADDRESS_HERE
# Token which provides access to the Google Ads API in general. It does not
# grant access to any particular ad account (OAuth is used for this purpose).
api.googleads.developerToken=INSERT_DEVELOPER_TOKEN_HERE
# Required for manager accounts only: Specify the login customer ID used to
# authenticate API calls. This will be the customer ID of the authenticated
# manager account. You can also specify this later in code if your application
# uses multiple manager account + OAuth pairs.
#
# api.googleads.loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE
Sử dụng biến môi trường
Thư viện này hỗ trợ tất cả các biến môi trường phổ biến cho tất cả thư viện ứng dụng API Google Ads. Bảng dưới đây cho thấy biến môi trường tương ứng với từng thuộc tính tệp cấu hình.
Thuộc tính tệp cấu hình | Biến môi trường |
---|---|
api.googleads.developerToken |
GOOGLE_ADS_DEVELOPER_TOKEN |
api.googleads.clientId |
GOOGLE_ADS_CLIENT_ID |
api.googleads.clientSecret |
GOOGLE_ADS_CLIENT_SECRET |
api.googleads.refreshToken |
GOOGLE_ADS_REFRESH_TOKEN |
api.googleads.serviceAccountSecretsPath |
GOOGLE_ADS_JSON_KEY_FILE_PATH |
api.googleads.serviceAccountUser |
GOOGLE_ADS_IMPERSONATED_EMAIL |
api.googleads.loginCustomerId |
GOOGLE_ADS_LOGIN_CUSTOMER_ID |
api.googleads.linkedCustomerId |
GOOGLE_ADS_LINKED_CUSTOMER_ID |
api.googleads.maxInboundMessageBytes |
GOOGLE_ADS_MAX_INBOUND_MESSAGE_BYTES |
Sau khi bạn đặt các biến môi trường thích hợp, hãy định cấu hình GoogleAdsClient
bằng cách gọi fromEnvironment()
trên trình tạo.
GoogleAdsClient googleAdsClient = GoogleAdsClient.newBuilder()
.fromEnvironment()
.build();
Kết hợp các phương pháp cấu hình
GoogleAdsClient
và trình tạo của lớp này hỗ trợ việc kết hợp nhiều chiến lược cấu hình. Ví dụ: bạn có thể sử dụng các biến môi trường để định cấu hình thông tin xác thực của thực thể và tệp thuộc tính cho các thuộc tính khác bằng cách sử dụng đoạn mã sau.
GoogleAdsClient googleAdsClient = GoogleAdsClient.newBuilder()
.fromEnvironment()
.fromPropertiesFile()
.build();
Trong ví dụ này, thư viện ứng dụng sẽ sử dụng giá trị từ tệp thuộc tính cho mọi thuộc tính được xác định thông qua cả biến môi trường và mục nhập trong tệp thuộc tính. Đối với hành vi ngược lại, bạn chỉ cần gọi fromPropertiesFile()
trước fromEnvironment()
.
Bạn có thể thực hiện thêm các thay đổi trong thời gian chạy bằng cách sử dụng các phương thức cấu hình khác của trình tạo trước khi gọi build()
.