कॉन्फ़िगरेशन

लाइब्रेरी, System.getProperty("user.home") + "/ads.properties" में कॉन्फ़िगरेशन फ़ाइल ढूंढती है. इनमें से किसी एक तरीके का इस्तेमाल करके, रनटाइम के दौरान इस पाथ और फ़ाइल के नाम को बदला जा सकता है. इसके लिए, GoogleAdsClient को बनाया जाता है:

• fromPropertiesFile(PATH_TO_CONFIG_FILE) को कॉल करें. यहां PATH_TO_CONFIG_FILE आपकी कॉन्फ़िगरेशन फ़ाइल का पाथ और नाम है.
• एनवायरमेंट वैरिएबल GOOGLE_ADS_CONFIGURATION_FILE_PATH को कॉन्फ़िगरेशन फ़ाइल के पाथ और फ़ाइल के नाम पर सेट करें. इसके बाद, fromPropertiesFile() को कॉल करें.

कॉन्फ़िगरेशन फ़ाइल का फ़ॉर्मैट, की वैल्यू पेयर की Java Properties फ़ाइल जैसा होता है. चुने गए पुष्टि करने के तरीके के हिसाब से, इस्तेमाल की जा सकने वाली कुंजियां अलग-अलग होती हैं.

डेस्कटॉप और वेब ऐप्लिकेशन के फ़्लो के लिए काम करने वाली कुंजियां

अगर एक उपयोगकर्ता या डिवाइस के एक से ज़्यादा उपयोगकर्ता वाला ऐप्लिकेशन फ़्लो इस्तेमाल किया जा रहा है, तो इन कुंजियों का इस्तेमाल किया जा सकता है:

# 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


# 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

# Specifies whether to use application default credentials.
api.googleads.useApplicationDefaultCredentials=false

सेवा खातों के लिए इस्तेमाल की जा सकने वाली कुंजियां

अगर सेवा खाते का इस्तेमाल किया जा रहा है, तो ये कुंजियां इस्तेमाल की जा सकती हैं:

# 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


# 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.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
api.googleads.useApplicationDefaultCredentials	GOOGLE_ADS_USE_APPLICATION_DEFAULT_CREDENTIALS

सही एनवायरमेंट वैरिएबल सेट करने के बाद, बिल्डर पर fromEnvironment() को कॉल करके GoogleAdsClient को कॉन्फ़िगर करें.

GoogleAdsClient googleAdsClient = GoogleAdsClient.newBuilder()
  .fromEnvironment()
  .build();

कॉन्फ़िगरेशन के तरीकों को एक साथ इस्तेमाल करना

GoogleAdsClient और इसके बिल्डर की मदद से, कॉन्फ़िगरेशन की अलग-अलग रणनीतियों को एक साथ इस्तेमाल किया जा सकता है. उदाहरण के लिए, इंस्टेंस के क्रेडेंशियल और अन्य एट्रिब्यूट के लिए प्रॉपर्टी फ़ाइल को कॉन्फ़िगर करने के लिए, एनवायरमेंट वैरिएबल का इस्तेमाल किया जा सकता है. इसके लिए, यहां दिए गए स्निपेट का इस्तेमाल करें.

GoogleAdsClient googleAdsClient = GoogleAdsClient.newBuilder()
    .fromEnvironment()
    .fromPropertiesFile()
    .build();

इस उदाहरण में, क्लाइंट लाइब्रेरी, प्रॉपर्टी फ़ाइल में मौजूद वैल्यू का इस्तेमाल करेगी. ऐसा उन एट्रिब्यूट के लिए किया जाएगा जिन्हें एनवायरमेंट वैरिएबल और प्रॉपर्टी फ़ाइल में मौजूद एंट्री, दोनों के ज़रिए तय किया गया है. इसके उलट, fromEnvironment() से पहले fromPropertiesFile() को कॉल करें.

build() को कॉल करने से पहले, बिल्डर के कॉन्फ़िगरेशन के अन्य तरीकों का इस्तेमाल करके, रनटाइम के दौरान और बदलाव किए जा सकते हैं.