الإعدادات

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

  • استدعِ fromPropertiesFile(PATH_TO_CONFIG_FILE)، حيث يكون PATH_TO_CONFIG_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

# 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

المفاتيح المتوافقة لحسابات الخدمة

إذا كنت تستخدم مسار حساب الخدمة، تكون المفاتيح المتوافقة هي على النحو التالي:

# 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

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

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

الجمع بين نُهُج الضبط

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

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

في هذا المثال، ستستخدم مكتبة العملاء القيمة من ملف الخصائص لأي سمة تم تحديدها من خلال كل من متغير البيئة وإدخال قيمة في ملف الخصائص. للسلوك المعاكس، ما عليك سوى استدعاء fromPropertiesFile() قبل fromEnvironment().

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