|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)
|string||yes||ID of the custom audience. Must be present when action is |
delete. If not present with
active, the custom audience will be created.
|string||yes||Name of the custom audience.|
|string||yes||Description of the custom audience|
|string||no||Required with customer file source audiences. Type of Custom Audience. Must be |
CUSTOM for a customer file source audience. Leave out otherwise.
|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))
|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.|
|integer||no||Required with website custom audiences. Number of days to retain someone in audience. Between 1 and 180 days.|
|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.