# Facebook Ads ## Pipeline Concepts Before setting up the pipeline, learn about pipeline concepts [here](https://docs.sprinkledata.com/product/ingesting-your-data/pipelines) ## Pre-requisite To fetch data from Facebook Ads, Sprinkle requires following permissions: * `ads_management` * `ads_read` * `business_management` `Check` [`Generating Facebook Access Token`](#generate-facebook-access-token) ## Step by Step Guide ### STEP-1: Configure Connection To learn about Connection, refer [here](https://docs.sprinkledata.com/product/ingesting-your-data/pipelines) * Log into Sprinkle application * Navigate to Import -> 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](#undefined) * *Advance Settings:* Refer [here](#advanced-connection-settings) * Test Connection * Create ### STEP-2: Configure Pipeline To learn about pipeline, refer [here](https://docs.sprinkledata.com/product/ingesting-your-data/pipelines) * Navigate to Ingest -> Pipeline 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](https://docs.sprinkledata.com/product/ingesting-your-data/pipelines/databases/features/destination-create-table-clause). 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](https://developers.facebook.com/docs/marketing-api/reference/v11.0) * *AD\_INSIGHTS, ADACCOUNTS\_INSIGHTS, CAMPAIGNS\_INSIGHTS, ADSETS\_INSIGHTS* * *Fields* (Required): Data fields to fetch. Refer [Facebook Docs](https://developers.facebook.com/docs/marketing-api/reference/v11.0) * *Breakdowns* (Optional) : Select compatible values from dropdown. Read more from facebook [docs](https://developers.facebook.com/docs/marketing-api/insights/breakdowns) * *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](https://www.facebook.com/business/help/2198119873776795?id=768381033531365) * *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](https://developers.facebook.com/docs/marketing-api/insights/#fieldexpansion) * *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\_\\_\ * *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](https://docs.sprinkledata.com/product/ingesting-your-data/pipelines/databases/features/destination-create-table-clause) 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.
![](https://uploads-ssl.webflow.com/605c9e03d6553a5d82976ce2/60925b68214e765a8a4c222e_pdmU1X2C06dog5EO49jyCFiZam4mAChYLqM0QOIO-0E3ah0oy1ZtOLtmpnm61z6N8xmM68CAeNNXO7jiGldH0rGUgZmhXjkQxrmgBnna7l7OtNOclPLsDcsmQBKiMOjCk0d8y9WC.png) ‍ 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.\ \ ‍
![](https://uploads-ssl.webflow.com/605c9e03d6553a5d82976ce2/60925ba9c469fcfe0f04f22e_blBNTuvuEsLnVayAiaUtRypMB-hcTYHoYh_cA-26RUmSXEer7Y33VuQpIuaYio0AV7lKEam2OcQ9BH_qWFiDyUl_KrBxuMGBPScm-V-6xuv9o8ihApTWSs9Df6EJaG3bZozl_Lo-.png) ### 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
ADACCOUNTS * account\_id * id * account\_status * age * agency\_client\_declaration * amount\_spent * balance * business\_city * business\_country\_code * business\_name * business\_state * business\_street * business\_street2 * business\_zip * currency * end\_advertiser * funding\_source * funding\_source\_details * is\_personal * media\_agency * name * offsite\_pixels\_tos\_accepted * owner * partner * spend\_cap * tax\_id * tax\_id\_status * timezone\_id * timezone\_name * timezone\_offset\_hours\_utc * tos\_accepted
ADSETS * account\_id * id * name * bid\_info * adlabels * status * adset\_schedule * bid\_strategy * bid\_amount * billing\_event * budget\_remaining * campaign * campaign\_id * configured\_status * created\_time * creative\_sequence * daily\_budget * effective\_status * end\_time * lifetime\_budget * lifetime\_imps * use\_new\_app\_click * optimization\_goal * pacing\_type * promoted\_object * destination\_type * rf\_prediction\_id * start\_time * targeting * updated\_time * optimization\_sub\_event
CAMPAIGNS * account\_id * id * name * adlabels * buying\_type * daily\_budget * status * topline\_id * source\_campaign * source\_campaign\_id * special\_ad\_categories * configured\_status * effective\_status * objective * promoted\_object * spend\_cap * start\_time * stop\_time * updated\_time * lifetime\_budget * budget\_remaining * pacing\_type
AD_INSIGHTS, ADACCOUNTS_INSIGHTS, CAMPAIGNS_INSIGHTS, ADSETS_INSIGHTS * account\_currency * account\_id * account\_name * ad\_id * ad\_name * aset\_id * adset\_name * campaign\_id * campaign\_group\_name * adgroup\_name * campaign\_name * action\_values * activity\_recency * ad\_click\_actions * ad\_format\_asset * ad\_impression\_actions * cpc * age\_targeting * attribution\_setting * auction\_bid * auction\_competitiveness * auction\_max\_competitor\_bid * body\_asset * buying\_type * canvas\_avg\_view\_percent * canavs\_avg\_view\_time * catalog\_segment\_actions * catalog\_segment\_value * catalog\_segment\_value\_mobile\_purchase\_roas * catalog\_segment\_value\_omni\_purchase\_roas * catalog\_segment\_value\_website\_purchase\_roas * comparision\_node * conversions * converted\_product\_quantity * converted\_product\_value * cpm * cpp * created\_time * updated\_time * ctr * clicks * impressions * actions * unique\_actions * spend * social\_spend * frequency * frequency\_value * reach * labels * location * website\_ctr * conversion\_rate\_ranking * conversion\_values * unique\_ctr * inline\_link\_clicks * unique\_inline\_link\_clicks * inline\_link\_clicks\_ctr * unique\_inline\_link\_clicks\_ctr * unique\_link\_clicks\_ctr * country * date\_start * date\_stop * dda\_countby\_convs * dda\_results * cost\_per\_15\_sec\_video\_view * cost\_per\_2\_sec\_continuous\_video\_view * cost\_per\_action\_type * cost\_per\_ad\_click * cost\_per\_conversion * cost\_per\_dda\_countby\_convs * cost\_per\_inline\_link\_click * description\_asset * device\_platform * dma * estimated\_ad\_recall\_rate\_lower\_bound * cost\_per\_inline\_post\_engagement * cost\_per\_one\_thousand\_ad\_impression * cost\_per\_outbound\_click * cost\_per\_store\_visit\_action * cost\_per\_thruplay * cost\_per\_unique\_action\_type * cost\_per\_unique\_click * estimated\_ad\_recall\_rate\_upper\_bound * estimated\_ad\_recallers\_lower\_bound * estimated\_ad\_recallers\_upper\_bound * cost\_per\_unique\_conversion * cost\_per\_unique\_inline\_link\_click * cost\_per\_unique\_outbound\_click * full\_view\_impressions * full\_view\_reach * gender\_targeting * hourly\_stats\_aggregated\_by\_advertiser\_time\_zone * hourly\_stats\_aggregated\_by\_audience\_time\_zone * image\_asset * impression\_device * impression\_dummy * inline\_post\_engagement * instant\_experience\_clicks\_to\_open * instant\_experience\_clicks\_to\_start * instant\_experience\_outbound\_clicks * media\_asset * mobile\_app\_purchase\_roas * objective * optimization\_goal * outbound\_clicks * outbound\_clicks\_ctr * interactive\_component\_tap * place\_page\_id * place\_page\_name * platform\_position * product\_id * publisher\_platform * purchase\_roas * qualifying\_question\_qualify\_answer\_rate * rule\_asset * title\_asset * video\_15\_sec\_watched\_actions * video\_30\_sec\_watched\_actions * video\_asset video\_avg\_time\_watched\_actions * video\_continuous\_2\_sec\_watched\_actions * video\_p100\_watched\_actions * video\_p25\_watched\_actions * video\_p50\_watched\_actions * video\_p75\_watched\_actions * video\_p95\_watched\_actions * video\_play\_actions * video\_play\_curve\_actions * video\_play\_retention\_0\_to\_15s\_actions * video\_play\_retention\_20\_to\_60s\_actions * video\_play\_retention\_graph\_actions * video\_time\_watched\_actions * website\_purchase\_raos * wish\_bid * link\_click * app\_install * app\_use * mobile\_app\_install * search * offsite\_conversion\_fb\_pixel\_search * onsite\_app\_view\_content * video\_view * comment * offsite\_conversion\_search * app\_custom\_event\_fb\_mobile\_purchase * app\_custom\_event\_other * app\_custom\_event\_fb\_mobile\_complete\_registration * app\_custom\_event\_fb\_mobile\_rate * app\_custom\_event\_fb\_mobile\_content\_view * app\_custom\_event\_fb\_mobile\_spent\_credits * post * post\_reaction * app\_custom\_event\_fb\_mobile\_achievement\_unlocked * offsite\_conversion\_fb\_pixel\_custom * onsite\_web\_purchase * app\_custom\_event\_fb\_mobile\_add\_payment\_info * app\_custom\_event\_fb\_mobile\_activate\_app * omni\_app\_install * omni\_purchase * omni\_view\_content * omni\_search * omni\_activate\_app * omni\_tutorial\_completion * omni\_spend\_credits * omni\_rate * omni\_level\_achieved * like * credit\_spent * offline\_conversion\_view\_content * onsite\_web\_view\_content * unique\_link\_click * unique\_app\_install * unique\_app\_use * unique\_mobile\_app\_install * unique\_search * unique\_offsite\_conversions\_fb\_pixel\_search * unique\_onsite\_app\_view\_content * unique\_video\_view * unique\_comment * unique\_offsite\_conversion\_search * unique\_app\_custom\_event\_fb\_mobile\_purchase * unique\_app\_custom\_event\_other * unique\_app\_custom\_event\_fb\_mobile\_complete\_registration * unique\_app\_custom\_event\_fb\_mobile\_search * unique\_app\_custom\_event\_fb\_mobile\_rate * unique\_app\_custom\_event\_fb\_mobile\_content\_view * unique\_app\_custom\_event\_fb\_mobile\_spent\_credits * unique\_post * unique\_post\_reaction * unique\_app\_custom\_event\_fb\_mobile\_\_acheivement\_unlocked * unique\_offsite\_conversion\_fb\_pixel\_custom * unique\_onsite\_web\_purchase * unique\_app\_custom\_event\_fb\_mobile\_add\_payment\_info * unique\_app\_custom\_event\_fb\_mobile\_activate\_app * unique\_omni\_app\_install * unique\_omni\_purchase * unique\_omni\_view\_content * unique\_omni\_search * unique\_omni\_activate\_app * unique\_omni\_tutorial\_completion * unique\_omni\_spend\_credits * unique\_omni\_rate * unique\_omni\_level\_achieved * unique\_like * unique\_credit\_spent * unique\_offline\_conversion\_view\_content * unique\_onsite\_web\_view\_content * account\_currency * account\_id * account\_name * ad\_id * ad\_name * aset\_id * adset\_name * campaign\_id * campaign\_group\_name * adgroup\_name * campaign\_name * action\_values * activity\_recency * ad\_click\_actions * ad\_format\_asset * ad\_impression\_actions * cpc * age\_targeting * attribution\_setting * auction\_bid * auction\_competitiveness * auction\_max\_competitor\_bid * body\_asset * buying\_type * canvas\_avg\_view\_percent * canavs\_avg\_view\_time * catalog\_segment\_actions * catalog\_segment\_value * catalog\_segment\_value\_mobile\_purchase\_roas * catalog\_segment\_value\_omni\_purchase\_roas * catalog\_segment\_value\_website\_purchase\_roas * comparision\_node * conversions * converted\_product\_quantity * converted\_product\_value * cpm * cpp * created\_time * updated\_time * ctr * clicks * impressions * actions * unique\_actions * spend * social\_spend * frequency * frequency\_value * reach * labels * location * website\_ctr * conversion\_rate\_ranking * conversion\_values * unique\_ctr * inline\_link\_clicks * unique\_inline\_link\_clicks * inline\_link\_clicks\_ctr * unique\_inline\_link\_clicks\_ctr * unique\_link\_clicks\_ctr * country * date\_start * date\_stop * dda\_countby\_convs * dda\_results * cost\_per\_15\_sec\_video\_view * cost\_per\_2\_sec\_continuous\_video\_view * cost\_per\_action\_type * cost\_per\_ad\_click * cost\_per\_conversion * cost\_per\_dda\_countby\_convs * cost\_per\_inline\_link\_click * description\_asset * device\_platform * dma * estimated\_ad\_recall\_rate\_lower\_bound * cost\_per\_inline\_post\_engagement * cost\_per\_one\_thousand\_ad\_impression * cost\_per\_outbound\_click * cost\_per\_store\_visit\_action * cost\_per\_thruplay * cost\_per\_unique\_action\_type * cost\_per\_unique\_click * estimated\_ad\_recall\_rate\_upper\_bound * estimated\_ad\_recallers\_lower\_bound * estimated\_ad\_recallers\_upper\_bound * cost\_per\_unique\_conversion * cost\_per\_unique\_inline\_link\_click * cost\_per\_unique\_outbound\_click * full\_view\_impressions * full\_view\_reach * gender\_targeting * hourly\_stats\_aggregated\_by\_advertiser\_time\_zone * hourly\_stats\_aggregated\_by\_audience\_time\_zone * image\_asset * impression\_device * impression\_dummy * inline\_post\_engagement * instant\_experience\_clicks\_to\_open * instant\_experience\_clicks\_to\_start * instant\_experience\_outbound\_clicks * media\_asset * mobile\_app\_purchase\_roas * objective * optimization\_goal * outbound\_clicks * outbound\_clicks\_ctr * interactive\_component\_tap * place\_page\_id * place\_page\_name * platform\_position * product\_id * publisher\_platform * purchase\_roas * qualifying\_question\_qualify\_answer\_rate * rule\_asset * title\_asset * video\_15\_sec\_watched\_actions * video\_30\_sec\_watched\_actions * video\_asset video\_avg\_time\_watched\_actions * video\_continuous\_2\_sec\_watched\_actions * video\_p100\_watched\_actions * video\_p25\_watched\_actions * video\_p50\_watched\_actions * video\_p75\_watched\_actions * video\_p95\_watched\_actions * video\_play\_actions * video\_play\_curve\_actions * video\_play\_retention\_0\_to\_15s\_actions * video\_play\_retention\_20\_to\_60s\_actions * video\_play\_retention\_graph\_actions * video\_time\_watched\_actions * website\_purchase\_raos * wish\_bid * link\_click * app\_install * app\_use * mobile\_app\_install * search * offsite\_conversion\_fb\_pixel\_search * onsite\_app\_view\_content * video\_view * comment * offsite\_conversion\_search * app\_custom\_event\_fb\_mobile\_purchase * app\_custom\_event\_other * app\_custom\_event\_fb\_mobile\_complete\_registration * app\_custom\_event\_fb\_mobile\_rate * app\_custom\_event\_fb\_mobile\_content\_view * app\_custom\_event\_fb\_mobile\_spent\_credits * post * post\_reaction * app\_custom\_event\_fb\_mobile\_achievement\_unlocked * offsite\_conversion\_fb\_pixel\_custom * onsite\_web\_purchase * app\_custom\_event\_fb\_mobile\_add\_payment\_info * app\_custom\_event\_fb\_mobile\_activate\_app * omni\_app\_install * omni\_purchase * omni\_view\_content * omni\_search * omni\_activate\_app * omni\_tutorial\_completion * omni\_spend\_credits * omni\_rate * omni\_level\_achieved * like * credit\_spent * offline\_conversion\_view\_content * onsite\_web\_view\_content * unique\_link\_click * unique\_app\_install * unique\_app\_use * unique\_mobile\_app\_install * unique\_search * unique\_offsite\_conversions\_fb\_pixel\_search * unique\_onsite\_app\_view\_content * unique\_video\_view * unique\_comment * unique\_offsite\_conversion\_search * unique\_app\_custom\_event\_fb\_mobile\_purchase * unique\_app\_custom\_event\_other * unique\_app\_custom\_event\_fb\_mobile\_complete\_registration * unique\_app\_custom\_event\_fb\_mobile\_search * unique\_app\_custom\_event\_fb\_mobile\_rate * unique\_app\_custom\_event\_fb\_mobile\_content\_view * unique\_app\_custom\_event\_fb\_mobile\_spent\_credits * unique\_post * unique\_post\_reaction * unique\_app\_custom\_event\_fb\_mobile\_\_acheivement\_unlocked * unique\_offsite\_conversion\_fb\_pixel\_custom * unique\_onsite\_web\_purchase * unique\_app\_custom\_event\_fb\_mobile\_add\_payment\_info * unique\_app\_custom\_event\_fb\_mobile\_activate\_app * unique\_omni\_app\_install * unique\_omni\_purchase * unique\_omni\_view\_content * unique\_omni\_search * unique\_omni\_activate\_app * unique\_omni\_tutorial\_completion * unique\_omni\_spend\_credits * unique\_omni\_rate * unique\_omni\_level\_achieved * unique\_like * unique\_credit\_spent * unique\_offline\_conversion\_view\_content * unique\_onsite\_web\_view\_content