Documentation

Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • Talk To sales
  • Start Trial

Schema Information for Facebook Ads

Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • Pulse

    • Daton

      Need help with something?

      Talk to data expert

      Schema Information for Facebook Ads

      In this article, we will look at the schema information of the supported APIs and tables for Facebook Ads. 

      Find the links to other articles related to Facebook Ads Below:

      • Essential Attributes and Supported Table for Facebook Ads
      • Setup Instructions for Facebook Ads
      • Release Notes 

      Schema Details

      The tables and APIs associated with the Facebook Ads connector are as follows.

      Insights

      Purpose: Provides interface to retrieve 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: The ads object has the necessary data for each ad. Each Ad is linked with a corresponding asset.       

      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
      online ads social ads

      Was this article helpful?

      Yes
      No
      Give feedback about this article

      Related Articles

      • Setup Instructions for Facebook Ads
      • Essential Attributes and Supported Table for Facebook Ads

      Table of Contents

      Schema Details Insights Ads Fields Campaigns AdCreatives AdInsightsBreakdownCountry AdInsightsBreakdownRegion AdInsightsBreakdownGender AdInsightsBreakdownDevicePlatform

      Get Started on your Data Journey Today!

      Get a free 14-day trial of Daton today, no credit card is required.

      Start Free Trial
      Talk To Experts
      • Quick & Easy Setup
      • Secure & Reliable
      • No-Code Platform
      • Auto Updates
      • 24/7 Support

      Follow Us

      Linkedin Youtube

      Company

      • Customers
      • Partner With Us
      • Contact Us

      Culture

      • About
      • People
      • Careers

      Offerings

      • Daton
      • For Brands
      • For Agencies

      Policies

      • Terms of Service
      • Privacy Policy
      • MSA

      Follow Us

      Linkedin Youtube

      DISCLAIMER: Various trademarks are held by their respective owners

      © 2023 sarasanalytics.com

      Sitemap

      Get Started on your Data Journey Today!

      Get a free 14-day trial of Daton today, no credit card is required.

      Start Free Trial
      Talk To Sales
      DISCLAIMER: Trademarks are held by their respective owners
      • Quick & Easy Setup
      • Secure & Reliable
      • No-Code Platform
      • Auto Updates
      • 24/7 Support

      Company

      • Customers
      • Partners
      • About
      • People
      • Careers
      • Contact Us

      Offerings

      • Daton
      • Solution for Brands
      • Solution for Agencies
      • Dashboards
      • Founder's Note
      • Status

      Policies

      • Terms of Service
      • Privacy Policy
      • MSA
      • Sitemap

      © 2023 sarasanalytics.com

      Linkedin Youtube

      Knowledge Base Software powered by Helpjuice

      Expand