0.0
No commit activity in last 3 years
No release in over 3 years
Broadstreet API Wrapper
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Runtime

 Project Readme

broadstreet-ruby

This is a Ruby wrapper for the Broadstreet V1 API. It provides convenient access to methods that allow the creation of networks, advertisers, zones, etc.

Installation

This gem is available via RubyGems, so a simple:

$ gem install broadstreet

will get you going (or gem 'broadstreet' if you're using a Gemfile).

Usage

First, grab a Broadstreet::Client object, and give it an API key:

client = Broadstreet::Client.new 'd41d8cd98f00b204e9800998ecf8427e'

Then you're good to go! The objects returned to you are Hashie::Mash, so they're easy to work with in dot notation like so:

# List all networks available to the authenticating user
client.list_networks.each do |network|
  puts network.name
end

Now What?

Now that you're set up to make calls, take a look around the documentation which lists all of the methods and options available:

http://rubydoc.info/github/broadstreetads/broadstreet-ruby

Issues?

Want a new endpoint, or some more detail? Will do!

Use the GitHub issue tracker!

License

See LICENSE