نظرة عامة

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

المتطلبات

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

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

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

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

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

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

لا تتوفّر أنظمة التشغيل Python التي انتهت دورة حياتها بعد تاريخ انتهاء دورة الحياة في قسم الإصدارات غير المتوافقة على الرابط python.org.

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

بالنسبة إلى التبعيات (أي أي حِزم تديرها Google ويتم إدراجها على أنّها مطلوبة من قِبل مكتبة Python للعملاء)، سنحافظ على التوافق مع الحِزم التي تديرها Google والتي تُعدّ "متوافقة" وفقًا لسياسة التغييرات الأساسية في البرامج المفتوحة المصدر المتّبعة في Google.

للحصول على قائمة كاملة بأنظمة التشغيل والتبعيات المتوافقة مع 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

مراجع إضافية

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