ไลบรารีจะค้นหาไฟล์การกำหนดค่าใน
System.getProperty("user.home") + "/ads.properties"
คุณสามารถลบล้างเส้นทางและชื่อไฟล์นี้ได้ที่รันไทม์เมื่อสร้าง GoogleAdsClient
โดยใช้กลไกอย่างใดอย่างหนึ่งต่อไปนี้
- เรียกใช้
fromPropertiesFile(PATH_TO_CONFIG_FILE)
โดยที่PATH_TO_CONFIG_FILE
คือเส้นทางและชื่อไฟล์การกำหนดค่า - ตั้งค่าตัวแปรสภาพแวดล้อม
GOOGLE_ADS_CONFIGURATION_FILE_PATH
เป็นเส้นทางและชื่อไฟล์การกำหนดค่า แล้วเรียกใช้fromPropertiesFile()
รูปแบบของไฟล์การกำหนดค่าคือรูปแบบของไฟล์ Properties ของคู่คีย์-ค่าใน Java คีย์ที่รองรับจะแตกต่างกันไปตามโฟลว์การตรวจสอบสิทธิ์ที่เลือก
คีย์ที่รองรับสำหรับขั้นตอนการทำงานของแอปพลิเคชันเดสก์ท็อปและเว็บ
หากคุณใช้ขั้นตอนการสมัครใช้งานแอปพลิเคชันเดสก์ท็อปหรือ เว็บ คีย์ที่รองรับ มีดังนี้
# 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
คีย์ที่รองรับสำหรับบัญชีบริการ
หากคุณใช้ขั้นตอนบัญชีบริการ คีย์ที่รองรับมีดังนี้
# 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
การใช้ตัวแปรสภาพแวดล้อม
ไลบรารีรองรับตัวแปรสภาพแวดล้อมทั้งหมดที่ใช้ร่วมกันในไลบรารีไคลเอ็นต์ Google Ads API ตารางด้านล่างแสดง ตัวแปรสภาพแวดล้อมที่สอดคล้องกับพร็อพเพอร์ตี้ไฟล์การกำหนดค่าแต่ละรายการ
พร็อพเพอร์ตี้ไฟล์การกำหนดค่า | ตัวแปรสภาพแวดล้อม |
---|---|
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 |
เมื่อตั้งค่าตัวแปรสภาพแวดล้อมที่เหมาะสมแล้ว ให้กำหนดค่า
GoogleAdsClient
โดยเรียกใช้ fromEnvironment()
ใน Builder
GoogleAdsClient googleAdsClient = GoogleAdsClient.newBuilder()
.fromEnvironment()
.build();
การรวมแนวทางการกำหนดค่า
GoogleAdsClient
และเครื่องมือสร้างรองรับการรวมกลยุทธ์การกำหนดค่าที่แตกต่างกัน
เช่น คุณสามารถใช้ตัวแปรสภาพแวดล้อมเพื่อกำหนดค่า
ข้อมูลเข้าสู่ระบบของอินสแตนซ์และไฟล์พร็อพเพอร์ตี้สำหรับแอตทริบิวต์อื่นๆ โดยใช้
ข้อมูลโค้ดต่อไปนี้
GoogleAdsClient googleAdsClient = GoogleAdsClient.newBuilder()
.fromEnvironment()
.fromPropertiesFile()
.build();
ในตัวอย่างนี้ ไลบรารีของไคลเอ็นต์จะใช้ค่าจากไฟล์พร็อพเพอร์ตี้
สำหรับแอตทริบิวต์ที่กำหนดทั้งผ่านตัวแปรสภาพแวดล้อมและ
รายการในไฟล์พร็อพเพอร์ตี้ หากต้องการให้ทำงานในลักษณะตรงกันข้าม เพียงเรียกใช้
fromPropertiesFile()
ก่อน fromEnvironment()
คุณสามารถทำการเปลี่ยนแปลงเพิ่มเติมได้ในขณะรันไทม์โดยใช้วิธีการกำหนดค่าอื่นๆ ของ Builder ก่อนที่จะเรียกใช้ build()