نمای کلی

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

الزامات

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

پیش نیازها

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

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

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

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

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

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

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

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

نصب و راه اندازی

دستورالعمل های موجود در اسناد نصب ما را دنبال کنید تا کتابخانه را از PyPi نصب کنید و به این صفحه بازگردید.

پیکربندی

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

احراز هویت

هنگامی که یک نوع پیکربندی را انتخاب کردید، می‌توانید با تولید توکن‌های OAuth2 باقی‌مانده مورد نیاز برای درخواست به API ادامه دهید. چندین جریان OAuth2 پشتیبانی شده وجود دارد که در لیست زیر مستند شده است. برای جزئیات بیشتر در مورد تفاوت‌های بین جریان‌ها و کمک به تصمیم‌گیری بهترین گزینه برای برنامه شما، به مستندات OAuth ما مراجعه کنید.

ایجاد درخواست API

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

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

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

منابع اضافی

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