تفعيل التسجيل

توفّر المكتبة إمكانية تسجيل مرنة للتفاعلات مع Google Ads API. يمكنك تسجيل:

  • المعلومات التفصيلية: الطلبات الكاملة المُرسَلة إلى واجهة برمجة التطبيقات والردود التي تمّ تلقّيها
  • الملخّصات الموجزة: نظرة عامة شاملة على التفاعلات

ويمكنك التحكّم في إعدادات التسجيل هذه بطريقتَين:

  • إعداد مكتبة البرامج: استخدِم خيارات الإعداد الخاصة بالمكتبة.
  • آليًا باستخدام لغة Python: استخدِم إطار عمل التسجّل المضمّن في Python للتحكّم بشكلٍ أكثر مباشرةً.

يتم ضبط التسجيل تلقائيًا عند تهيئة مثيل GoogleAdsClient. تحدث خطوة الإعداد هذه، على سبيل المثال، عند استخدام الطريقة load_from_storage. في هذه المرحلة، ستنفّذ المكتبة ما يلي:

  • اطّلِع على إعدادات التسجيل المحدّدة من الإعداد.
  • نقْل هذه الإعدادات إلى دالة logging.config.dictConfig المضمّنة في Python لتفعيلها.

عند استخدام هذه المكتبة كحزمة مثبَّتة، عليك دمج تسجيلها مع إعدادات تسجيل تطبيقك. وعلى وجه التحديد، عليك إضافة معالج تسجيل إلى مثيل أداة تسجيل المكتبة باستخدام الأسلوب addHandler. سيحدِّد هذا المعالِج المكان الذي يتم توجيه رسائل سجلّ المكتبة إليه (مثلاً، إلى وحدة التحكّم أو ملف أو غير ذلك). لإجراء ذلك، عليك أولاً استرداد مثيل المسجّل في المكتبة كما هو موضّح هنا:

import logging

logger = logging.getLogger('google.ads.googleads.client')

بعد استرداد أداة تسجيل السجلّات في المكتبة، يمكنك تحديد مكان إخراج رسائل السجلّ.

  • إرسال السجلات إلى وحدة التحكّم: لعرض رسائل السجلّ على وحدة التحكّم، عليك إضافة معالِج أساسي. في ما يلي كيفية توجيه السجلات إلى الإخراج العادي (stdout):

    في ما يلي كيفية ضبط معالج أساسي يطلب من أداة تسجيل الدخول الطباعة على ملف logfile.txt:stdout

    import sys
    
    # Assuming 'logger' was retrieved as per previous instructions
    logger.addHandler(logging.StreamHandler(sys.stdout))
    

    إذا كنت تفضّل إرسال السجلات إلى الخطأ العادي (stderr)، والذي غالبًا ما يتم استخدامه لرسائل الخطأ والتحذيرات:

    import sys
    
    # Assuming 'logger' was retrieved as per previous instructions
    logger.addHandler(logging.StreamHandler(sys.stderr))
    
  • ضبط إعدادات التسجيل الأخرى آليًا: بعد الحصول على ملف برمجي logger، يمكنك أيضًا تغيير إعدادات التسجيل الأخرى آليًا باستخدام وحدة logging المضمّنة في Python. على سبيل المثال، لتغيير مستوى التسجيل إلى DEBUG (الذي سيعرض رسائل أكثر تفصيلاً):

    logger.setLevel(logging.DEBUG)
    

مستويات السجلّ

يُنشئ العميل السجلات على مستويات مختلفة، ويمكنك ضبط الإعدادات للاطّلاع على بعض أو كل ما يلي:

المستوى طلب ناجح تعذّر تنفيذ الطلب
DEBUG سجلّ تفصيلي يحتوي على عناصر الطلب والاستجابة الكاملة بتنسيق JSON سجلّ تفصيلي يحتوي على عناصر الطلب والاستثناءات الكاملة بتنسيق JSON
INFO ملخص موجز يتضمّن حقول طلب واستجابة محدّدة سجلّ تفصيلي يحتوي على عناصر الطلب والاستثناءات الكاملة بتنسيق JSON
WARNING بدون ملخّص موجز يحتوي على معلومات محدّدة عن الطلب وحالة الاستثناء ورسالته

بما أنّ إطار عمل تسجيل Python يتجاهل رسائل السجلّ الأقل خطورة مقارنةً بالمستوى الذي تم ضبطه، فإنّ ضبط القيمة على WARNING يعني أنّه لن تظهر لك سوى رسائل مختصرة مرتبطة بالطلبات التي تعذّر إكمالها، ولكنّ ضبط القيمة على DEBUG يعني أنّه ستظهر لك جميع الأنواع الممكنة من السجلّات في الجدول أعلاه.

التسجيل في ملف

عند تشغيل أمثلة النصوص البرمجية، مثل get_campaigns.py من سطر الأوامر، يمكن توجيه أي رسائل سجلّ يتم طباعتها عادةً في وحدة التحكّم (أو "توجيهها") إلى ملف. هذه ميزة في غلافه التشغيلي، وليس مكتبة Python نفسها. يُرجى اتّباع الخطوات التالية:

لحفظ الإخراج العادي (معظم السجلات) في ملف (مع استبداله):

python get_campaigns.py -c $CLIENT_ID > campaign_logs.txt

لإلحاق الإخراج العادي بملف:

python get_campaigns.py -c $CLIENT_ID >> campaign_logs.txt

لحفظ كلّ من الإخراج العادي والخطأ العادي (للأخطاء/التحذيرات) في الملف نفسه:

python get_campaigns.py -c $CLIENT_ID > all_logs.txt 2>&1

(أو في بعض أنظمة التشغيل الحديثة مثل Bash 4 والإصدارات الأحدث):

python get_campaigns.py -c $CLIENT_ID &> all_logs.txt

أدوات اعتراض التسجيل

تستخدِم مكتبة Python للعميل مُعترضات gRPC للوصول إلى تفاصيل الطلب والردّ وتسجيلها. يمكنك إعداد التسجيل المخصّص الخاص بك عن طريق إنشاء قاطع gRPC باستخدام منطق مخصّص. اطّلِع على دليل تسجيل السجلّات لمزيد من التفاصيل ومثال على أداة اعتراض تسجيل السجلّات المخصّصة.