التهيئة

تبحث المكتبة عن ملف إعداد في 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() في أداة الإنشاء.

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

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

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

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

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

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