التهيئة

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

ملف الإعداد

يمكنك تحديد ملف google_ads_config.rb لاستخدامه عند إنشاء مثيل للعميل.

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

بدلاً من ذلك، يمكنك تحديد مسار عند إنشاء مثيل GoogleAdsClient للكائن على النحو التالي، وفي هذه الحالة سيبحث العميل عن الملف في هذا المسار.

  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.
  • login_customer_id: يمكنك الاطّلاع على مستندات 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.