twitter python ads sdk

Начиная

Установка

 # installing the latest signed release
pip install twitter-ads

Быстрый старт

 from twitter_ads . client import Client
from twitter_ads . campaign import Campaign
from twitter_ads . enum import ENTITY_STATUS

CONSUMER_KEY = 'your consumer key'
CONSUMER_SECRET = 'your consumer secret'
ACCESS_TOKEN = 'access token'
ACCESS_TOKEN_SECRET = 'access token secret'
ACCOUNT_ID = 'account id'

# initialize the client
client = Client (
    CONSUMER_KEY , CONSUMER_SECRET , ACCESS_TOKEN , ACCESS_TOKEN_SECRET )

# load the advertiser account instance
account = client . accounts ( ACCOUNT_ID )

# load and update a specific campaign
campaign = account . campaigns (). next ()
campaign . name = 'updated campaign name'
campaign . entity_status = ENTITY_STATUS . PAUSED
campaign . save ()

# iterate through campaigns
for campaign in account . campaigns ():
    print ( campaign . id )

Помощник командной строки

 # The twitter-ads command launches an interactive session for testing purposes
# with a client instance automatically loaded from your .twurlrc file.

~ ❯ twitter-ads

Для получения дополнительной помощи ознакомьтесь с нашими примерами и руководствами или ознакомьтесь с онлайн-справочной документацией.

Обработка ограничения скорости и параметры запроса

 client = Client (
    CONSUMER_KEY ,
    CONSUMER_SECRET ,
    ACCESS_TOKEN ,
    ACCESS_TOKEN_SECRET ,
    options = {
        'handle_rate_limit' : True ,
        'retry_max' : 3 ,
        'retry_delay' : 5000 ,
        'retry_on_status' : [ 404 , 500 , 503 ],
        'retry_on_timeouts' : True ,
        'timeout' : ( 1.0 , 3.0 )
    })

Параметр	По умолчанию	Описание
handle_rate_limit	False (логическое значение)	Если задано значение True будет проверяться заголовок ответа на ограничение скорости и переходить в режим сна, если запрос достиг предела (429).
retry_max	0 (целое)	Сколько раз вы хотите повторить попытку, если код ответа найден в retry_on_status .
retry_delay	1500 (интервал)	Количество миллисекунд, в течение которых вы хотите спать перед повторной попыткой.
retry_on_status	[500, 503] (список)	Коды ответов, которые вы хотите повторить. Вы можете установить только >= 400 кодов состояния.
retry_on_timeouts	False (логическое значение)	Установите True чтобы обнаружить ошибку тайм-аута и повторить запрос.
timeout	None	Вы можете указать либо одно значение, либо кортеж. Если указано одно значение, значение таймаута будет применяться как к таймаутам connect , так и к таймаутам read . См. https://2.python-requests.org/en/master/user/advanced/#timeouts для получения более подробной информации об использовании.

Совместимость и управление версиями

Этот проект предназначен для работы с Python 3.5 или более поздней версии. Хотя он может работать и на других версиях Python, ниже приведены версии платформы и среды выполнения, которые мы официально поддерживаем и регулярно тестируем.

Платформа	Версии
CPython	3,5, 3,6, 3,7
PyPy	7.х

Все выпуски придерживаются строгого семантического версионирования. Например, major.minor.patch-pre (он же Stick.carrot.oops-peek).

Разработка

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

 # clone the repository
git clone [email protected]:twitterdev/twitter-python-ads-sdk.git
cd twitter-python-ads-sdk

# install dependencies
pip install -r requirements.txt

# installing a local unsigned release
pip install -e .

Мы любим вклад сообщества! Если вы планируете отправить нам запрос на включение, сначала обязательно прочтите наши Правила участия.

Отзывы и отчеты об ошибках

Нашли проблему? Пожалуйста, откройте проблему на GitHub или, что еще лучше, отправьте нам запрос на включение. Есть вопросы? Хотите обсудить новую функцию? Пообщайтесь с нами на форумах сообщества Twitter.

Обработка ошибок

Как и классы Response и Request, Ads API SDK полностью моделирует все объекты ошибок, что упрощает их обработку.

Лицензия

Лицензия MIT (MIT)

Авторские права (C) 2015 Twitter, Inc.

Настоящим бесплатно любому лицу, получившему копию этого программного обеспечения и связанных с ним файлов документации («Программное обеспечение»), предоставляется разрешение на работу с Программным обеспечением без ограничений, включая, помимо прочего, права на использование, копирование, изменение, объединение. публиковать, распространять, сублицензировать и/или продавать копии Программного обеспечения, а также разрешать лицам, которым предоставлено Программное обеспечение, делать это при соблюдении следующих условий:

Вышеупомянутое уведомление об авторских правах и данное уведомление о разрешении должны быть включены во все копии или существенные части Программного обеспечения.

ПРОГРАММНОЕ ОБЕСПЕЧЕНИЕ ПРЕДОСТАВЛЯЕТСЯ «КАК ЕСТЬ», БЕЗ КАКИХ-ЛИБО ГАРАНТИЙ, ЯВНЫХ ИЛИ ПОДРАЗУМЕВАЕМЫХ, ВКЛЮЧАЯ, НО НЕ ОГРАНИЧИВАЯСЬ, ГАРАНТИЯМИ ТОВАРНОЙ ЦЕННОСТИ, ПРИГОДНОСТИ ДЛЯ ОПРЕДЕЛЕННОЙ ЦЕЛИ И НЕНАРУШЕНИЯ ПРАВ. НИ ПРИ КАКИХ ОБСТОЯТЕЛЬСТВАХ АВТОРЫ ИЛИ ОБЛАДАТЕЛИ АВТОРСКИХ ПРАВ НЕ НЕСУТ ОТВЕТСТВЕННОСТИ ЗА ЛЮБЫЕ ПРЕТЕНЗИИ, УБЫТКИ ИЛИ ДРУГУЮ ОТВЕТСТВЕННОСТЬ, БУДЬ В ДЕЙСТВИЯХ ПО КОНТРАКТУ, ПРАВОНАРУШЕНИЮ ИЛИ ДРУГИМ ОБРАЗОМ, ВОЗНИКАЮЩИЕ ОТ, ИЗ ИЛИ В СВЯЗИ С ПРОГРАММНЫМ ОБЕСПЕЧЕНИЕМ ИЛИ ИСПОЛЬЗОВАНИЕМ ИЛИ ДРУГИМИ СДЕЛКАМИ, ПРОГРАММНОЕ ОБЕСПЕЧЕНИЕ.