Singer tap for extracting data from the Facebook Marketing API.

Built with the Meltano Singer SDK.

• catalog
• state
• discover
• about
• stream-maps
• schema-flattening

A full list of supported settings and capabilities is available by running: tap-facebook --about

pipx install git+https://github.com/MeltanoLabs/tap-facebook.git

The following config values need to be set in order to use with Meltano. These can be set in meltano.yml, via meltano config tap-facebook set --interactive, or via the env var mappings shown above.

• access_token: access token from TAP_FACEBOOK_ACCESS_TOKEN variable
• start_date: start date
• end_date: end_date
• account_id: account ID from TAP_FACEBOOK_ACCOUNT_ID variable
• api_version: api version

tap-facebook --about

The licensor grants you a non-exclusive, royalty-free, worldwide, non-sublicensable, non-transferable license to use, copy, distribute, make available, and prepare derivative works of the software.

Attribution Window is time period during which conversions might be credited to ads, we can have this time period between 1 day to 7 days for clicks and views

• action_attribution_windows: We can add these variable to params, it will have a list type value which takes in 1d-7d clicks and 1d-7d views values. We have added this variable in get_url_params function of ads insights stream

A Facebook access token is required to make API requests. (See Facebook API docs for more info)

Hitting the rate limit for the Facebook API while making requests will return the following error:

400 Client Error: b'{"error":{"message":"(#80004) There have been too many calls to this ad-account. Wait a bit and try again

This error is handled using the Backoff Library, and the program will cease for a random amount of time before attempting to call the API again

tap-facebook --version
tap-facebook --help
tap-facebook --config CONFIG --discover > ./catalog.json

This project uses parent-child streams. Learn more about them here.

pipx install poetry
poetry install

Create tests within the tap_facebook/tests subfolder and then run:

poetry run pytest

You can also test the tap-facebook CLI interface directly using poetry run:

poetry run tap-facebook --help

Note: This tap will work in any Singer environment and does not require Meltano. Examples here are for convenience and to streamline end-to-end orchestration scenarios.

Your project comes with a custom meltano.yml project file already created. Open the meltano.yml and follow any "TODO" items listed in the file.

Next, install Meltano (if you haven't already) and any needed plugins:

# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-facebook
meltano install

Now you can test and orchestrate using Meltano:

# Test invocation:
meltano invoke tap-facebook --version
# OR run a test `elt` pipeline:
meltano elt tap-facebook target-jsonl

See the dev guide for more instructions on how to use the SDK to develop your own taps and targets.