Клиентская библиотека Python размещена на GitHub , а пакет доступен на PyPI .
Требования
Для работы библиотеки требуется Python 3.8 или более поздняя версия.
Предпосылки
Перед установкой библиотеки вам потребуется токен разработчика и идентификатор клиента. Инструкции по их получению приведены в разделе «Предварительные требования» . Обратите внимание, что остальные необходимые токены OAuth2 будут сгенерированы на последующих этапах.
Совместимость времени выполнения и зависимостей
Клиентская библиотека Python поддерживает совместимость со средами выполнения Python, указанными в разделе « Поддерживаемые версии» , опубликованном Python Software Foundation , за исключением версий со статусом «feature» или «prerelease».
При внедрении новых версий среды выполнения Python мы стремимся выпустить новую версию клиентской библиотеки Python, совместимую с последней версией среды выполнения, к концу квартала, следующего за её выпуском. Например, если новая среда выполнения будет выпущена в октябре, совместимая версия клиентской библиотеки Python будет доступна к концу марта следующего года.
Среды выполнения Python, срок поддержки которых подошел к концу (EOL), не поддерживаются после даты окончания поддержки, указанной в разделе «Неподдерживаемые версии» на сайте python.org .
Мы можем выпустить версию клиентской библиотеки Python, несовместимую с неподдерживаемыми средами выполнения Python, в любой момент после окончания срока их поддержки.
Для зависимостей (в частности, любых поддерживаемых Google пакетов, которые перечислены как требуемые клиентской библиотекой Python) мы будем поддерживать совместимость с пакетами, которые поддерживаются Google и считаются «поддерживаемыми» в соответствии с Политикой Google по внесению критических изменений в программное обеспечение с открытым исходным кодом .
Полный список поддерживаемых сред выполнения Python и зависимостей см. на странице Зависимости .
Установка
Следуйте инструкциям в нашей документации по установке , чтобы установить библиотеку из PyPi и вернуться на эту страницу.
Конфигурация
После установки библиотеки вам потребуется настроить её конфигурацию. Существует несколько способов настройки библиотеки, которые описаны в нашей документации по настройке .
Аутентификация
Выбрав тип конфигурации, вы можете приступить к генерации оставшихся токенов OAuth2, необходимых для выполнения запросов к API. Поддерживается несколько потоков OAuth2, список которых представлен ниже. Подробную информацию о различиях между потоками и помощь в выборе оптимального для вашего приложения см. в нашей документации по OAuth .
Выполнение API-запроса
После включения токенов OAuth2 в конфигурацию вы готовы к выполнению запросов к API. Пример получения кампаний — это простой способ проверить, правильно ли настроена библиотека для выполнения запросов к API.
Чтобы запустить пример get_campaigns.py , в корневом каталоге локально установленной клиентской библиотеки googleads-python выполните следующую команду:
$ python examples/basic_operations/get_campaigns.py -c \
INSERT_YOUR_CUSTOMER_ID_HERE
Дополнительные ресурсы
После того как вы сможете сделать запрос к API, приступайте к следующим вариантам использования клиентской библиотеки: