نصب

چه کتابخانه را از PyPI نصب کنید یا آن را از GitHub شبیه‌سازی کنید، مراحل زیر را بااستفاده از محیط مجازی فعال انجام دهید. برای کسب اطلاعات درباره نحوه ایجاد و فعال کردن محیط مجازی، به سند محیط مجازی مراجعه کنید.

برای ایجاد و فعال‌سازی سریع محیط مجازی:

python3 -m venv env
source env/bin/activate

نصب کردن واحد از PyPI

این کتابخانه در PyPI توزیع شده است و می‌توان آن را بااستفاده از pip با فرمان زیر نصب کرد:

python -m pip install google-ads

درستی‌سنجی نصب

بررسی کنید که ماژول به‌درستی نصب شده باشد:

python -c "import google.ads.googleads"

نصب کتابخانه از GitHub

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

1. مطمئن شوید که نسخه پشتیبانی‌شده Python (Python 3.9 تا 3.14؛ Python 3.11 یا جدیدتر توصیه می‌شود) در محیط شما وجود دارد. ساده‌ترین راه استفاده از pyenv است:

   pyenv install 3.13
   pyenv local 3.13

2. کتابخانه مشتری را از GitHub شبیه‌سازی کنید:

   git clone https://github.com/googleads/google-ads-python.git

3. وارد مخزن شوید و آن را در حالت قابل‌ویرایش نصب کنید:

   cd google-ads-python
   python -m pip install -e .

4. اگر قصد دارید کتابخانه را توسعه دهید، قبل و بعداز ایجاد هرگونه تغییر، آزمایش‌های واحد را اجرا کنید:

   1. مطمئن شوید همه نسخه‌های پشتیبانی‌شده زبان Python را بااستفاده از pyenv در محیط خود دردسترس دارید:

      pyenv local 3.9 3.10 3.11 3.12 3.13 3.14

   2. وابستگی‌های مختص آزمایش کتابخانه را نصب کنید:

      python -m pip install -e ".[tests]"

   3. آزمایش‌های واحد را اجرا کنید تا مطمئن شوید کتابخانه به‌درستی کار می‌کند:

      nox

   4. اختیاری: همچنین می‌توانید آزمایش‌های واحد را بااستفاده از Docker اجرا کنید. ابتدا مطمئن شوید Docker را نصب کرده‌اید. سپس، از فهرست راهنمای google-ads-python، فرمان‌های زیر را اجرا کنید:

      docker build -t google-ads-python:test .
      docker run -it google-ads-python:test nox