Database

You need to configure a database to use pyfbook. Pyfbook required a dbstream object to work properly.

You can use pyred, pyzure or pybigquery depending on your database provider.

To define a dbstream object, you need to add in your environment the following variables

For Redshift:

export RED_[YOUR_PROJECT_NAME]_DATABASE="database_name"
export RED_[YOUR_PROJECT_NAME]_USERNAME="database_username"
export RED_[YOUR_PROJECT_NAME]_PASSWORD="database_password"
export RED_[YOUR_PROJECT_NAME]_HOST="database_host"
export RED_[YOUR_PROJECT_NAME]_PORT="database_port"

For Azure:

export AZURE_[YOUR_PROJECT_NAME]_DATABASE="database_name"
export AZURE_[YOUR_PROJECT_NAME]_USERNAME="database_username"
export AZURE_[YOUR_PROJECT_NAME]_PASSWORD="database_password"
export AZURE_[YOUR_PROJECT_NAME]_HOST="database_host"
export AZURE_[YOUR_PROJECT_NAME]_PORT="database_port"

Then you can init a dbstream object in your python code.

For Redshift:

# For Redshift
from pyred import RedDBStream as DBStream
# For Azure
from pyzure import AzureDBStream as DBStream


NAME = "[YOUR_PROJECT_NAME]"
CLIENT_ID = 1

datamart = DBStream(
    NAME,
    client_id=CLIENT_ID
)

Facebook Connector

export [CHOOSE A FACEBOOK APP_ID NAME REFERENCE] = “YOUR_FACEBOOK_APP_ID”
export [CHOOSE A FACEBOOK APP_SECRET NAME REFERENCE] = “YOUR_FACEBOOK_APP_SECRET”
export [CHOOSE A FACEBOOK ACCESSTOKEN NAME REFERENCE] = “YOUR_FACEBOOK_ACCESSTOKEN”

from pyfbook.FacebookReport import Facebook

Facebook()

facebook = Facebook(config_path="[PATH_TO_YOUR_CONFIG_FILE]", dbstream=[YOUR DBSTREAM OBJECT])
facebook.create_app_system_user(
    app_id_name="APP_ID NAME REFERENCE",
    app_secret_name="APP_SECRET NAME REFERENCE",
    access_token_name="ACCESSTOKEN NAME REFERENCE"
 )

Get All Ads Accounts

facebook.get_all_ad_accounts()

It will create a table with the list of ad accounts you have access to.

You can update the “active” field in this table to choose which account you want to recover the data.

Get Facebook Marketing Data - General Process

Pyfbook uses asynchronous reports to get data.

facebook.get(
    report_name=None,
    time_increment=None,
    start=None, end=None,
    list_account_ids=None
)

When you execute this python code, it will launch and fetch asynchronous reports.

Config Field

Your config field should look like the following:

schema_name: pyfbook_raw_data
reports:
  - name: account
    level: account
    fields:
      - impressions
      - spend
      - clicks
      - purchase
      - unique_clicks
      - reach
      - date_start
      - date_stop
      - account_id
    time_increments:
      - day
      - lifetime
    breakdowns:
      - country

You can list as many report as you want.

Results will be saved in [schema_name].[report_name]_[time_increment].

Config Date

You can specify start and end dates in your python ‘get’ function : ‘YYYY-MM-DD’.

This process is done at account level.