Below are the parts that can be configured, depending on the task.type:
Upload data to Meta custom audiences.
Only supports database as a source in the extract part of the configuration.
load:
ad_account_id: 12345678901234
schema: EMAIL_SHA256
mapping:
email: email_sha256
audience_id: audience_id
action: action
pre_hashed: yes
is_raw: yes
| property | type | mandatory | description |
|---|---|---|---|
conn_id | string | no | Connection string as handed to you by the Onesecondbefore team. Default is `meta`. |
ad_account_id | integer | yes | The ID of the Ad Account |
schema | single or multiple values of enumerator() | yes | Specify what type of information you will be providing. It can be a single key from this list:
or multi key from the following list:
|
is_raw | boolean | no | Default is yes. If data is send unhashed. |
pre_hashed | boolean | no | Default is no. If data is send unhashed. |
mapping | object | yes | Contains the mappings from the dataset to the service. See below for mapping options. |
| mapping | type (in dataset) | mandatory | description |
|---|---|---|---|
action | enumerator (add, delete) | yes | Action 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_id | integer | yes | ID of the custom audience the user should be added to or deleted from. You can upload to multiple audiences in the same upload. |
email | string | yes | Contains the email address of the user. |
Meta custom audiences can be deduplicated. It is possible to add or delete users from an audience.
deduplicate:
type: incremental
| property | type | mandatory | description |
|---|---|---|---|
type | enumerator (incremental, replace) | no | Determines if list of users should be added or deleted from the existing audience, or if the audience should be completely replaced. Default is `incremental`. |
| item | description |
|---|---|
API | Meta Marketing API for custom audiences |
To type | Data upload to Meta. |