نظرة عامة

تتم استضافة مكتبة عملاء Python على GitHub، والحزمة متوفّرة على PyPI.

المتطلّبات

تتطلب المكتبة توفُّر الإصدار Python 3.8 أو إصدار أحدث.

المتطلبات الأساسية

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

التوافق مع بيئة التشغيل والتبعية

تحافظ مكتبة برامج Python على التوافق مع بيئات تشغيل Python في الـ الإصدارات المتوافقة تم نشره من قِبل Python Software Foundation، باستثناء الإصدارات التي تحمل الحالة "ميزة" أو "إصدار تجريبي".

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

إنّ بيئات تشغيل Python التي وصلت إلى نهاية دورة حياة المنتج (EOL) غير متاحة بعد تاريخ انتهاء دورة حياة المنتج في قسم الإصدارات غير المتوافقة من python.org.

يجوز لنا إصدار إصدار من مكتبة برامج Python غير متوافق مع IDEs لتشغيل Python غير المتوافقة في أي وقت بعد بلوغها نهاية عمرها.

بالنسبة للتبعيات، (على وجه التحديد، أي حزم تحتفظ بها Google وتكون كما هو مطلوب في مكتبة برامج بايثون)، فإننا سنحافظ على التوافق مع الحزم تخضع لصيانة Google وتُعتبر "متوافقة" وفقًا لـ Google سياسة التغيير المعطل لنظام التشغيل OSS:

للحصول على قائمة كاملة ببيئات تشغيل وتبعيات Python المتوافقة، التبعيات.

تثبيت

اتّبِع التعليمات الواردة في مستندات التثبيت لتثبيت المكتبة من PyPi والعودة إلى هذه الصفحة.

الإعداد

بعد تثبيت المكتبة، عليك إعداد ملف تكوين لها. وهناك العديد من الطرق لتهيئة المكتبة، كما هو موضح في التهيئة.

المصادقة

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

تقديم طلب بيانات من واجهة برمجة التطبيقات

بعد دمج رموز OAuth2 المميزة في التهيئة، تصبح على استعداد لتقديم طلب واجهة برمجة التطبيقات. راجِع مثال get campaigns للحصول على طريقة بسيطة لاختبار ما إذا كانت المكتبة قد تم ضبطها بشكلٍ صحيح لتقديم طلبات واجهة برمجة التطبيقات.

لتشغيل النموذج get_campaigns.py، في الدليل الجذر من جهازك تم تثبيت مكتبة برامج googleads-python، شغِّل الأمر التالي:

$ python examples/basic_operations/get_campaigns.py -c \
  INSERT_YOUR_CUSTOMER_ID_HERE

مراجع إضافية

بعد أن تتمكّن من إرسال طلب إلى واجهة برمجة التطبيقات، يمكنك المتابعة لاستخدامات مكتبة العميل التالية: