This Source is capable of syncing the following core Streams:
The linked Facebook docs go into detail about the fields present on those streams.
In addition, this source is capable of syncing ad insights as a stream. Ad insights can also be segmented by the following categories, where each segment is synced as a separate Airbyte stream:
DMA (Designated Market Area)
Gender & Age
Platform & Device
The segmented streams contain entries of campaign/adset/ad combinations for each day broken down by the chosen segment.
For more information, see the Facebook Insights API documentation.
Full Refresh Sync
See Facebook's documentation on rate limiting for more information on requesting a quota upgrade.
A Facebook Ad Account ID
A Facebook App which has the Marketing API enabled
A Facebook Marketing API Access Token
Request a rate limit increase from Facebook
Follow the Facebook documentation for obtaining your Ad Account ID and keep that on hand. We'll need this ID to configure Facebook as a source in Airbyte.
Visit the Facebook Developers App hub and create an App and choose "Manage Business Integrations" as the purpose of the app. Fill out the remaining fields to create your app, then follow along the "Enable the Marketing API for your app" section.
From the App's Dashboard screen (seen in the screenshot below) enable the Marketing API for your app if it is not already setup.
In the App Dashboard screen, click Marketing API --> Tools on the left sidebar. Then highlight all the available token permissions (
read_insights) and click "Get token". A long string of characters should appear in front of you; this is the access token. Copy this string for use in the Airbyte UI later.
Facebook heavily throttles API tokens generated from Facebook Apps with the "Standard Access" tier (the default tier for new apps), making it infeasible to use the token for syncs with Airbyte. You'll need to request an upgrade to Advanced Access for your app on the following permissions:
Ads Management Standard Access
See the Facebook documentation on Authorization for information about how to request Advanced Access to the relevant permissions.
With the Ad Account ID and API access token, you should be ready to start pulling data from the Facebook Marketing API. Head to the Airbyte UI to setup your source connector!
Refactor connector to use CDK:
- Improve error handling.
- Improve async job performance (insights).
- Add new configuration parameter
Update version of facebook_bussiness to 11.0
Add 80000 as a rate-limiting error code
Add missing fields to AdInsights streams
Fix handling call rate limit
Allow configuring insights lookback window
Fix an issue that caused losing Insights data from the past 28 days while incremental sync
Wait longer (5 min) for async jobs to start
Fix base connector versioning
Support FB Marketing API v10
Protocol allows future/unknown properties
Support Insights stream via async queries
Add incremental support
Release Native Facebook Marketing Connector