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

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

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

  1. فایل tarball کتابخانه کلاینت پایتون را از حالت فشرده خارج کنید.
  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