نصب

چه کتابخانه را از 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