Official

Premium

Facebook Marketing

The Facebook Marketing source plugin for CloudQuery extracts information from the Facebook marketing API

Publisher

cloudquery

Latest version

v4.8.0

Type

Source

Platforms

Date Published

October 22, 2024

Price per 1M rows

Starting from $15

monthly free quota

1M rows

Documentation Tables Changelog Destinations

Overview

Set up process #

brew install cloudquery/tap/cloudquery

1. Download CLI and login

See installation options

2. Create source and destination configs

Plugin configuration

cloudquery sync facebookmarketing.yml postgresql.yml

3. Run the sync

CloudQuery sync

Overview #

The Facebook Marketing source plugin for CloudQuery extracts information from the Facebook marketing API.

Configuration #

This following configuration example connects a Facebook Marketing source to a Postgres destination.

kind: source
spec:
  # Source spec section
  name: facebookmarketing
  path: cloudquery/facebookmarketing
  registry: cloudquery
  version: "v4.8.0"
  tables: ["*"]
  destinations: ["postgresql"]
  # Learn more about the configuration options at https://cql.ink/facebookmarketing_source
  spec:
    # Facebook Marketing Spec section
    # You can find the ad_account_id in the Facebook Ads Manager: https://www.facebook.com/ads/manager/accounts/
    ad_account_id: "${AD_ACCOUNT_ID}"
    # See the "authentication section" on how to create an access token
    access_token: "${ACCESS_TOKEN}"

Authentication #

In order for CloudQuery to sync data from Facebook Marketing, you will need a Facebook Marketing access token. You will need to follow the following steps (if you don't have them set up already):

Create a business app in the Meta App dashboard. See Facebook's documentation. Make sure to choose the "Business" application type, and to link it to your business account.

Add the "Marketing API" capability to your application. You should now see a dropdown "Marketing API" menu. In this dropdown, under Tools, you will be able to generate your access token. See also Facebook's documentation
You will also need to find your ad_account_id, which you can find in the Facebook Ads Manager. (See documentation).

CloudQuery only ever makes READ calls to the API, but due to the way the Facebook permission model works, some of the tables also require ads_management permissions.

Configuration #

concurrency (integer) (optional) (default: 10000)
A best effort maximum number of Go routines to use. Lower this number to reduce memory usage.
scheduler (string, optional) (default: dfs)
The scheduler to use when determining the priority of resources to sync. Supported values are dfs (depth-first search), round-robin, shuffle and shuffle-queue.
For more information about this, see performance tuning.