Конфигурация клиентской библиотеки Python

Как установить клиентскую библиотеку Python

Чтобы установить клиентскую библиотеку Python в локальной среде, выполните следующие действия:

  1. Распакуйте tar-архив клиентской библиотеки 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