The tap-facebook Meltano extractor pulls data from Facebook Ads that can then be sent to a destination using a loader.

Alternative variants #

Multiple variants of tap-facebook are available. This document describes the meltano variant.

Alternative variants are:

Getting Started #

Prerequisites #

If you haven't already, follow the initial steps of the Getting Started guide:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration #

Using the Command Line Interface #

  1. Add the tap-facebook extractor to your project using meltano add : 

    meltano add extractor tap-facebook --variant meltano
  2. Configure the settings below using meltano config .

Next steps #

Follow the remaining steps of the Getting Started guide:

  1. Select entities and attributes to extract
  2. Add a loader to send data to a destination
  3. Run a data integration (EL) pipeline

If you run into any issues, learn how to get help.

Capabilities #

Settings #

tap-facebook requires the configuration of the following settings:

These and other supported settings are documented below. To quickly find the setting you're looking for, use the Table of Contents at the top of the page.

Account ID (account_id) #

Your Facebook Ads Account ID

How to use #

Manage this setting using meltano config or an environment variable: 

meltano config tap-facebook set account_id <account_id>

export TAP_FACEBOOK_ACCOUNT_ID=<account_id>

Access Token (access_token) #

User Token generated by Facebook OAuth handshake

How to use #

Manage this setting using meltano config or an environment variable: 

meltano config tap-facebook set access_token <access_token>

export TAP_FACEBOOK_ACCESS_TOKEN=<access_token>

start_date #

Determines how much historical data will be extracted. Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take.

How to use #

Manage this setting using meltano config or an environment variable: 

meltano config tap-facebook set start_date YYYY-MM-DDTHH:MM:SSZ

export TAP_FACEBOOK_START_DATE=YYYY-MM-DDTHH:MM:SSZ

end_date #

Date up to when historical data will be extracted.

How to use #

Manage this setting using meltano config or an environment variable: 

meltano config tap-facebook set end_date YYYY-MM-DDTHH:MM:SSZ

export TAP_FACEBOOK_END_DATE=YYYY-MM-DDTHH:MM:SSZ

Ads Insights Buffer Days (insights_buffer_days) #

How many Days before the Start Date to fetch Ads Insights for

How to use #

Manage this setting using meltano config or an environment variable: 

meltano config tap-facebook set insights_buffer_days 0

export TAP_FACEBOOK_INSIGHTS_BUFFER_DAYS=0

Looking for help? #

If you're having trouble getting the tap-facebook extractor to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the #plugins-general channel.

Found an issue on this page? #

This page is generated from a YAML file that you can contribute changes to. Edit it on GitHub!