پیکربندی کتابخانه کارخواه Python

نصب کتابخانه کارخواه Python

برای نصب کتابخانه کلاینت Python در محیط محلی:

  1. فایل tarball کتابخانه کارخواه Python را استخراج کنید.
  2. فرمان زیر را در همان فهرست راهنما اجرا کنید:

    python -m pip install .
    
  3. برای تکمیل نصب، پیام‌واره‌های موجود در پایانه را دنبال کنید.

پیکربندی بااستفاده از فایل YAML

می‌توانید فایل YAML را برای استفاده هنگام مقداردهی اولیه کارخواه مشخص کنید که حاوی اطلاعات اصالت‌سنجی لازم برای درخواست‌ها است. وقتی کارخواه بااستفاده از روش load_from_file مقداردهی اولیه می‌شود، به این فایل دسترسی پیدا می‌شود. هنگام ایجاد فایل YAML، از نمونه ارائه‌شده در زیر پیروی کنید تا ژتون بازآوری، شناسه کارخواه، و رمز کارخواه را مشخص کنید.

برای مشخص کردن مکانی که فایل search-ads-360.yaml در آن قرار دارد، می‌توانید مسیر را به‌عنوان رشته‌ای به روش ارسال کنید وقتی‌که آن را فراخوانی می‌کنید:

from util_searchads360 import SearchAds360Client
client = SearchAds360Client.load_from_file("path/to/search-ads-360.yaml")

اگر مسیری ارائه نکنید، کتابخانه در پوشه $HOME شما به‌دنبال فایل می‌گردد:

from util_searchads360 import SearchAds360Client
client = SearchAds360Client.load_from_file()

فیلدهای پیکربندی

پیکربندی کتابخانه کارخواه از فیلدهای زیر پشتیبانی می‌کند.

فیلدهای عمومی:

  • refresh_token: ژتون بازآوری OAuth شما.
  • client_id: شناسه کارخواه OAuth شما.
  • client_secret: رمز کارخواه OAuth شما.
  • ‫login_customer_id: اسناد login-customer-id را ببینید.

کلیدهای پشتیبانی‌شده برای جریان‌های برنامه وب و رایانه

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

# Credential for accessing Google's OAuth servers.
# Provided by console.cloud.google.com.
client_id: INSERT_CLIENT_ID_HERE

# Credential for accessing Google's OAuth servers.
# Provided by console.cloud.google.com.
client_secret: INSERT_CLIENT_SECRET_HERE

# Renewable OAuth credential associated with 1 or more Search Ads accounts.
refresh_token: INSERT_REFRESH_TOKEN_HERE

# Required for manager accounts only: Specify the login customer ID used to
# authenticate API calls. This will be the customer ID of the authenticated
# manager account. You can also specify this later in code if your application
# uses multiple manager account + OAuth pairs.
#
# login_customer_id: INSERT_LOGIN_CUSTOMER_ID_HERE