Facebook Ads

tap-facebook (meltano variant)🥈

Advertising Platform

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

Alternate Implementations

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

  1. Add the tap-facebook extractor to your project using
    meltano add
    :
  2. meltano add extractor tap-facebook --variant meltano
  3. Configure the tap-facebook settings using
    meltano config
    :
  4. meltano config tap-facebook set --interactive
  5. Test that extractor settings are valid using
    meltano config
    :
  6. meltano config tap-facebook test

Next steps

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:

You can also list these settings using

meltano config
with the list subcommand:

meltano config tap-facebook list

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


Configure this setting directly using the following Meltano command:

meltano config tap-facebook set account_id [value]

Access Token (access_token)

  • Environment variable: TAP_FACEBOOK_ACCESS_TOKEN

User Token generated by Facebook OAuth handshake


Configure this setting directly using the following Meltano command:

meltano config tap-facebook set access_token [value]

(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.


Configure this setting directly using the following Meltano command:

meltano config tap-facebook set start_date [value]

(end_date)

  • Environment variable: TAP_FACEBOOK_END_DATE

Date up to when historical data will be extracted.


Configure this setting directly using the following Meltano command:

meltano config tap-facebook set end_date [value]

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


Configure this setting directly using the following Meltano command:

meltano config tap-facebook set insights_buffer_days [value]

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

Maintenance Status

  • Maintenance Status

Repo

https://gitlab.com/meltano/tap-facebook
  • Stars
  • Forks
  • Last Commit Date
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • Meltano

Meltano Stats

  • Total Executions (Last 3 Months)
  • Projects (Last 3 Months)

Keywords

  • api