Facebook Ads
Features | Details |
Release Status | Released |
Source API Version | v3.3 |
Table Selection | Yes |
Column Selection | Yes |
Edit Integration | Yes |
Replication Type Selection | No |
Authentication Parameters | Facebook Ads account email Facebook Ads account password |
Replication Type: Key Based Incremental | Replication Key: Date |
Suggested Replication Frequency: 24 hrs | ​ |
Tables/APIs Supported | ​ |
Insights | Ads |
Campaigns | AdCreatives |
AdInsightsBreakdownCountry | AdInsightsBreakdownRegion |
AdInsightsBreakdownGender | AdInsightsBreakdownDevicePlatform |
Signin to Daton
Select Facebook Ads from Integrations page
Provide Integration Name, Replication Frequency, and History. Integration name would be used in creating tables for the integration and cannot be changed later
You will be redirected to Facebook Ads login for authorizing Daton to extract data periodically
Post successful authentication, you will be prompted to choose from the list of available Facebook Ad accounts
Select required tables from the available list of tables
Then select all required fields for each table
Submit the integration
Integrations would be in Pending state initially and will be moved to Active state as soon as the first job loads data successfully on to the configured warehouse
Users would be able to edit/pause/re-activate/delete integration anytime
Users can view job status and process logs from the integration details page by clicking on the integration name from the active list
Insights
Purpose: Provides interface to retrive data related to ads.
Source API Documentation https://developers.facebook.com/docs/marketing-api/reference/adgroup/insights/v3.3​
Replication: Key-Based Replication
Replication Key: lastRunDate
Fields
Name | Target Datatype |
account_currency | STRING |
account_id | STRING |
account_name | STRING |
action_values | RECORD |
ad_id | STRING |
ad_name | STRING |
adset_id | STRING |
adset_name | STRING |
buying_type | STRING |
campaign_id | STRING |
campaign_name | STRING |
canvas_avg_view_percent | NUMERIC |
clicks | NUMERIC |
cost_per_estimated_ad_recallers | NUMERIC |
cost_per_inline_link_click | NUMERIC |
cost_per_inline_post_engagement | NUMERIC |
cost_per_unique_click | NUMERIC |
cost_per_unique_inline_link_click | NUMERIC |
cpc | NUMERIC |
cpm | NUMERIC |
cpp | NUMERIC |
ctr | NUMERIC |
date_start | STRING |
date_stop | STRING |
estimated_ad_recall_rate | NUMERIC |
estimated_ad_recallers | NUMERIC |
frequency | NUMERIC |
impressions | NUMERIC |
inline_link_clicks | NUMERIC |
inline_post_engagement | NUMERIC |
objective | STRING |
reach | NUMERIC |
social_spend | NUMERIC |
spend | NUMERIC |
unique_clicks | NUMERIC |
unique_ctr | NUMERIC |
unique_inline_link_click_ctr | NUMERIC |
unique_inline_link_clicks | NUMERIC |
website_ctr | RECORD |
Ads
Purpose: Ads object has the necessary data of each ad. Each Ad is linked with an corresponding adset.
Source API Documentation https://developers.facebook.com/docs/marketing-api/reference/adgroup​
Replication: Key-Based Replication
Replication Key: lastRunRecordDate
Fields
Name | Target Datatype |
id | STRING |
account_id | STRING |
adlabels | RECORD |
adset_id | STRING |
bid_amount | NUMERIC |
campaign_id | STRING |
configured_status | STRING |
created_time | STRING |
name | STRING |
source_ad_id | STRING |
status | STRING |
creative | RECORD |
Campaigns
Purpose: A campaign is a grouping of ad sets which are organized by the same business objective. Each campaign has an objective that must be valid across the ad sets within that campaign.
Source API Documentation https://developers.facebook.com/docs/marketing-api/reference/ad-campaign-group​
Replication: Key-Based Replication
Replication Key: lastRunRecordDate
Fields
Name | Target Datatype |
id | STRING |
account_id | STRING |
adlabels | RECORD |
name | STRING |
objective | STRING |
effective_status | STRING |
buying_type | STRING |
spend_cap | STRING |
start_time | STRING |
updated_time | STRING |
AdCreatives
Purpose: Adcreatives table consists information of the layout and content for the ad.
Source API Documentation https://developers.facebook.com/docs/marketing-api/reference/ad-creative​
Replication: Key-Based Replication
Replication Key: AdAccount
Fields
Name | Target Datatype |
body | STRING |
image_url | STRING |
id | STRING |
account_id | STRING |
actor_id | STRING |
applink_treatment | STRING |
call_to_action_type | STRING |
effective_instagram_story_id | STRING |
effective_object_story_id | STRING |
title | STRING |
name | STRING |
instagram_permalink_url | STRING |
instagram_story_id | STRING |
link_og_id | STRING |
object_id | STRING |
object_story_id | STRING |
object_type | STRING |
object_url | STRING |
product_set_id | STRING |
status | STRING |
template_url | STRING |
thumbnail_url | STRING |
image_hash | STRING |
url_tags | STRING |
video_id | STRING |
link_url | STRING |
AdInsightsBreakdownCountry
Purpose: Provides interface to retrive data related to ads divided using breakdown country.
Source API Documentation https://developers.facebook.com/docs/marketing-api/reference/adgroup/insights/v3.3​
Replication: Key-Based Replication
Replication Key: lastRunDate
Fields
Name | Target Datatype |
account_currency | STRING |
account_id | STRING |
account_name | STRING |
action_values | RECORD |
ad_id | STRING |
ad_name | STRING |
adset_id | STRING |
adset_name | STRING |
buying_type | STRING |
campaign_id | STRING |
campaign_name | STRING |
canvas_avg_view_percent | NUMERIC |
clicks | NUMERIC |
cost_per_estimated_ad_recallers | NUMERIC |
cost_per_inline_link_click | NUMERIC |
cost_per_inline_post_engagement | NUMERIC |
cost_per_unique_click | NUMERIC |
cost_per_unique_inline_link_click | NUMERIC |
cpc | NUMERIC |
cpm | NUMERIC |
cpp | NUMERIC |
ctr | NUMERIC |
date_start | STRING |
date_stop | STRING |
estimated_ad_recall_rate | NUMERIC |
estimated_ad_recallers | NUMERIC |
frequency | NUMERIC |
impressions | NUMERIC |
inline_link_clicks | NUMERIC |
inline_post_engagement | NUMERIC |
objective | STRING |
reach | NUMERIC |
social_spend | NUMERIC |
spend | NUMERIC |
unique_clicks | NUMERIC |
unique_ctr | NUMERIC |
unique_inline_link_click_ctr | NUMERIC |
unique_inline_link_clicks | NUMERIC |
website_ctr | RECORD |
AdInsightsBreakdownRegion
Purpose: Provides interface to retrive data related to ads divided using breakdown Region.
Source API Documentation https://developers.facebook.com/docs/marketing-api/reference/adgroup/insights/v3.3​
Replication: Key-Based Replication
Replication Key: lastRunDate
Fields
Name | Target Datatype |
account_currency | STRING |
account_id | STRING |
account_name | STRING |
action_values | RECORD |
ad_id | STRING |
ad_name | STRING |
adset_id | STRING |
adset_name | STRING |
buying_type | STRING |
campaign_id | STRING |
campaign_name | STRING |
canvas_avg_view_percent | NUMERIC |
clicks | NUMERIC |
cost_per_estimated_ad_recallers | NUMERIC |
cost_per_inline_link_click | NUMERIC |
cost_per_inline_post_engagement | NUMERIC |
cost_per_unique_click | NUMERIC |
cost_per_unique_inline_link_click | NUMERIC |
cpc | NUMERIC |
cpm | NUMERIC |
cpp | NUMERIC |
ctr | NUMERIC |
date_start | STRING |
date_stop | STRING |
estimated_ad_recall_rate | NUMERIC |
estimated_ad_recallers | NUMERIC |
frequency | NUMERIC |
impressions | NUMERIC |
inline_link_clicks | NUMERIC |
inline_post_engagement | NUMERIC |
objective | STRING |
reach | NUMERIC |
social_spend | NUMERIC |
spend | NUMERIC |
unique_clicks | NUMERIC |
unique_ctr | NUMERIC |
unique_inline_link_click_ctr | NUMERIC |
unique_inline_link_clicks | NUMERIC |
website_ctr | RECORD |
AdInsightsBreakdownGender
Purpose: Provides interface to retrive data related to ads divided using breakdown Gender.
Source API Documentation https://developers.facebook.com/docs/marketing-api/reference/adgroup/insights/v3.3​
Replication: Key-Based Replication
Replication Key: lastRunDate
Fields
Name | Target Datatype |
account_currency | STRING |
account_id | STRING |
account_name | STRING |
action_values | RECORD |
ad_id | STRING |
ad_name | STRING |
adset_id | STRING |
adset_name | STRING |
buying_type | STRING |
campaign_id | STRING |
campaign_name | STRING |
canvas_avg_view_percent | NUMERIC |
clicks | NUMERIC |
cost_per_estimated_ad_recallers | NUMERIC |
cost_per_inline_link_click | NUMERIC |
cost_per_inline_post_engagement | NUMERIC |
cost_per_unique_click | NUMERIC |
cost_per_unique_inline_link_click | NUMERIC |
cpc | NUMERIC |
cpm | NUMERIC |
cpp | NUMERIC |
ctr | NUMERIC |
date_start | STRING |
date_stop | STRING |
estimated_ad_recall_rate | NUMERIC |
estimated_ad_recallers | NUMERIC |
frequency | NUMERIC |
impressions | NUMERIC |
inline_link_clicks | NUMERIC |
inline_post_engagement | NUMERIC |
objective | STRING |
reach | NUMERIC |
social_spend | NUMERIC |
spend | NUMERIC |
unique_clicks | NUMERIC |
unique_ctr | NUMERIC |
unique_inline_link_click_ctr | NUMERIC |
unique_inline_link_clicks | NUMERIC |
website_ctr | RECORD |
AdInsightsBreakdownDevicePlatform
Purpose: Provides interface to retrive data related to ads divided using breakdown Device Platform.
Source API Documentation https://developers.facebook.com/docs/marketing-api/reference/adgroup/insights/v3.3​
Replication: Key-Based Replication
Replication Key: lastRunDate
Fields
Name | Target Datatype |
account_currency | STRING |
account_id | STRING |
account_name | STRING |
action_values | RECORD |
ad_id | STRING |
ad_name | STRING |
adset_id | STRING |
adset_name | STRING |
buying_type | STRING |
campaign_id | STRING |
campaign_name | STRING |
canvas_avg_view_percent | NUMERIC |
clicks | NUMERIC |
cost_per_estimated_ad_recallers | NUMERIC |
cost_per_inline_link_click | NUMERIC |
cost_per_inline_post_engagement | NUMERIC |
cost_per_unique_click | NUMERIC |
cost_per_unique_inline_link_click | NUMERIC |
cpc | NUMERIC |
cpm | NUMERIC |
cpp | NUMERIC |
ctr | NUMERIC |
date_start | STRING |
date_stop | STRING |
estimated_ad_recall_rate | NUMERIC |
estimated_ad_recallers | NUMERIC |
frequency | NUMERIC |
impressions | NUMERIC |
inline_link_clicks | NUMERIC |
inline_post_engagement | NUMERIC |
objective | STRING |
reach | NUMERIC |
social_spend | NUMERIC |
spend | NUMERIC |
unique_clicks | NUMERIC |
unique_ctr | NUMERIC |
unique_inline_link_click_ctr | NUMERIC |
unique_inline_link_clicks | NUMERIC |
website_ctr | RECORD |