# installing the latest signed release gem install twitter-ads
require 'twitter-ads' # initialize the client client = TwitterAds::Client.new( CONSUMER_KEY, CONSUMER_SECRET, ACCESS_TOKEN, ACCESS_TOKEN_SECRET ) # load the advertiser account instance account = client.accounts('c3won9gy') # load and update a specific campaign campaign = account.campaigns('4m0gjms') campaign.entity_status = EntityStatus::PAUSED campaign.save # iterate through campaigns account.campaigns.each do |camp| # do stuff end
# The twitter-ads command launches an interactive session for testing purposes # with a client instance automatically loaded from your .twurlrc file. ~ ❯ twitter-ads 2.0.0 (twitter-ads):0 > CLIENT => #<TwitterAds::Client:0x70101526238580 consumer_key="Fy90KQy57152sn5Mv7axji9409"> 2.0.0 (twitter-ads):0 > CLIENT.accounts.first => #<TwitterAds::Account:0x70101527905720 id="4lvtcum">
This project is designed to work with Ruby 2.4.0 or greater. While it may work on other version of Ruby, below are the platform and runtime versions we officially support and regularly test against.
|CRuby||2.4.x, 2.5.x, 2.6.x|
All releases adhere to strict semantic versioning. For Example, major.minor.patch-pre (aka. stick.carrot.oops-peek).
If you'd like to contribute to the project or try an unreleased development version of this project locally, you can do so quite easily by following the examples below.
# clone the repository git clone firstname.lastname@example.org:twitterdev/twitter-ruby-ads-sdk.git cd twitter-ruby-ads-sdk # install dependencies bundle install rake docs # building documentation rake spec # run all tests # installing a local unsigned release gem build twitter-ads.gemspec & gem install twitter-ads-X.X.X.gem
We love community contributions! If you're planning to send us a pull request, please make sure read our Contributing Guidelines first.
Have a question? Want to discuss a new feature?
Come chat with us in the Twitter Community Forums.
The MIT License (MIT)
Copyright (C) 2019 Twitter, Inc.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.