An SDK built to facilitate application development for Facebook Ads API using Ruby.
The Facebook Business SDK is a one-stop shop to help our partners better serve their businesses. Partners are using multiple Facebook API's to server the needs of their clients. Adopting all these API's and keeping them up to date across the various platforms can be time consuming and ultimately prohibitive. For this reason Facebook has developed the Business SDK bundling many of its APIs into one SDK to ease implementation and upkeep. The Business SDK is an upgraded version of the Marketing API SDK that includes the Marketing API as well as many Facebook APIs from different platforms such as Pages, Business Manager, Instagram, etc.
Business SDK Getting Started Guide
We developed this SDK using Ruby 2.0, and supports Ruby 2.0+, however, the SDK is not thread-safe at the moment.
To get started with the SDK, you must have an app registered on developers.facebook.com.
To manage the Marketing API, please visit your Access Token Guide to learn more.
For now, we can use the Graph Explorer to get an access token.
The SDK is available as a RubyGem. To use the gem, you can add the following to Gemfile
gem 'facebookbusiness'
or install it using command line
gem install facebookbusiness
and then in your code
require 'facebookbusiness'
There are several ways to configure access token and app secret. If you only use one access token and app secret (example: an internal app managing only your own assets). You can set a global access token and app secret will be used across all requests
FacebookAds.configure do |config| config.access_token = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXX' config.app_secret = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXX' end
Another way is to configure using environment variables, which will be picked up by the SDK as the default
FB_ACCESS_TOKEN=asdsadasds FB_APP_SECRET=asdasdsa
Or you can create a session object for particular object
# Create a Session object to be reused session = FacebookAds::Session.new(access_token: , app_secret: ) ad_account = FacebookAds::AdAccount.get('act_', 'name', session)Or a using shortcut during object instantiation
ad_account = FacebookAds::AdAccount.get('act_', 'name', { access_token: , app_secret: })
The SDK contains ad object files auto generated from our API metadata, each node type has its own corresponding Ruby class under the
FacebookAdsmodule. For example, to fetch an AdAccount
ad_account = FacebookAds::AdAccount.get('act_', 'name') puts "Ad Account Name: #{ad_account.name}"
The
#getmethod doesn't trigger the
GETrequest immediately. The API request for
GETis fired on-demand. In the example above, API request won't fire until
ad_account.nameis executed.
To update a node, you can use the
#savemethod of ad object classes.
ad_account = FacebookAds::AdAccount.get('act_', 'name') ad_account.name = "New Ad Account" ad_account.saveFetch it again
ad_account.reload! ad_account.name => "New Ad Account"
To delete a node, you can use the
#destroymethod.
campaign = FacebookAds::Campaign.get('') campaign.destroy
You can refer to our Marketing API reference or look inside
lib/facebook_ads/ad_objectsdirectory of the code base to see the complete list of available ad objects.
To interact with an edge, you first need to instantiate the parent node. Since, as mentioned above,
GETrequest of a node is triggered on-demand, so you don't need to worry about consuming unnecessary API quota.
Iterating edges is easy, instantiate the parent nodes and then simply iterate with
#each. The edge is an
Enumerableso a bunch of handy methods such as
#map,
#select,
#findetc. come for free!
ad_account = FacebookAds::AdAccount.get('act_', 'name')Printing all campaign names
ad_account.campaigns(fields: 'name').each do |campaign| puts campaign.name end
Getting all campaign names
ad_account.campaigns(fields: 'name').map(&:name)
To
POSTto a edge, you can use the
#createmethod on the edge and supply parameter if needed
campaign = ad_account.campaigns.create({ name: "My First campaign", objective: "CONVERSIONS", })
To
DELETEan edge, you can use the
#destroymethod on the edge and supply parameter if needed
# Deleting an AdImage by its hash ad_account.adimages.destroy({hash: 'abcd1234'})
The SDK supports image/video uploads. Just supply a parameter of
Filetype.
Image upload example:
# AdImage supports multiple images upload ad_account.adimages.create({ 'logo1.png' => File.open('./assets/logo1.jpg'), 'logo2.png' => File.open('./assets/logo2.jpg'), }) => [#<:adimage>"..."}>, #<:adimage>"..."}>]
Video upload example:
ad_account.advideos.create({ name: 'My first video', source: File.open(File.expand_path("../video_ad_example.mp4", __FILE__)) })
Batch API allows you to make API calls in a batch. You can collect a bunch of API requests and fire them all at once to reduce wait time. To create a batch, just wrap operations with a block to
FacebookAds::Batch#with_batch
ad_account = FacebookAds::AdAccount.get('act_')batch = FacebookAds::Batch.with_batch do 10.times.map do |n| ad_account.campaigns.create({ name: 'My Test Campaign #' + n, objective: 'CONVERSIONS', status: 'PAUSED', }) end end
batch.execute
Dependencies between requests is supported, the SDK simplifies the use of JSONPath references between batched operations.
ad_account = FacebookAds::AdAccount.get('act_')batch = FacebookAds::Batch.with_batch do
This won't be sent out immediately!
campaign = ad_account.campaigns.create({ name: 'My Test Campaign', objective: 'CONVERSIONS', status: 'PAUSED', })
Even the request above is not being sent yet, reference to campaign.id still works
ad_accounts.adsets.create({ name: 'My AdSet', campaign_id: campaign.id, # campaign.id here will return {result=create-campaign:$.id} ... ... ... }) end
FacebookAds.configure do |config| # Logger for debugger config.logger = ::Logger.new(STDOUT).tap { |d| d.level = Logger::DEBUG }Log Http request & response to logger
config.log_api_bodies = true end
Our SDK is autogenerated from SDK Codegen. If you want to learn more about how our SDK code is generated, please check this repository.
Please raise any issue on GitHub.
Facebook Business SDK for Ruby is licensed under the LICENSE file in the root directory of this source tree.