Facebook Ads
Guide to integrate your Facebooks Ads data to Sprinkle
Datasource Concepts
Before setting up the datasource, learn about datasource concepts here
Pre-requisite
To fetch data from Facebook Ads, Sprinkle requires following permissions:
ads_managementads_readbusiness_management
Check Generating Facebook Access Token
Step by Step Guide
STEP-1: Configure Connection
To learn about Connection, refer here
Log into Sprinkle application
Navigate to Datasources -> Connections Tab -> New Connection ->
Select Facebook Ads
Provide all the mandatory details
Name: Name to identify this connection
Access Key: This Extended Access Token expires after 60 days. Provide new Extended Access Token after 60 days. Check Generate Access Token
Advance Settings: Refer here
Test Connection
Create
STEP-2: Configure Datasource
To learn about datasource, refer here
Navigate to Datasources -> Datasources Tab -> Add ->
Select Facebook Ads
Provide the name -> Create
Connection Tab:
From the drop-down, select the name of connection created in STEP-2
Update
STEP-3: Create Dataset
Datasets Tab: To learn about Dataset, refer here. Add Dataset for each report/dataset that you want to integrate, providing following details
Report Type (Required)
ADACCOUNTS, ADSETS, CAMPAIGNS
Fields (Required): Data fields to fetch. Refer Facebook Docs
AD_INSIGHTS, ADACCOUNTS_INSIGHTS, CAMPAIGNS_INSIGHTS, ADSETS_INSIGHTS
Fields (Required): Data fields to fetch. Refer Facebook Docs
Breakdowns (Optional) : Select compatible values from dropdown. Read more from facebook docs
Start Date (Required) : Format:YYYY-MM-DD. Data will be fetched from start date, for every run
Window for Backfill (Required) : Mention window for backfill, for backfilling metrics in every run to include updates from attribution window. Can take values 1, 7 and 28. Read more from facebook docs
Time Increment (Optional) :
Filtering (Optional) : Filtering can be applied on the resulted data. To apply filter give value like:- {"field":"ad.adlabels","operator":"ANY", "value":["Label Name"]}. For multiple filtering, give the json as comma separated. For ex:- {"field":"ad.adlabels","operator":"ANY","value":["Label Name"]} , {"field":"ad.adlabels","operator":"ANY","value":["Label Name"]}.You can read more about filtering from docs
Attribution windows (Optional) : Select from 1d_click, 7d_click, 28d_click, 1d_view, 7d_view, 28d_view
Ad Accounts (Required) : If all is selected, sprinkle will ingest data from all add accounts, Select multi for ingesting data from specific add accounts.
All
Multi-select
Flatten Level(Required) : Select One Level or Multi Level. In one level, flattening will not be applied on complex type. They will be stored as string. In multi level, flattening will be applied in complex level till they become simple type.
Destination Schema (Required) : Data warehouse schema where the table will be ingested into
Destination Table name (Required) : It is the table name to be created on the warehouse. If not given, sprinkle will create like ds_<datasourcename>_<tablename>
Destination Create Table Clause: Provide additional clauses to warehouse-create table queries such as clustering, partitioning, and more, useful for optimizing DML statements. Learn more on how to use this field.
Create
STEP-4: Run and schedule Ingestion
In the Ingestion Jobs tab:
Trigger the Job, using Run button
To schedule, enable Auto-Run. Change the frequency if needed
Generate Facebook Access Token
In your Facebook developer console, click on “Tools” and “Graph API Explorer” to generate Extended Access token. In the Permissions section give ads_read and ads_management permissions and click on Generate Access Token.
To generate an Extended Access Token which lasts 60 Days, users have to click on the i icon present in the Access Token field. By clicking on the Open in Access Token Tool, user will be redirected to the page, which provides the user the access token.
By clicking on the Extend Access Token, users just have to fill the password linked to their Facebook account and Extended Access Token will be generated, which can be used in Sprinkle to run ingestion.
Advanced Connection Settings
API Read Timeout (In seconds) : Maximum time of inactivity between two data packets when waiting for the server's response. The default value is 30 seconds
API Connection Timeout (In seconds) : Time period within which a connection between a client and a server must be established.
Retry Limit : Number of retries allowed when an API call fails. For example if an API call fails and retry.limit is 5 then it will check 5 times for that API call and if it succeeded then it will stop checking.
Retry Sleep Time (In milliseconds) : Given time, after which retry should happen in case an API call fails.
Incremental Batch Size (In days) : No of days in one batch for which data is being downloaded during incremental ingestion.
Facebook Version : it gives information about the version of API used.
Dataset Fields
Last updated
