Transfer · To Tasks · to_facebook_custom_audience

Purpose

Upload data to Facebook custom audiences.

Limitation

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

Configuration

Example usage

load:
    ad_account_id: 12345678901234
    schema: EMAIL_SHA256
    mapping: 
        email: email_sha256
        audience_id: audience_id
        action: action
    pre_hashed: yes
    is_raw: yes

Properties

propertytypemandatorydescription
conn_idstringnoConnection string as handed to you by the Onesecondbefore team. Default is `facebook`.
ad_account_idintegeryesThe ID of the Ad Account
schemasingle or multiple values of enumerator()yesSpecify what type of information you will be providing. It can be a single key or multi key from the following list:
  • EMAIL
  • PHONE
  • GEN
  • DOBY
  • DOBM
  • DOBD
  • LN
  • FN
  • FI
  • CT
  • ST
  • ZIP
  • COUNTRY
  • MADID
  • ["hash1", "hash2", ...]. For example: ["PHONE", "LN”, “FN”, “ZIP”, “DOBYM"]
is_rawbooleannoDefault is yes. If data is send unhashed.
pre_hashedbooleannoDefault is no. If data is send unhashed.
mappingobjectyesContains the mappings from the dataset to the service. See below for mapping options.

Mappings

mappingtype (in dataset)mandatorydescription
actionenumerator (add, delete)yesAction to take on the custom audience. Value of the field can only be add (User will be added to the custom audience) or delete (User will be delete from the audience).
audience_idintegeryesID of the custom audience the user should be added to or deleted from. You can upload to multple audiences in the same upload.
emailstringyesContains the email address of the user.

Details

itemdescription
APIFacebook Marketing API for custom audiences
To typeData upload to Facebook.