نمای کلی

کتابخانه مشتری Python در GitHub میزبانی می‌شود و بسته در PyPI دردسترس است.

الزامات

این کتابخانه از Python 3.9 تا 3.14 پشتیبانی می‌کند (>=3.9, <3.15؛ پشتیبانی از Python 3.14 در v28.2.0 اضافه شد). چون Python 3.9 و 3.10 در نسخه google-ads v32.0.0 و نسخه‌های جدیدتر هشدار منسوخ شدن در وارد کردن را صادر می‌کنند، استفاده از Python 3.11 یا نسخه‌های جدیدتر توصیه می‌شود.

پیش‌نیازها

قبل‌از ادامه دادن با این راهنما، به شناسه مشتری کارخواه ۱۰ رقمی حساب Google Ads خود نیاز دارید.

سازگاری زمان اجرا و وابستگی

کتابخانه کارخواه Python با زمان‌های اجرای Python در بخش نسخه‌های پشتیبانی‌شده که توسط بنیاد نرم‌افزار Python منتشر شده است سازگار است، به‌جز نسخه‌هایی که وضعیت «ویژگی» یا «پیش‌انتشار» دارند.

تیم Google Ads API قصد دارد نسخه‌های جدید زمان اجرای Python را به‌محض انتشار و پشتیبانی رسمی توسط Python Software Foundation اتخاذ کند.

زمان‌های اجرای Python که به پایان عمر (EOL) رسیده‌اند، پس‌از تاریخ پایان عمر در بخش نسخه‌های پشتیبانی‌نشده در python.org پشتیبانی نمی‌شوند. سازگاری با زمان‌های اجرای EOL تضمین نمی‌شود، زیرا نسخه‌های کتابخانه پس‌از تاریخ EOL ممکن است سازگاری را ازبین ببرد.

برای وابستگی‌ها (به‌طور خاص، هر بسته تحت نگهداری Google که توسط کتابخانه مشتری Python به‌عنوان الزامی فهرست شده است)، سازگاری با بسته‌هایی که تحت نگهداری Google هستند و طبق خط‌مشی تغییرات ناسازگار با نسخه‌های قبلی OSS Google «پشتیبانی‌شده» محسوب می‌شوند حفظ می‌شود.

برای مشاهده فهرست کامل وابستگی‌ها و زمان‌های اجرای Python پشتیبانی‌شده، به صفحه وابستگی‌ها مراجعه کنید.

نصب

راهنمای نصب همه روش‌های مختلف نصب کتابخانه را به‌طور خلاصه شرح می‌دهد. ساده‌ترین (و توصیه‌شده‌ترین) روش برای نصب کتابخانه در برنامه‌تان با pip است:

python -m pip install google-ads

پیکربندی

پس‌از نصب کتابخانه، باید پیکربندی آن را راه‌اندازی کنید. روش‌های متعددی برای پیکربندی کتابخانه وجود دارد که در راهنمای پیکربندی شرح داده شده است.

اصالت‌سنجی

پس‌از انتخاب رویکرد پیکربندی، پیکربندی اصالت‌سنجی را راه‌اندازی کنید. برای دستورالعمل‌های گام‌به‌گام، راهنمای اصالت‌سنجی کتابخانه کارخواه Python را ببینید. برای اطلاعات عمومی بیشتر، نمای کلی OAuth را ببینید.

درخواست دادن به میانای برنامه‌سازی کاربردی

پس‌از راه‌اندازی پیکربندی اصالت‌سنجی، آماده‌اید تا درخواست API ایجاد کنید. برای روشی سریع برای آزمایش اینکه کتابخانه به‌درستی برای درخواست‌های API پیکربندی شده است، به مثال دریافت پویش‌ها مراجعه کنید.

برای اجرای نمونه get_campaigns.py، ابتدا مخزن google-ads-python را کلون کنید. سپس، از دایرکتوری ریشه مخزن کلون‌شده، فرمان زیر را اجرا کنید:

python examples/basic_operations/get_campaigns.py -c INSERT_CUSTOMER_ID_HERE

منابع بیشتر

پس‌از اینکه توانستید درخواست API ایجاد کنید، به این موارد استفاده از کتابخانه مشتری بروید: