Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/xdevplatform/twitter-ruby-ads-sdk

A Twitter supported and maintained Ads API SDK for Ruby.
https://github.com/xdevplatform/twitter-ruby-ads-sdk

ruby sdk twitter twitter-ads twitter-api

Last synced: about 5 hours ago
JSON representation

A Twitter supported and maintained Ads API SDK for Ruby.

Host: GitHub
URL: https://github.com/xdevplatform/twitter-ruby-ads-sdk
Owner: xdevplatform
License: mit
Created: 2015-08-07T19:03:02.000Z (about 9 years ago)
Default Branch: master
Last Pushed: 2024-03-09T00:18:04.000Z (8 months ago)
Last Synced: 2024-04-20T22:07:28.313Z (7 months ago)
Topics: ruby, sdk, twitter, twitter-ads, twitter-api
Language: Ruby
Homepage: https://twitterdev.github.io/twitter-ruby-ads-sdk/
Size: 1.41 MB
Stars: 65
Watchers: 34
Forks: 72
Open Issues: 13
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

Getting Started [![Build Status](https://travis-ci.org/twitterdev/twitter-ruby-ads-sdk.svg?branch=master)](https://travis-ci.org/twitterdev/twitter-ruby-ads-sdk)[![Gem Version](https://badge.fury.io/rb/twitter-ads.svg)](http://badge.fury.io/rb/twitter-ads)
------

##### Installation
```bash
# installing the latest signed release
gem install twitter-ads
```

##### Quick Start
```ruby
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
```

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

~ ❯ twitter-ads
twitter-ads vX.X.X >> CLIENT
=> #
twitter-ads vX.X.X >> CLIENT.accounts.first
=> #
```
For more help please see our [Examples and Guides](https://github.com/twitterdev/twitter-ruby-ads-sdk/tree/master/examples) or check the online [Reference Documentation](http://twitterdev.github.io/twitter-ruby-ads-sdk/reference/index.html).

## Compatibility & Versioning

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.

Platform | Versions
-------- | --------
MRI | 2.4.x, 2.5.x, 2.6.x, 2.7, 3.0
Rubinius | 2.4.x, 2.5.x

All releases adhere to strict [semantic versioning](http://semver.org). For Example, major.minor.patch-pre (aka. stick.carrot.oops-peek).

## Development
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.
```bash
# clone the repository
git clone [email protected]: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](https://github.com/twitterdev/twitter-ruby-ads-sdk/blob/master/CONTRIBUTING.md) first.

## Feedback and Bug Reports
Found an issue? Please open up a [GitHub issue](https://github.com/twitterdev/twitter-ruby-ads-sdk/issues) or even better yet [send us](https://github.com/twitterdev/twitter-ruby-ads-sdk/blob/master/CONTRIBUTING.md) a pull request.

Have a question? Want to discuss a new feature? Come chat with us in the [Twitter Community Forums](https://twittercommunity.com/c/advertiser-api).

## Error Handling

Like the [Response](https://github.com/twitterdev/twitter-ruby-ads-sdk/blob/master/lib/twitter-ads/http/response.rb) and [Request](https://github.com/twitterdev/twitter-ruby-ads-sdk/blob/master/lib/twitter-ads/http/request.rb) classes, the Ads API SDK fully models all [error objects](https://github.com/twitterdev/twitter-ruby-ads-sdk/blob/master/lib/twitter-ads/error.rb) for easy error handling.

Error Hierarchy

## License

The MIT License (MIT)

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.