Обзор

Клиентская библиотека Python размещена на GitHub , а пакет доступен на PyPI .

Требования

Для библиотеки требуется Python 3.8 или новее.

Предварительные условия

Перед установкой библиотеки вам понадобится токен разработчика и идентификатор клиента клиента. Инструкции о том, как их получить, изложены в разделе «Предварительные условия» . Обратите внимание, что другие необходимые токены OAuth2 вы создадите на последующих шагах.

Совместимость среды выполнения и зависимостей

Клиентская библиотека Python поддерживает совместимость со средами выполнения Python в разделе « Поддерживаемые версии» , опубликованном Python Software Foundation , за исключением версий со статусом «функция» или «предварительная версия».

При внедрении новых версий среды выполнения Python мы стремимся выпустить новую версию клиентской библиотеки Python, совместимую с последней версией среды выполнения, к концу квартала, следующего за ее выпуском. Например, если в октябре будет выпущена новая среда выполнения, совместимая версия клиентской библиотеки Python будет доступна к концу марта следующего года.

Среды выполнения Python, срок эксплуатации которых истек (EOL), не поддерживаются после даты окончания срока действия, указанной в разделе «Неподдерживаемые версии» на сайте python.org .

Мы можем выпустить версию клиентской библиотеки Python, несовместимую с неподдерживаемыми средами выполнения Python, в любой момент после их завершения.

Для зависимостей (в частности, любых пакетов, поддерживаемых Google, которые перечислены как требуемые клиентской библиотекой Python), мы будем поддерживать совместимость с пакетами, которые поддерживаются Google и считаются «поддерживаемыми» в соответствии с Политикой критических изменений OSS 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, перейдите к следующему использованию клиентской библиотеки: