Facebook Ads

tap-facebook (airbyte variant)🥈

Advertising Platform

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

Airbyte Usage Notice

This connector uses tap-airbyte-wrapper to call the underlying Airbyte source Docker container. This means you must have Docker installed and running prior to usage. We also recommend using Meltano version 2.13.0 or later.

Container-based connectors can introduce deployment challenges including the potential need to run Docker-in-Docker (not currently supported by services like AWS ECS, Meltano Cloud, etc. see FAQ and Airbyte's ECS deployment docs for more details). Before using this variant we recommend considering if/how you will be able to deploy container-based connectors to production.

For more context on how this Airbyte integration works please checkout out the FAQ in the Meltano Docs.

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 airbyte
  2. Configure the tap-facebook settings using 
    meltano config
     : 
    3. meltano config tap-facebook set --interactive
  3. Test that extractor settings are valid using 
    meltano config
     : 
    4. 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:

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

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.

Airbyte Config Access Token (airbyte_config.access_token)

  • Environment variable: TAP_FACEBOOK_AIRBYTE_CONFIG_ACCESS_TOKEN

The value of the access token generated. See the docs for more information


Configure this setting directly using the following Meltano command:

meltano config tap-facebook set airbyte_config access_token [value]

Airbyte Config Account Id (airbyte_config.account_id)

  • Environment variable: TAP_FACEBOOK_AIRBYTE_CONFIG_ACCOUNT_ID

The Facebook Ad account ID to use when pulling data from the Facebook Marketing API.


Configure this setting directly using the following Meltano command:

meltano config tap-facebook set airbyte_config account_id [value]

Airbyte Config Action Breakdowns Allow Empty (airbyte_config.action_breakdowns_allow_empty)

  • Environment variable: TAP_FACEBOOK_AIRBYTE_CONFIG_ACTION_BREAKDOWNS_ALLOW_EMPTY

Allows action_breakdowns to be an empty list


Configure this setting directly using the following Meltano command:

meltano config tap-facebook set airbyte_config action_breakdowns_allow_empty [value]

Airbyte Config Custom Insights (airbyte_config.custom_insights)

  • Environment variable: TAP_FACEBOOK_AIRBYTE_CONFIG_CUSTOM_INSIGHTS

A list which contains insights entries, each entry must have a name and can contains fields, breakdowns or action_breakdowns)


Configure this setting directly using the following Meltano command:

meltano config tap-facebook set airbyte_config custom_insights [value]

Airbyte Config End Date (airbyte_config.end_date)

  • Environment variable: TAP_FACEBOOK_AIRBYTE_CONFIG_END_DATE

The date until which you'd like to replicate data for all incremental streams, in the format YYYY-MM-DDT00:00:00Z. All data generated between start_date and this date will be replicated. Not setting this option will result in always syncing the latest data.


Configure this setting directly using the following Meltano command:

meltano config tap-facebook set airbyte_config end_date [value]

Airbyte Config Fetch Thumbnail Images (airbyte_config.fetch_thumbnail_images)

  • Environment variable: TAP_FACEBOOK_AIRBYTE_CONFIG_FETCH_THUMBNAIL_IMAGES

In each Ad Creative, fetch the thumbnail_url and store the result in thumbnail_data_url


Configure this setting directly using the following Meltano command:

meltano config tap-facebook set airbyte_config fetch_thumbnail_images [value]

Airbyte Config Include Deleted (airbyte_config.include_deleted)

  • Environment variable: TAP_FACEBOOK_AIRBYTE_CONFIG_INCLUDE_DELETED

Include data from deleted Campaigns, Ads, and AdSets


Configure this setting directly using the following Meltano command:

meltano config tap-facebook set airbyte_config include_deleted [value]

Airbyte Config Insights Lookback Window (airbyte_config.insights_lookback_window)

  • Environment variable: TAP_FACEBOOK_AIRBYTE_CONFIG_INSIGHTS_LOOKBACK_WINDOW

The attribution window


Configure this setting directly using the following Meltano command:

meltano config tap-facebook set airbyte_config insights_lookback_window [value]

Airbyte Config Max Batch Size (airbyte_config.max_batch_size)

  • Environment variable: TAP_FACEBOOK_AIRBYTE_CONFIG_MAX_BATCH_SIZE

Maximum batch size used when sending batch requests to Facebook API. Most users do not need to set this field unless they specifically need to tune the connector to address specific issues or use cases.


Configure this setting directly using the following Meltano command:

meltano config tap-facebook set airbyte_config max_batch_size [value]

Airbyte Config Page Size (airbyte_config.page_size)

  • Environment variable: TAP_FACEBOOK_AIRBYTE_CONFIG_PAGE_SIZE

Page size used when sending requests to Facebook API to specify number of records per page when response has pagination. Most users do not need to set this field unless they specifically need to tune the connector to address specific issues or use cases.


Configure this setting directly using the following Meltano command:

meltano config tap-facebook set airbyte_config page_size [value]

Airbyte Config Start Date (airbyte_config.start_date)

  • Environment variable: TAP_FACEBOOK_AIRBYTE_CONFIG_START_DATE

The date from which you'd like to replicate data for all incremental streams, in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated.


Configure this setting directly using the following Meltano command:

meltano config tap-facebook set airbyte_config start_date [value]

Airbyte Spec Image (airbyte_spec.image)

  • Environment variable: TAP_FACEBOOK_AIRBYTE_SPEC_IMAGE
  • Default Value: airbyte/source-facebook-marketing

Airbyte image to run


Configure this setting directly using the following Meltano command:

meltano config tap-facebook set airbyte_spec image [value]

Airbyte Spec Tag (airbyte_spec.tag)

  • Environment variable: TAP_FACEBOOK_AIRBYTE_SPEC_TAG
  • Default Value: latest

Airbyte image tag


Configure this setting directly using the following Meltano command:

meltano config tap-facebook set airbyte_spec tag [value]

Docker Mounts (docker_mounts)

  • Environment variable: TAP_FACEBOOK_DOCKER_MOUNTS

Docker mounts to make available to the Airbyte container. Expects a list of maps containing source, target, and type as is documented in the docker --mount documentation


Configure this setting directly using the following Meltano command:

meltano config tap-facebook set docker_mounts [value]
Expand To Show SDK Settings

Flattening Enabled (flattening_enabled)

  • Environment variable: TAP_FACEBOOK_FLATTENING_ENABLED

'True' to enable schema flattening and automatically expand nested properties.


Configure this setting directly using the following Meltano command:

meltano config tap-facebook set flattening_enabled [value]

Flattening Max Depth (flattening_max_depth)

  • Environment variable: TAP_FACEBOOK_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.


Configure this setting directly using the following Meltano command:

meltano config tap-facebook set flattening_max_depth [value]

Stream Map Config (stream_map_config)

  • Environment variable: TAP_FACEBOOK_STREAM_MAP_CONFIG

User-defined config values to be used within map expressions.


Configure this setting directly using the following Meltano command:

meltano config tap-facebook set stream_map_config [value]

Stream Maps (stream_maps)

  • Environment variable: TAP_FACEBOOK_STREAM_MAPS

Config object for stream maps capability. For more information check out Stream Maps.


Configure this setting directly using the following Meltano command:

meltano config tap-facebook set stream_maps [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, read the Airbyte connector FAQ, look for an existing issue in the Airbyte 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 airbyte

Maintenance Status

  • Maintenance Status
  • Built with the Meltano SDK
  • Based on an Airbyte Connector

Repo

https://github.com/airbytehq/airbyte/tree/master/airbyte-integrations/connectors/source-facebook-marketing
  • Last Commit Date
  • License

Maintainer

  • Airbyte

Meltano Stats

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

Keywords

  • airbyte_protocolmeltano_sdk