التهيئة

ويتم إكمال عملية الإعداد باستخدام فئة 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 من مستودع جيت هب وتعديله لتضمين رمز التحديث المميز، ومعرف العميل، وسر العميل.

الإعداد الديناميكي

يمكنك إعداد الإعدادات ديناميكيًا عند إنشاء مثيل للمكتبة، أو حتى بعد ذلك:

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' رسائل "تصحيح الأخطاء" ولكنه يعرض جميع الرسائل الأخرى.
  • 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.