Facebook is one of the most efficient ways to advertise online. Take your company’s analysis to the next level by adding Facebook Ads as a Source to Segment.
This is an Object Cloud Source which can export data from its third party tool and import it directly into your Segment warehouse.
This document was last updated on July 6, 2018. If you notice any gaps, outdated information or simply want to leave some feedback to help us improve our documentation, please let us know!
From your workspace’s
Choose Facebook Ads.
Give the source a nickname. The nickname will be used to designate the source in the Segment interface, and Segment will create a related schema name. The schema name is the namespace you’ll be querying against in your warehouse. The nickname can be whatever you like, but we recommend sticking to something that reflects the source itself, like
Facebook Ads Prod.
Click Create And Continue then Connect to OAuth into Facebook.
Select which accounts you would like to sync (you may change this selection later).
If your Facebook user has read permissions to Facebook Ads account’s data, you should be able to use your account for the Source.
Facebook Ads has a sync component, which means we’ll make requests to their API on your behalf on a 3 hour interval to pull the latest data into Segment. In the initial sync, we’ll grab all the Facebook objects (and their corresponding properties) according to the Collections table below. The objects will be written into a separate schema, corresponding to the source instance’s schema name you designated upon creation. For example, if you went with
ads collection will be accessible at
fb_ads.ads in SQL.
Our sync component uses an upsert API, so the data in your warehouse loaded via sync will reflect the latest state of the corresponding resource in Facebook Ads. For example, if
100 between syncs, on its next sync that tickets status will be
The source syncs and warehouse syncs are independent processes. Source runs pull your data into the Segment Hub, and warehouse runs flush that data to your warehouse. Sources will sync with Segment every 3 hours. Depending on your Warehouses plan, we will push the Source data to your warehouse on the interval associated with your billing plan.
Collections are the groupings of resources we pull from your source. In your warehouse, each collection gets its own table.
|ad_accounts||object||An ad account is an account used to manage ads on Facebook|
|ad_sets||object||An ad set is a group of ads that share the same daily or lifetime budget, schedule, bid type, bid info, and targeting data|
|ads||object||An ad object contains the data necessary to visually display an ad and associate it with a corresponding ad set.|
|campaigns||object||A campaign is a grouping of ad sets which are organized by the same business objective.|
|insights||object||Insights contain performance statistics for an ad broken down by day.|
Below are tables outlining the properties included in the collections listed above.
|id||Ad Account ID.|
|balance||Bill amount due.|
|name||Name of the account. If the account name is not set, the name of the first admin visible to the user will be returned.|
|partner_id||The ID of a Facebook Page or Facebook App.|
|spend_cap||The maximum that can be spent by this account after which campaigns will be paused. A value of 0 signifies no spending-cap and setting a new spend cap only applies to spend AFTER the time at which you set it. Value specified in basic unit of the currency, e.g. cents for USD.|
|id||Ad set ID.|
|account_id||Ad Account ID.|
|configured_status||The status set at the ad set level. It can be different from the effective status due to its parent campaign.|
|daily_budget||The daily budget of the set defined in your account currency.|
|effective_status||The effective status of the ad set, which can be either its own status or caused by its parent campaign.|
|end_time||End time, in UTC UNIX timestamp.|
|name||Name of ad set.|
|id||The ID of this ad.|
|adset_id||ID of the ad set that contains the ad.|
|account_id||The ID of the ad account that this ad belongs to.|
|bid_amount||Bid amount for this ad which will be used in auction instead of the ad set bid_amount, if specified.|
|campaign_id||ID of the ad campaign that contains this ad.|
|name||Name of the ad.|
|status||The configured status of the ad.|
|account_id||ID of the ad account that owns this campaign.|
|effective_status||The effective status of this campaign.|
|spend_cap||A spend cap for the campaign, such that it will not spend more than this cap. Expressed as integer value of the subunit in your currency.|
|id||Segment internal ID.|
|ad_id||The unique ID of the ad you’re viewing in reporting.|
|clicks||The number of clicks on your ads.|
|date_start||The start date for your data.|
|date_stop||The end date for your data.|
|Deprecated by Facebook. Aliased to |
|Deprecated by Facebook. Aliased to |
|frequency||The average number of times each person saw your ad.|
|impressions||The number of times your ads were on screen.|
|inline_post_engagements||The total number of actions that people take involving your ads.|
|Deprecated by Facebook. The number of clicks (all) when your ad was displayed with social information.|
|Deprecated by Facebook. The number of times your ads were viewed when displayed with social information.|
|social_spend||The total amount you’ve spent so far for your ads showed with social information.|
|spend||The estimated total amount of money you’ve spent on your campaign, ad set or ad during its schedule.|
|unique_clicks||The number of people who performed a click (all). This metric is estimated.|
|unique_impressions||Deprecated in favor of |
|Deprecated by Facebook. The number of people who performed a click (all) on your ad when it was displayed with social information.|
|reach||The number of people who saw your ads at least once. Reach is different from impressions, which may include multiple views of your ads by the same people.|
|Deprecated by Facebook. The number of times people clicked the call-to-action button on your ad.|
Currently, Warehouses are the only supported destination for object-cloud sources.