tap-facebook - Meltano Hub

Facebook Ads

tap-facebook from meltano

Advertising Platform

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

Other Available Variants

Getting Started

Prerequisites

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

Installation and configuration

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

meltano add extractor tap-facebook --variant meltano

Configure the tap-facebook settings using
```
meltano config
```
:

meltano config tap-facebook set --interactive

Test that extractor settings are valid using

meltano test

meltano test tap-facebook

Next steps

Follow the remaining steps of the Getting Started guide:

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

Capabilities

The current capabilities for

tap-facebook

may have been automatically set when originally added to the Hub. Please review the capabilities when using this extractor. If you find they are out of date, please consider updating them by making a pull request to the YAML file that defines the capabilities for this extractor.

This plugin has the following capabilities:

properties
discover
state

You can override these capabilities or specify additional ones in your meltano.yml by adding the capabilities key.

Settings

The tap-facebook settings that are known to Meltano are documented below. To quickly find the setting you're looking for, click on any setting name from the list:

account_id
access_token
start_date
end_date
insights_buffer_days

You can override these settings or specify additional ones in your meltano.yml by adding the settings key.

Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.

Account ID (account_id)

Environment variable: TAP_FACEBOOK_ACCOUNT_ID

Your Facebook Ads Account ID

Access Token (access_token)

Environment variable: TAP_FACEBOOK_ACCESS_TOKEN

User Token generated by Facebook OAuth handshake

(start_date)

Environment variable: TAP_FACEBOOK_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)

Environment variable: TAP_FACEBOOK_END_DATE

Date up to when historical data will be extracted.

Ads Insights Buffer Days (insights_buffer_days)

Environment variable: TAP_FACEBOOK_INSIGHTS_BUFFER_DAYS
Default Value: 0

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

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

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.

Install

meltano add extractor tap-facebook --variant meltano

Homepage

Maintenance Status

Repo

https://gitlab.com/meltano/tap-facebook

Maintainer

Meltano Stats

Keywords