twitter python ads sdk

Começando

Instalação

 # installing the latest signed release
pip install twitter-ads

Início rápido

 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 )

Auxiliar de linha de comando

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

~ ❯ twitter-ads

Para obter mais ajuda, consulte nossos Exemplos e Guias ou verifique a Documentação de Referência on-line.

Tratamento de limite de taxa e opções de solicitação

 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 )
    })

Parâmetro	Padrão	Descrição
handle_rate_limit	False (booleano)	Set True verificará o cabeçalho de resposta de limite de taxa e dormirá se a solicitação atingir o limite (429).
retry_max	0 (int)	O número de vezes que você deseja tentar novamente quando o código de resposta for encontrado em retry_on_status .
retry_delay	1500 (int)	O número de milissegundos que você deseja dormir antes de tentar novamente.
retry_on_status	[500, 503] (lista)	Os códigos de resposta que você deseja tentar novamente. Você só pode definir >= 400 códigos de status.
retry_on_timeouts	False (booleano)	Set True detectará o erro de tempo limite e tentará novamente a solicitação.
timeout	None	Você pode especificar um único valor OU uma tupla. Se um único valor for especificado, o valor de tempo limite será aplicado aos tempos limites connect e read . Consulte https://2.python-requests.org/en/master/user/advanced/#timeouts para obter mais detalhes sobre o uso.

Compatibilidade e controle de versão

Este projeto foi projetado para funcionar com Python 3.5 ou superior. Embora possa funcionar em outras versões do Python, abaixo estão as versões de plataforma e de tempo de execução que oferecemos suporte oficial e que testamos regularmente.

Plataforma	Versões
CPython	3,5, 3,6, 3,7
PyPy	7.x

Todas as versões aderem a um controle de versão semântico rigoroso. Por exemplo, major.minor.patch-pre (também conhecido como stick.carrot.oops-peek).

Desenvolvimento

Se quiser contribuir com o projeto ou experimentar uma versão de desenvolvimento não lançada deste projeto localmente, você pode fazer isso facilmente seguindo os exemplos abaixo.

 # 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 .

Adoramos contribuições da comunidade! Se você está planejando nos enviar uma solicitação pull, leia primeiro nossas Diretrizes de Contribuição.

Feedback e relatórios de bugs

Encontrou um problema? Abra um problema no GitHub ou, melhor ainda, envie-nos uma solicitação pull. Tem alguma pergunta? Quer discutir um novo recurso? Venha conversar conosco nos Fóruns da Comunidade do Twitter.

Tratamento de erros

Assim como as classes Response e Request, o Ads API SDK modela totalmente todos os objetos de erro para facilitar o tratamento de erros.

Licença

A Licença MIT (MIT)

Direitos autorais (C) 2015 Twitter, Inc.

É concedida permissão, gratuitamente, a qualquer pessoa que obtenha uma cópia deste software e dos arquivos de documentação associados (o "Software"), para negociar o Software sem restrições, incluindo, sem limitação, os direitos de usar, copiar, modificar, mesclar , publicar, distribuir, sublicenciar e/ou vender cópias do Software e permitir que as pessoas a quem o Software seja fornecido o façam, sujeito às seguintes condições:

O aviso de direitos autorais acima e este aviso de permissão serão incluídos em todas as cópias ou partes substanciais do Software.

O SOFTWARE É FORNECIDO "COMO ESTÁ", SEM GARANTIA DE QUALQUER TIPO, EXPRESSA OU IMPLÍCITA, INCLUINDO, MAS NÃO SE LIMITANDO ÀS GARANTIAS DE COMERCIALIZAÇÃO, ADEQUAÇÃO A UM DETERMINADO FIM E NÃO VIOLAÇÃO. EM NENHUM CASO OS AUTORES OU DETENTORES DE DIREITOS AUTORAIS SERÃO RESPONSÁVEIS POR QUALQUER RECLAMAÇÃO, DANOS OU OUTRA RESPONSABILIDADE, SEJA EM UMA AÇÃO DE CONTRATO, ATO ILÍCITO OU DE OUTRA FORMA, DECORRENTE DE, OU EM CONEXÃO COM O SOFTWARE OU O USO OU OUTRAS NEGOCIAÇÕES NO SOFTWARE.