يتم الإعداد باستخدام صف Config
. يمكنك الوصول إلى هذه الفئة بعدة طرق، مثل كتابة ملف إعداد أو تحديد قيم عند الإنشاء أو تحميل القيم من متغيرات البيئة.
ملف الإعداد
يمكنك تحديد ملف google_ads_config.rb
لاستخدامه عند إنشاء مثيل للعميل.
في حال عدم استخدام أي وسيطات عند إنشاء مثيل:
client = Google::Ads::GoogleAds::GoogleAdsClient.new
ستبحث المكتبة في الموقع الجغرافي المحدّد في متغيّر البيئة GOOGLE_ADS_CONFIGURATION_FILE_PATH
. إذا لم يتم ضبط هذا المتغيّر، ستبحث المكتبة في دليل HOME
عن الملف.
ويمكنك بدلاً من ذلك تحديد مسار:
client = Google::Ads::GoogleAds::GoogleAdsClient.new("path/to/file.rb")
وفي هذه الحالة، سيبحث العميل عن الملف على مسار الملف هذا.
أسهل طريقة لإنشاء هذا الملف هي نسخ google_ads_config.rb
من مستودع GitHub وتعديله لتضمين الرمز المميز لإعادة التحميل ومعرِّف العميل وسر العميل.
إعداد ديناميكي
يمكنك إعداد الضبط ديناميكيًا عند إنشاء مثيل للمكتبة، أو حتى بعد ذلك:
client = Google::Ads::GoogleAds::GoogleAdsClient.new do |config|
config.client_id = 'INSERT_CLIENT_ID_HERE'
# ... more configuration
end
كما يمكنك تعديل الإعداد بعد إنشاء مثيل:
client.configure do |config|
config.login_customer_id = 'INSERT_LOGIN_CUSTOMER_ID_HERE'
# ... more configuration
end
حقول الضبط
يوفر الكائن Config
الحقول التالية.
الحقول العامة:
refresh_token
: الرمز المميز لإعادة تحميل OAuth.client_id
: معرِّف عميل OAuth.client_secret
: سر عميل OAuth.developer_token
: الرمز المميز للمطوِّر للوصول إلى واجهة برمجة التطبيقات.login_customer_id
: يُرجى الاطّلاع على وثائق تسجيل دخول العميل-.
حقول التسجيل: راجِع دليل التسجيل للاطّلاع على التفاصيل الكاملة.
log_level
: الحد الأدنى للرسائل على مستوى السجلّ التي تريد تسجيلها. على سبيل المثال، سيؤدي تحديد'DEBUG'
إلى ضمان الاطّلاع على جميع رسائل السجل، وسيؤدي تحديد'INFO'
إلى استبعاد رسائل DEBUG مع عرض جميع الرسائل الأخرى.log_target
: المكان الذي تريد تسجيل الدخول إليه، مثلSTDERR
logger
: حدِّد أداة التسجيل المخصّصة. وسيؤدي تحديد هذا الخيار إلى تجاهل كل منlog_level
وlog_target
.
متغيرات البيئة
يمكنك ضبط مكتبة العميل باستخدام متغيّرات البيئة. ولا يتم تحميل هذه الكلمات الرئيسية تلقائيًا، وتتطلب طلبًا إضافيًا بعد إنشاء مثيل للعميل من أجل التحميل. اطّلع على القائمة الكاملة لمتغيرات البيئة المتوافقة مع جميع اللغات.
لتحميل متغيّرات البيئة إلى Config
، يمكنك الاتصال بالرقم load_environment_config
:
client = Google::Ads::GoogleAds::GoogleAdsClient.new
client.load_environment_config
وفي كل مرة يُسمى ذلك، ستحل الحالة الحالية لمتغيرات البيئة محل أي شيء موجود مسبقًا في Config
. وباستخدام هذه الآلية، يمكنك مثلاً ضبط الإعدادات التلقائية مع إلغاء قيم محدّدة باستخدام متغيّرات البيئة أو يمكنك الضبط بالكامل باستخدام متغيّرات البيئة.
بالإضافة إلى متغيرات البيئة التي تدعمها جميع المكتبات، تحتوي مكتبة Ruby على متغيرين إضافيين:
GOOGLE_ADS_RUBY_LOG_LEVEL
: باسمlog_level
أعلاه.GOOGLE_ADS_RUBY_HTTP_PROXY
: حدِّد خادم وكيل HTTP.