Transfer · To Tasks · to_facebook

Purpose

Manage items in Facebook for advertisers Facebook.

Limitation

Only supports database as a source in the extract part of the configuration.

Configuration

Example usage

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

Properties

propertytypemandatorydescription
conn_idstringnoConnection string as handed to you by the Onesecondbefore team. Default is `facebook`.
typeenumerator(custom_audiences, ads_pixels)yesContains the type of upload.
ad_account_idintegeryesThe ID of the Ad Account
mappingobjectyesContains the mappings from the dataset to the service. See below for mapping options.

Mappings

Mappings: custom_audiences

Contains customer file source audiences and website custom audiences.

mappingtype (in dataset)mandatorydescription
actionenumerator (active, update, delete)yesAction 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)
idstringyesID of the custom audience. Must be present when action is update or delete. If not present with active, the custom audience will be created.
namestringyesName of the custom audience.
descriptionstringyesDescription of the custom audience
subtypestringnoRequired with customer file source audiences. Type of Custom Audience. Must be CUSTOM for a customer file source audience. Leave out otherwise.
customer_file_sourceenumerator (USER_PROVIDED_ONLY, PARTNER_PROVIDED_ONLY, BOTH_USER_AND_PARTNER_PROVIDED)noRequired 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))
rulestringnoRequired 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_daysintegernoRequired with website custom audiences. Number of days to retain someone in audience. Between 1 and 180 days.
prefillintegernoOptional. 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.

Mappings: ads_pixels

Contains configuration of Ads Pixels.

mappingtype (in dataset)mandatorydescription
actionenumerator (active, update, delete)yesAction 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_idintegeryesID of the pixel
automatic_matching_fieldsstringyesAdvanced matching fields which are enabled for automatic advanced matching

Details

itemdescription
APIFacebook Marketing API
To typeManagement information upload.