نمای کلی

کتابخانه کلاینت پایتون در گیت‌هاب میزبانی می‌شود و بسته آن در PyPI موجود است.

الزامات

این کتابخانه به پایتون ۳.۹ یا بالاتر نیاز دارد.

پیش‌نیازها

قبل از ادامه این راهنما، به یک توکن توسعه‌دهنده برای API گوگل ادز و یک شناسه مشتری 10 رقمی برای حساب گوگل ادز خود نیاز دارید.

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

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

هدف ما این است که نسخه‌های جدید پایتون را به محض انتشار و پشتیبانی رسمی توسط بنیاد نرم‌افزار پایتون، با آن سازگار کنیم.

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

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

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

نصب

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

$ python -m pip install google-ads

پیکربندی

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

احراز هویت

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

درخواست API ارسال کنید

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

برای اجرای نمونه get_campaigns.py ، در دایرکتوری ریشه کتابخانه کلاینت googleads-python که به صورت محلی نصب شده است، دستور زیر را اجرا کنید:

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

منابع اضافی

بعد از اینکه توانستید درخواست API ارسال کنید، به سراغ کاربردهای زیر از کتابخانه کلاینت بروید: