تتم استضافة مكتبة Python للعملاء على GitHub، وتتوفّر الحزمة على PyPI.
المتطلبات
تتطلّب المكتبة استخدام الإصدار 3.8 من Python أو إصدار أحدث.
المتطلبات الأساسية
قبل تثبيت المكتبة، ستحتاج إلى رمز مطوّر و رقم تعريف العميل. وقد تم توضيح التعليمات حول كيفية الحصول عليها في قسم المتطلبات الأساسية. تجدر الإشارة إلى أنّه سيتم إنشاء رموز OAuth2 المميزة الأخرى المطلوبة في الخطوات اللاحقة.
التوافق مع وقت التشغيل والتبعيات
تحافظ مكتبة برامج Python على التوافق مع أوقات تشغيل Python في قسم الإصدارات المتوافقة الذي تنشره مؤسسة Python Software Foundation، باستثناء الإصدارات التي تحمل الحالة "ميزة" أو "إصدار تجريبي".
عند استخدام إصدارات جديدة من وقت تشغيل Python، نهدف إلى طرح إصدار جديد من مكتبة برامج Python متوافق مع أحدث إصدار من وقت التشغيل بحلول نهاية الربع التالي لإصداره. على سبيل المثال، إذا تم طرح بيئة تشغيل جديدة في تشرين الأول (أكتوبر)، سيكون هناك إصدار متوافق من مكتبة برامج Python بحلول نهاية آذار (مارس) من العام التالي.
لا تتوفّر أنظمة التشغيل Python التي انتهت دورة حياتها بعد تاريخ انتهاء دورة الحياة في قسم الإصدارات غير المتوافقة على python.org.
قد نصدر إصدارًا من مكتبة برامج Python غير متوافق مع بيئات تشغيل Python غير المتوافقة في أي وقت بعد الوصول إلى EOL.
بالنسبة إلى التبعيات (أي أي حِزم تديرها 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
مراجع إضافية
بعد أن تتمكن من تقديم طلب من واجهة برمجة التطبيقات، تابع الاستخدامات التالية لمكتبة العميل: