Manage items in Facebook for advertisers Facebook.
Only supports database as a source in the extract part of the configuration.
load:
conn_id: facebook
ad_account_id: 12345678901234
type: custom_audiences
mapping:
action: ACTION
id: AUDIENCE_ID
name: AUDIENCE_NAME
description: DESCRIPTION
retention_days: RETENTION_DAYS
subtype: SUBTYPE
rule: RULE
prefill: PREFILL
| property | type | mandatory | description |
|---|---|---|---|
conn_id | string | no | Connection string as handed to you by the Onesecondbefore team. Default is `facebook`. |
type | enumerator(custom_audiences, ads_pixels) | yes | Contains the type of upload. |
ad_account_id | integer | yes | The ID of the Ad Account |
mapping | object | yes | Contains the mappings from the dataset to the service. See below for mapping options. |
Contains customer file source audiences and website custom audiences.
| mapping | type (in dataset) | mandatory | description |
|---|---|---|---|
action | enumerator (active, update, delete) | yes | Action to take on the custom audience. Value of the field can only be active (Item will be created when it does not exist and no action is taken when the item already exists) or update (item will be updated) or delete (item will be deleted) |
id | string | yes | ID of the custom audience. Must be present when action is update or delete. If not present with active, the custom audience will be created. |
name | string | yes | Name of the custom audience. |
description | string | yes | Description of the custom audience |
subtype | string | no | Required with customer file source audiences. Type of Custom Audience. Must be CUSTOM for a customer file source audience. Leave out otherwise. |
customer_file_source | enumerator (USER_PROVIDED_ONLY, PARTNER_PROVIDED_ONLY, BOTH_USER_AND_PARTNER_PROVIDED) | no | Required with customer file source audiences. Must be one of USER_PROVIDED_ONLY (Advertisers collected information directly from customers), PARTNER_PROVIDED_ONLY (Advertisers sourced information directly from partners (e.g., agencies or data providers)) or BOTH_USER_AND_PARTNER_PROVIDED (Advertisers collected information directly from customers and it was also sourced from partners (e.g., agencies)) |
rule | string | no | Required with website custom audiences. Contains the rule of the audience. Tip: First create an audience with the rule you need, download the definition with from_facebook task and copy the value in this field. |
retention_days | integer | no | Required with website custom audiences. Number of days to retain someone in audience. Between 1 and 180 days. |
prefill | integer | no | Optional. Default is true. Available options are: true: Include website activity recorded before audience creation. false: Only include website traffic from the time of audience creation. |
Contains configuration of Ads Pixels.
| mapping | type (in dataset) | mandatory | description |
|---|---|---|---|
action | enumerator (active, update, delete) | yes | Action to take on the custom audience. Value of the field can only be active (Item will be created when it does not exist and no action is taken when the item already exists) or update (item will be updated) or delete (item will be deleted) |
ads_pixel_id | integer | yes | ID of the pixel |
automatic_matching_fields | string | yes | Advanced matching fields which are enabled for automatic advanced matching |
| item | description |
|---|---|
API | Facebook Marketing API |
To type | Management information upload. |