Workflows · From Tasks · from_facebook

Purpose

Imports data from Facebook Ads.

Method of use

Before you can download data from Facebook you have to give Workflows access with a system account. Make sure the system account has access to all items you will use of Facebook.

Configuration

Example usage

extract:
    conn_id: facebook
    type: custom_audiences
    ad_account_id: 123456789012345

    filtering:
        - field: name
        operator: CONTAIN
        value: ' - '

Properties

property	type	required	description
`type`	enumerator (account, campaigns, custom_audiences, insights)	yes	Contains the report you want to download.
`ad_account_id`	integer	yes	Contains the id of the ad account.
`conn_id`	string	no	Connection string as handed to you by the Onesecondbefore team. Default is `facebook`
`fields`	enumerator (of field names)	no	A default list of fields will be selected. Add the fields here if you only want a subset. Make sure you get the correct fields per report.
`filtering`	array of objects	yes	Contains array of filters. Each filter should be configured as described in the properties of filtering object
`limit`	integer	no	Contains the limit of records you want to import.
`level`	enumerator (campaign)	no	Only use when type=insights. Contains the insights aggregation level. Full list can be found here, search for `level`.
`breakdowns`	enumerator(full list here)	no	Only use when type=insights. Contains the limit of breakdowns.

Properties of filtering object

If you use filtering (see above) in the extract. You have to add an object every time with the fields below.

property	type	required	description
`field`	enumerator (see field list)	yes	Contains the name of the field you want to filter on.
`operator`	enumerator (EQUAL, NOT_EQUAL, GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL, IN_RANGE, NOT_IN_RANGE, CONTAIN, NOT_CONTAIN, IN, NOT_IN, STARTS_WITH, ENDS_WITH, ANY, ALL, AFTER, BEFORE, ON_OR_AFTER, ON_OR_BEFORE, NONE)	yes	contains operator like e.g. EQUAL or NOT_EQUAL
`value`	string	yes	Contains the value to filter one.

Details

item	description
`API`	Facebook Marketing API
`Pre-formatted schema`	Yes. Comes with a pre-formatted and described schema.