Connector Facebook Ads

Data In

N/A

Data Out

When successfully run, all data queried will be output into CSV tables in the data/out/tables folder.

Warning: There will be no data output for the specified account if it is inactive.

ID (required)

Specify the ID string of the Facebook Ad account that you want to extract data from. You can locate this ID by logging into your Facebook account, clicking on the drop-down arrow and clicking on Business Manager. 

On the Business Manager page, you should be able to see a table for Ad accounts (if you don’t see this table, contact your admin to ensure you have been given access to your Facebook page’s ad accounts).

Under Ad accounts, you should be able to see the ad accounts linked to your Facebook page. Each ad account has its own unique ID found under its name. 

As the ID field is a string, it should be specified like this: act_<your ad account id>

So for example, if your ad account id is 12345678910, you should define it in the ID field of the Facebook Ads connector like this: act_12345678910.

Name (required)

Currency (required)

Account ID (required)

Business Name (required)

API Version (required)

Set this field to the latest version that the Facebook Marketing API is currently running on. In case of failure, use v16.0.

Name (required)

This field describes the query that you want to make. Whatever name you have decided to use in this field will also be prefixed to the queried table-names in the Data Out bucket.

The only exception is when the name used in this field also matches the name of the corresponding endpoint that you want to query (e.g. when you’re querying campaign data and you describe this query as campaigns and the endpoint that you want to extract data from is also called campaigns).

Type (required)

This field refers to the type of query you want to make. Currently, the only type of query that exists is nested-query and this field is therefore defined as such by default.

Learn more: about making nested queries here.

This field refers to the endpoint URL part of the request that is made to the Facebook Marketing API. The absolute URL looks like: https://graph.facebook.com/<api_version>/<endpoint>.  For example, if you want to query data about your ads, you would define this field as ads.

If this field is left empty, the API would extract from the root node which would be the page itself.

Learn more: List of the supported Facebook Marketing API endpoints here.

This is where you specify a set of parameters that you want to specifically query from your endpoint. For example, data about a single ad contains fields such as id, name. You can list these fields in this section and separate them with commas.

You can also add additional parameters within these fields by separating them with periods followed by the parameter name and the value in brackets.

An example query that includes additional parameters would look something like this:

insights.action_breakdowns(action_type).date_preset(last_month).time_increment(1){ad_id,impressions,reach,actions,clicks,spend}. 

Another example query with a specific time range is the following:

insights.breakdowns(publisher_platform).time_range({'since':'2022-01-01','until':'2022-01-07'}).time_increment(1){ad_id,ad_name,campaign_id,campaign_name,objective,impressions,reach,clicks,cpm,cpp,cpc,spend}

Since (optional)

Until (optional)

This field functions in a similar way as the Since field and also corresponds to the Facebook Marketing API’s time range parameters. 

Use this field to specify until which particular date you want to extract your data. This field can also be specified relatively (e.g.10 days ago) or absolutely (in the DD-MM-YYYY format). Leaving this field empty will also not affect your queried data.