The tap-facebook Singer tap pulls data from Facebook Ads that can then be sent to a destination using a Singer target.

Alternative variants

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

Alternative variants are:

Standalone usage

Install the package using pip: 

pip install tap-facebook

For additional instructions, refer to the README in the repository.

Usage with Meltano

Install Meltano, create your Meltano project, and add the tap to your project as an extractor: 

meltano add extractor tap-facebook --variant singer-io

For additional instructions, refer to the Meltano-specific documentation for tap-facebook.

Capabilities

Settings

Account ID (account_id)

Your Facebook Ads Account ID

Access Token (access_token)

User Token generated by Facebook OAuth handshake

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.

end_date

Date up to when historical data will be extracted.

Ads Insights Buffer Days (insights_buffer_days)

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

Include Deleted Objects (include_deleted)

Determines if it should include deleted objects or not.

Looking for help?

If you're having trouble getting tap-facebook to work by itself or with Meltano, 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! It is also validated against a JSON Schema used for taps and targets.


Edit this page on GitLab!