التهيئة

تبحث مكتبة برامج Java عن ملف إعداد باسم ads.properties في دليل الصفحة الرئيسية (System.getProperty("user.home") + "/ads.properties" أو ~/ads.properties). يمكنك إلغاء هذا المسار واسم الملف في وقت التشغيل عند إنشاء GoogleAdsClient باستخدام أي من الآليتَين التاليتَين:

• استدعِ fromPropertiesFile(PATH_TO_CONFIG_FILE)، حيث PATH_TO_CONFIG_FILE هو مسار File واسم ملف الإعداد.
• اضبط متغيّر البيئة GOOGLE_ADS_CONFIGURATION_FILE_PATH على المسار واسم ملف الإعداد، ثم استدعِ fromPropertiesFile().

تنسيق ملف الإعداد هو ملف خصائص 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

# 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

# Optional: Email address of the user to impersonate when using Google Workspace
# domain-wide delegation. This should be a user who has access to your Google Ads
# account and is in the same Google Workspace 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

بعد ضبط متغيّرات البيئة المناسبة، اضبط GoogleAdsClient من خلال استدعاء fromEnvironment() في أداة الإنشاء:

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

الجمع بين طرق الإعداد

تتيح فئة GoogleAdsClient وأداة الإنشاء الخاصة بها الجمع بين استراتيجيات ضبط مختلفة. على سبيل المثال، يمكنك استخدام متغيّرات البيئة لضبط بيانات اعتماد المثيل وملف خصائص للسمات الأخرى باستخدام المقتطف التالي:

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

ملاحظة: تطبّق طرق ضبط Builder الإعدادات بالترتيب الذي يتم استدعاؤها به، حيث تلغي الاستدعاءات اللاحقة الاستدعاءات السابقة. في المثال السابق، تستخدم مكتبة البرامج القيمة من ملف الخصائص لأي سمة محدّدة في كل من البيئة وملف الخصائص. للسماح لمتغيّرات البيئة بتجاوز ملف المواصفات، يمكنك استدعاء fromPropertiesFile() قبل fromEnvironment().

يمكنك إجراء المزيد من التغييرات في وقت التشغيل باستخدام طرق الضبط الأخرى لأداة الإنشاء قبل استدعاء build().